Skip to content

Commit 34ed690

Browse files
Tanner AltaresTanner Altares
Tanner Altares
authored and
Tanner Altares
committed
update the docs
1 parent 0598e4b commit 34ed690

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/gitbook/how-it-works.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,7 @@ Spec:
589589
some: "message"
590590
- name: "rollback gate"
591591
type: rollback
592-
url: http://flagger-loadtester.test/gate/halt
592+
url: http://flagger-loadtester.test/rollback/check
593593
- name: "send to Slack"
594594
type: event
595595
url: http://event-recevier.notifications/slack
@@ -908,14 +908,29 @@ While the promotion is paused, Flagger will continue to run the metrics checks a
908908
url: http://flagger-loadtester.test/gate/halt
909909
```
910910

911-
The `rollback` hook type can be used to manually rollback the canary promotion.
911+
The `rollback` hook type can be used to manually rollback the canary promotion. As with gating, rollbacks can be driven
912+
with Flagger's tester API by setting the rollback URL to `/rollback/check`
912913

913914
```yaml
914915
canaryAnalysis:
915916
webhooks:
916917
- name: "rollback"
917918
type: rollback
918-
url: http://flagger-loadtester.test/gate/halt
919+
url: http://flagger-loadtester.test/rollback/check
919920
```
920921

922+
By default rollback is closed, you can rollback a canary rollout with:
923+
924+
```bash
925+
kubectl -n test exec -it flagger-loadtester-xxxx-xxxx sh
926+
927+
curl -d '{"name": "podinfo","namespace":"test"}' http://localhost:8080/rollback/open
928+
```
929+
930+
You can close the rollback with:
931+
932+
```bash
933+
curl -d '{"name": "podinfo","namespace":"test"}' http://localhost:8080/rollback/close
934+
``
935+
921936
If you have notifications enabled, Flagger will post a message to Slack or MS Teams if a canary promotion is waiting for approval.

0 commit comments

Comments
 (0)