diff --git a/docs/v3/source/includes/api_resources/_deployments.erb b/docs/v3/source/includes/api_resources/_deployments.erb index d185b35fc23..4794489ee9a 100644 --- a/docs/v3/source/includes/api_resources/_deployments.erb +++ b/docs/v3/source/includes/api_resources/_deployments.erb @@ -10,6 +10,9 @@ } }, "strategy": "canary", + "options" : { + "max_in_flight": 3, + }, "droplet": { "guid": "44ccfa61-dbcf-4a0d-82fe-f668e9d2a962" }, @@ -80,6 +83,9 @@ "reason": "DEPLOYED" }, "strategy": "rolling", + "options" : { + "max_in_flight": 1, + }, "droplet": { "guid": "44ccfa61-dbcf-4a0d-82fe-f668e9d2a962" }, diff --git a/docs/v3/source/includes/resources/deployments/_create.md.erb b/docs/v3/source/includes/resources/deployments/_create.md.erb index ae705dc5a72..6e55ad39e8e 100644 --- a/docs/v3/source/includes/resources/deployments/_create.md.erb +++ b/docs/v3/source/includes/resources/deployments/_create.md.erb @@ -77,6 +77,7 @@ Name | Type | Description | Default **droplet**[1] | _object_ | The droplet to deploy for the app; this will update the app's [current droplet](#get-current-droplet-association-for-an-app) to this droplet | The app's [current droplet](#get-current-droplet-association-for-an-app) **revision**[1] | _object_ | The [revision](#revisions) whose droplet to deploy for the app; this will update the app's [current droplet](#get-current-droplet-association-for-an-app) to this droplet | **strategy** | _string_ | The strategy to use for the deployment | `rolling` +**options.max_in_flight** | _integer_ | The maximum number of new instances to deploy simultaneously | 1 **metadata.labels** | [_label object_](#labels) | Labels applied to the deployment **metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the deployment diff --git a/docs/v3/source/includes/resources/deployments/_header.md b/docs/v3/source/includes/resources/deployments/_header.md index 149709e9a76..c46ba25c46a 100644 --- a/docs/v3/source/includes/resources/deployments/_header.md +++ b/docs/v3/source/includes/resources/deployments/_header.md @@ -13,6 +13,7 @@ Deployments are different than the traditional method of pushing app updates whi Deployment strategies supported: * [Rolling deployments](https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html) allows for -applications to be deployed without incurring downtime by gradually rolling out instances. +applications to be deployed without incurring downtime by gradually rolling out instances. Max-in-flight can be configured +to specify how many instances are rolled out simultaneously. * Canary deployments deploy a single instance and pause for user evaluation. If the canary instance is deemed successful, the deployment can be resumed via the [continue action](#continue-a-deployment). The deployment then continues like a rolling deployment. This feature is experimental and is subject to change. diff --git a/docs/v3/source/includes/resources/deployments/_object.md.erb b/docs/v3/source/includes/resources/deployments/_object.md.erb index 111f1a12422..70960a9a6aa 100644 --- a/docs/v3/source/includes/resources/deployments/_object.md.erb +++ b/docs/v3/source/includes/resources/deployments/_object.md.erb @@ -17,6 +17,7 @@ Name | Type | Description **status.details.last_successful_healthcheck** | _[timestamp](#timestamps)_ | Timestamp of the last successful healthcheck **status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason **strategy** | _string_ | Strategy used for the deployment; supported strategies are `rolling` and `canary` (experimental) +**options.max_in_flight** | _integer_ | The maximum number of new instances to deploy simultaneously **droplet.guid** | _string_ | The droplet guid that the deployment is transitioning the app to **previous_droplet.guid** | _string_ | The app's [current droplet guid](#get-current-droplet-association-for-an-app) before the deployment was created **new_processes** | _array_ | List of processes created as part of the deployment