Cloud Foundry Application Manifest
A manifest describes a Cloud Foundry application and can be used to deploy it to a Foundation
| Type | Manifest |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/cloud-foundry-application-manifest/latest.json |
| Source | https://www.schemastore.org/cloudfoundry-application-manifest.json |
Validate with Lintel
npx @lintel/lintel checkDefinitions
A manifest describes a Cloud Foundry application and can be used to deploy it to a Foundation. For authoritative reference, see https://docs.cloudfoundry.org/devguide/deploy-apps/manifest-attributes.html.
The version of the manifest schema. Currently, the only valid version is 1.
Name of the app.
buildpacks may contain:
a) An empty array, which will automatically select the appropriate default buildpack according to the coding language; b) An array of one or more URLs pointing to buildpacks; c) An array of one or more installed buildpack names.
The command used to start the process; this overrides start commands from Procfiles and buildpacks.
The disk limit for all instances of the web process. This attribute requires a unit of measurement: B, K, KB, M, MB, G, GB, T, or TB in upper case or lower case.
If your app is contained in a Docker image, the docker attribute specifies it and an Docker user name (optional). This attribute is a combination of push options that include --docker-image and --docker-username.
2 nested properties
A key-value mapping of environment variables to be used for the app when running.
Type of liveliness health check to perform; 'none' is deprecated and an alias to process. Default is 'port'.
Liveness health checks are performed to validate that app instances are running. When liveness health checks fail, the app instance is marked as crashed and is restarted.
Endpoint called to determine if the app is healthy when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual health check requests for http and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual health check requests for HTTP and port health checks. Default is 30 (seconds).
Type of readiness health check to perform. Default is 'process'.
Readiness health checks are performed to validate that app instances are ready to serve requests. When readiness health checks fail, the app instance is marked as not ready and removed from the route pool for the app.
Endpoint called to determine if the app is ready to serve requests when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual readiness health check requests for HTTP and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual readiness health check requests for HTTP and port health checks. Default is 30 (seconds).
The number of instances to run. Default is 1.
The log-rate-limit-per-second attribute specifies the log rate limit for all instances of an app. This attribute requires a unit of measurement: B, K, KB, M, MB, G, or GB, in either uppercase or lowercase. Default is 16K.
The memory attribute specifies the memory limit for all instances of an app. This attribute requires a unit of measurement: M, MB, G, or GB, in either uppercase or lowercase. Default is 1G.
The metadata attribute tags your apps with additional information. You can specify two types of metadata: labels and annotations.
When set to true, any routes specified with the routes attribute will be ignored and any existing routes will be removed. Default is false.
The path attribute tells Cloud Foundry the directory location in which it can find your app. The directory specified as the path, either as an attribute or as a parameter on the command line, becomes the location where the buildpack Detect script runs.
List of configurations for individual process types.
Creates a random route for the app if true. If routes is specified, if the app already has routes, or if no-route is specified, this field is ignored regardless of its value. Default is false.
List declaring HTTP and TCP routes to be mapped to the app.
Apps can bind to services such as databases, messaging, and key-value stores. The services block consists of a heading and one or more service instance names.
The sidecars attribute specifies additional processes to run in the same container as your app.
The root filesystem to use with the buildpack, for example cflinuxfs4.
The duration in seconds that health checks can fail before the process is restarted. Default is 60 (seconds).
If your app is contained in a Docker image, the docker attribute specifies it and an Docker user name (optional). This attribute is a combination of push options that include --docker-image and --docker-username.
A key-value mapping of environment variables to be used for the app when running.
Type of liveliness health check to perform; 'none' is deprecated and an alias to process. Default is 'port'.
Liveness health checks are performed to validate that app instances are running. When liveness health checks fail, the app instance is marked as crashed and is restarted.
Endpoint called to determine if the app is healthy when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual health check requests for http and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual health check requests for HTTP and port health checks. Default is 30 (seconds).
Type of readiness health check to perform. Default is 'process'.
Readiness health checks are performed to validate that app instances are ready to serve requests. When readiness health checks fail, the app instance is marked as not ready and removed from the route pool for the app.
Endpoint called to determine if the app is ready to serve requests when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual readiness health check requests for HTTP and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual readiness health check requests for HTTP and port health checks. Default is 30 (seconds).
This configuration is for the individual process. Each process is created if it does not already exist. For backwards compatibility, the web process configuration may be placed at the top level of the application configuration, rather than listed under processes. However, if there is a process with type: web listed under processes, this configuration will override any at the top level.
The identifier for the processes to be configured.
The command used to start the process; this overrides start commands from Procfiles and buildpacks.
The disk limit for all instances of the web process. This attribute requires a unit of measurement: B, K, KB, M, MB, G, GB, T, or TB in upper case or lower case.
Type of liveliness health check to perform; 'none' is deprecated and an alias to process. Default is 'port'.
Liveness health checks are performed to validate that app instances are running. When liveness health checks fail, the app instance is marked as crashed and is restarted.
Endpoint called to determine if the app is healthy when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual health check requests for http and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual health check requests for HTTP and port health checks. Default is 30 (seconds).
Type of readiness health check to perform. Default is 'process'.
Readiness health checks are performed to validate that app instances are ready to serve requests. When readiness health checks fail, the app instance is marked as not ready and removed from the route pool for the app.
Endpoint called to determine if the app is ready to serve requests when readiness-health-check-type='http'. Default is '/'.
The timeout in seconds for individual readiness health check requests for HTTP and port health checks. Default is 1 (second).
The amount of time in seconds between starting individual readiness health check requests for HTTP and port health checks. Default is 30 (seconds).
The number of instances to run. Default is 1.
The memory limit for all instances of the web process. This attribute requires a unit of measurement: B, K, KB, M, MB, G, GB, T, or TB in upper case or lower case.
The log rate limit for all the instances of the process. This attribute requires a unit of measurement: B, K, KB, M, MB, G, GB, T, or TB in upper case or lower case, or -1 or 0.
Time in seconds at which the health-check will report failure. Default is 60 (seconds).
The route URI. Example: host.domain.com.
Protocol to use for this route.
The name of the service instance to be bound to.
A map of arbitrary key/value pairs to send to the service broker during binding.
The name of the service binding to be created
A map of arbitrary key/value pairs to send to the service broker during binding.
The identifier for the sidecars to be configured
List of processes to associate sidecar with
The command used to start the sidecar
Memory that the sidecar will be allocated