From c8696261c96a4559f3f7930bd89f7afc6bed9f6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alberto=20C=2E=20R=C3=ADos?= Date: Tue, 3 Oct 2023 14:20:25 +0200 Subject: [PATCH] Improving CF deployer documentation (#868) * Improving CF deployer documentation Adding stack as a supported property --- .../src/docs/asciidoc/service-instances.adoc | 74 +++++++++++++++++-- 1 file changed, 66 insertions(+), 8 deletions(-) diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc index 18fb950..0bbd6e6 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc @@ -35,6 +35,72 @@ spring: ---- ==== +The following table lists properties that can be set for all or for deployments: + +[%header,cols="2,2,1"] +|=== +|Property +|Description +|Default + +|`api-polling-timeout` +|The timeout for polled async CF API calls, in seconds. +|300 + +|`buildpack` +|The buildpack to use for deploying the application. +| + +|`buildpacks` +|The list of buildpacks to use for deploying the application. +| + +|`domain` +|The domain to use when mapping routes for applications. +| + +|`domains` +|The list of domain to use when mapping routes for applications. +| + +|`health-check` +|The type of health check to perform on deployed application, if not overridden per-app. +|PORT + +|`health-check-http-endpoint` +|The path that the http health check will use. +|/health + +|`health-check-timeout` +|The timeout value for health checks in seconds. +|120 + +|`javaOpts` +|The javaOpts to use for deploying the application. +| + +|`memory` +|The memory to use for deploying the application. +| + +|`no-route` +|If the application does not need a route +|false + +|`route-path` +|The route-path to use for deploying the application. +| + +|`routes` +|The routes to use for deploying the application. +| + +|`stack` +|The stack to use for deploying the application. +| + +|=== + You can set overriding values for a specific service in the service's configuration under `spring.cloud.appbroker.services.*`, as follows: ==== @@ -84,14 +150,6 @@ The following table lists properties that can be set for all or for specific app | | -|`buildpack` -|The single buildpack to use for deploying the application. -| - -|`buildpacks` -|Comma separated list of buildpacks to use for deploying the application. -| - |`domain` |The domain to use when mapping routes for the deployed application. `domain` and `host` are mutually exclusive with `routes`. |