diff --git a/docs/cli.html b/docs/cli.html index 5fab24377..0bb19d582 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -234,6 +234,9 @@
+Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.
+
Usage: zapier canary:create VERSIONFROM VERSIONTO
Only one canary can be active at the same time. You can run zapier canary:list
to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using zapier canary:delete a.b.c x.y.z
.
Note: this is similar to zapier migrate
but different in that this is temporary and will "revert" the changes once the specified duration is expired.
Only use this command to canary traffic between non-breaking versions!
Arguments
versionFrom
| Version to route traffic fromversionTo
| Version to canary traffic toFlags
-p, --percent
| Percent of traffic to route to new version-d, --duration
| Duration of the canary in seconds-d, --debug
| Show extra debugging output.Examples
zapier canary:create 1.0.0 1.1.0 -p 25 -d 720
zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300
+Delete an active canary deployment
+
Usage: zapier canary:delete VERSIONFROM VERSIONTO
Arguments
versionFrom
| Version to route traffic fromversionTo
| Version canary traffic is routed toExamples
zapier canary:delete 1.0.0 1.1.0
+List all active canary deployments
+
Usage: zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.Examples
zapier canary:list
+Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.
+
Usage: zapier canary:create VERSIONFROM VERSIONTO
Only one canary can be active at the same time. You can run zapier canary:list
to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using zapier canary:delete a.b.c x.y.z
.
Note: this is similar to zapier migrate
but different in that this is temporary and will "revert" the changes once the specified duration is expired.
Only use this command to canary traffic between non-breaking versions!
Arguments
versionFrom
| Version to route traffic fromversionTo
| Version to canary traffic toFlags
-p, --percent
| Percent of traffic to route to new version-d, --duration
| Duration of the canary in seconds-d, --debug
| Show extra debugging output.Examples
zapier canary:create 1.0.0 1.1.0 -p 25 -d 720
zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300
+Delete an active canary deployment
+
Usage: zapier canary:delete VERSIONFROM VERSIONTO
Arguments
versionFrom
| Version to route traffic fromversionTo
| Version canary traffic is routed toExamples
zapier canary:delete 1.0.0 1.1.0
+List all active canary deployments
+
Usage: zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.Examples
zapier canary:list