From 34ed69041601781014e86cce46a84928bd39562e Mon Sep 17 00:00:00 2001 From: Tanner Altares Date: Tue, 18 Feb 2020 15:00:03 -0600 Subject: [PATCH] update the docs --- docs/gitbook/how-it-works.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/gitbook/how-it-works.md b/docs/gitbook/how-it-works.md index 9cdd28f4..5e1e0ecd 100644 --- a/docs/gitbook/how-it-works.md +++ b/docs/gitbook/how-it-works.md @@ -589,7 +589,7 @@ Spec: some: "message" - name: "rollback gate" type: rollback - url: http://flagger-loadtester.test/gate/halt + url: http://flagger-loadtester.test/rollback/check - name: "send to Slack" type: event url: http://event-recevier.notifications/slack @@ -908,14 +908,29 @@ While the promotion is paused, Flagger will continue to run the metrics checks a url: http://flagger-loadtester.test/gate/halt ``` -The `rollback` hook type can be used to manually rollback the canary promotion. +The `rollback` hook type can be used to manually rollback the canary promotion. As with gating, rollbacks can be driven +with Flagger's tester API by setting the rollback URL to `/rollback/check` ```yaml canaryAnalysis: webhooks: - name: "rollback" type: rollback - url: http://flagger-loadtester.test/gate/halt + url: http://flagger-loadtester.test/rollback/check ``` +By default rollback is closed, you can rollback a canary rollout with: + +```bash +kubectl -n test exec -it flagger-loadtester-xxxx-xxxx sh + +curl -d '{"name": "podinfo","namespace":"test"}' http://localhost:8080/rollback/open +``` + +You can close the rollback with: + +```bash +curl -d '{"name": "podinfo","namespace":"test"}' http://localhost:8080/rollback/close +`` + If you have notifications enabled, Flagger will post a message to Slack or MS Teams if a canary promotion is waiting for approval.