docs: rename canaryAnalysis to analysis

This commit is contained in:
stefanprodan
2020-02-28 18:20:57 +02:00
parent 98ecae93e1
commit a9fba0a1f2
18 changed files with 48 additions and 48 deletions
+1 -1
View File
@@ -85,7 +85,7 @@ the address in the secret will take precedence over the **address** field in the
The canary analysis can have a list of alerts, each alert referencing an alert provider:
```yaml
canaryAnalysis:
analysis:
alerts:
- name: "on-call Slack"
severity: error
+7 -7
View File
@@ -32,7 +32,7 @@ The canary analysis runs periodically until it reaches the maximum traffic weigh
Spec:
```yaml
canaryAnalysis:
analysis:
# schedule interval (default 60s)
interval: 1m
# max number of failed metric checks before rollback
@@ -122,7 +122,7 @@ If Flagger finds a HTTP match condition, it will ignore the `maxWeight` and `ste
Istio example:
```yaml
canaryAnalysis:
analysis:
# schedule interval (default 60s)
interval: 1m
# total number of iterations
@@ -155,7 +155,7 @@ interval * threshold
App Mesh example:
```yaml
canaryAnalysis:
analysis:
interval: 1m
threshold: 10
iterations: 2
@@ -170,7 +170,7 @@ Note that App Mesh supports a single condition.
Contour example:
```yaml
canaryAnalysis:
analysis:
interval: 1m
threshold: 10
iterations: 2
@@ -185,7 +185,7 @@ Note that Contour does not support regex, you can use prefix, suffix or exact.
NGINX example:
```yaml
canaryAnalysis:
analysis:
interval: 1m
threshold: 10
iterations: 2
@@ -217,7 +217,7 @@ with Kubernetes L4 networking. When using Istio you have the option to mirror tr
You can use the blue/green deployment strategy by replacing `stepWeight/maxWeight` with `iterations` in the `canaryAnalysis` spec:
```yaml
canaryAnalysis:
analysis:
# schedule interval (default 60s)
interval: 1m
# total number of iterations
@@ -268,7 +268,7 @@ To use mirroring, set `spec.canaryAnalysis.mirror` to `true`.
Istio example:
```yaml
canaryAnalysis:
analysis:
# schedule interval (default 60s)
interval: 1m
# total number of iterations
+4 -4
View File
@@ -10,7 +10,7 @@ the release will be automatically rolled back with minimum impact to end-users.
Flagger comes with two builtin metric checks: HTTP request success rate and duration.
```yaml
canaryAnalysis:
analysis:
metrics:
- name: request-success-rate
interval: 1m
@@ -63,7 +63,7 @@ The following variables are available in query templates:
A canary analysis metric can reference a template with `templateRef`:
```yaml
canaryAnalysis:
analysis:
metrics:
- name: "my metric"
templateRef:
@@ -122,7 +122,7 @@ spec:
Reference the template in the canary analysis:
```yaml
canaryAnalysis:
analysis:
metrics:
- name: "404s percentage"
templateRef:
@@ -223,7 +223,7 @@ spec:
Reference the template in the canary analysis:
```yaml
canaryAnalysis:
analysis:
metrics:
- name: "404s percentage"
templateRef:
+1 -1
View File
@@ -84,7 +84,7 @@ Example:
The event webhook can be overwritten at canary level with:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "send to Slack"
type: event
+9 -9
View File
@@ -25,7 +25,7 @@ every action that Flagger takes during a canary deployment will be sent as JSON
Spec:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "start gate"
type: confirm-rollout
@@ -251,7 +251,7 @@ When deployed the Helm tester API will be available at `http://flagger-helmteste
Now you can add pre-rollout webhooks to the canary analysis spec:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "smoke test"
type: pre-rollout
@@ -268,7 +268,7 @@ If the helm test fails, Flagger will retry until the analysis threshold is reach
If you are using Helm v3, you'll have to create a dedicated service account and add the release namespace to the test command:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "smoke test"
type: pre-rollout
@@ -282,7 +282,7 @@ If you are using Helm v3, you'll have to create a dedicated service account and
As an alternative to Helm you can use the [Bash Automated Testing System](https://github.com/bats-core/bats-core) to run your tests.
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "acceptance tests"
type: pre-rollout
@@ -308,7 +308,7 @@ will shift all traffic back to the primary instance and fail the canary.
Manual gating with Flagger's tester:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "gate"
type: confirm-rollout
@@ -322,7 +322,7 @@ If you have notifications enabled, Flagger will post a message to Slack or MS Te
Change the URL to `/gate/approve` to start the canary analysis:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "gate"
type: confirm-rollout
@@ -332,7 +332,7 @@ Change the URL to `/gate/approve` to start the canary analysis:
Manual gating can be driven with Flagger's tester API. Set the confirmation URL to `/gate/check`:
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "ask for confirmation"
type: confirm-rollout
@@ -366,7 +366,7 @@ The `confirm-promotion` hook type can be used to manually approve the canary pro
While the promotion is paused, Flagger will continue to run the metrics checks and load tests.
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "promotion gate"
type: confirm-promotion
@@ -377,7 +377,7 @@ The `rollback` hook type can be used to manually rollback the canary promotion.
with Flagger's tester API by setting the rollback URL to `/rollback/check`
```yaml
canaryAnalysis:
analysis:
webhooks:
- name: "rollback"
type: rollback