Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving CF deployer documentation #868

Merged
merged 5 commits into from
Oct 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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:

====
Expand Down Expand Up @@ -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`.
|
Expand Down