Add canary step docs

Author: Samze

docs/v3/source/includes/api_resources/_deployments.erb

@@ -8,11 +8,27 @@
     "details": {
       "last_successful_healthcheck": "2018-04-25T22:42:10Z",
       "last_status_change": "2018-04-25T22:42:10Z"
+    },
+    "canary": {
+      "steps": {
+        "current": 1,
+        "total": 2
+      }
     }
   },
   "strategy": "canary",
   "options" : {
     "max_in_flight": 3,
+    "canary": {
+      "steps": [
+        {
+          "instance_weight": 10
+        },
+        {
+          "instance_weight": 20
+        }
+      ]
+    }
   },
   "droplet": {
     "guid": "44ccfa61-dbcf-4a0d-82fe-f668e9d2a962"

docs/v3/source/includes/resources/deployments/_create.md.erb

@@ -78,6 +78,7 @@ Name | Type | Description | Default
 **revision**<sup>[1]</sup> | _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
+**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | Canary steps to use for the deployment An array of canary steps to use for the deployment
 **metadata.labels** | [_label object_](#labels) | Labels applied to the deployment
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the deployment
 

docs/v3/source/includes/resources/deployments/_object.md.erb

@@ -15,9 +15,12 @@ Name | Type | Description
 **status.value** | _string_ | The current status of the deployment; valid values are `ACTIVE` (meaning in progress) and `FINALIZED` (meaning finished, either successfully or not)
 **status.reason** | _string_ | The reason for the status of the deployment;<br>following list represents valid values:<br>1. If **status.value** is `ACTIVE`<br>- `DEPLOYING`<br>- `PAUSED` (only valid for canary deployments) <br>- `CANCELING`<br>2. If **status.value** is `FINALIZED`<br>- `DEPLOYED`<br>- `CANCELED`<br>- `SUPERSEDED` (another deployment created for app before completion)<br>
 **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
+**status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason**status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason
+**status.canary.steps.current** | _integer_ | The current canary step. Only available deployments with strategy 'canary'. (experimental)
+**status.canary.steps.total** | _integer_ |  The total number of canary steps. Only available deployments with strategy 'canary'. (experimental)
 **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
+**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | Canary steps to use for the deployment. Only available deployments with strategy 'canary'. (experimental)
 **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
@@ -26,3 +29,8 @@ Name | Type | Description
 **metadata.labels** | [_label object_](#labels) | Labels applied to the deployment
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the deployment
 **links** | [_links object_](#links) | Links to related resources
+
+
+#### Canary steps object
+
+**instance_weight** | _integer_ | The percentage of instances to be deployed as part of the canary process in this step (experimental)