diff --git a/README.md b/README.md index 5751d5c8..85b4d275 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,9 @@ spec: # Istio virtual service host names (optional) hosts: - podinfo.example.com + # for emergency cases when you want to ship changes + # in production without analysing the canary + skipAnalysis: false canaryAnalysis: # schedule interval (default 60s) interval: 1m diff --git a/artifacts/canaries/canary.yaml b/artifacts/canaries/canary.yaml index 70c86c07..cb1cdfbf 100644 --- a/artifacts/canaries/canary.yaml +++ b/artifacts/canaries/canary.yaml @@ -26,6 +26,9 @@ spec: # Istio virtual service host names (optional) hosts: - app.istio.weavedx.com + # for emergency cases when you want to ship changes + # in production without analysing the canary + skipAnalysis: false canaryAnalysis: # schedule interval (default 60s) interval: 10s diff --git a/docs/gitbook/how-it-works.md b/docs/gitbook/how-it-works.md index 97faec2b..edf35f08 100644 --- a/docs/gitbook/how-it-works.md +++ b/docs/gitbook/how-it-works.md @@ -39,6 +39,9 @@ spec: # Istio virtual service host names (optional) hosts: - podinfo.example.com + # for emergency cases when you want to ship changes + # in production without analysing the canary + skipAnalysis: false canaryAnalysis: # schedule interval (default 60s) interval: 1m @@ -167,6 +170,11 @@ And the time it takes for a canary to be rollback when the metrics or webhook ch interval * threshold ``` +In emergency cases, you may want to skip the analysis phase and ship changes directly to production. +At any time you can set the `spec.skipAnalysis: true`. +When skip analysis is enabled, Flagger checks if the canary deployment is healthy and +promotes it without analysing it. If an analysis is underway, Flagger cancels it and runs the promotion. + ### HTTP Metrics The canary analysis is using the following Prometheus queries: