From b6958733e19e9d1ec348613f4d86d58e5cac6e88 Mon Sep 17 00:00:00 2001 From: stefanprodan Date: Sun, 1 Mar 2020 22:36:08 +0200 Subject: [PATCH] docs: replace threshold with thresholdRange --- docs/gitbook/dev/upgrade-guide.md | 16 ++++++++++++++++ docs/gitbook/faq.md | 6 ++++-- .../tutorials/appmesh-progressive-delivery.md | 6 ++++-- .../tutorials/contour-progressive-delivery.md | 6 ++++-- .../tutorials/crossover-progressive-delivery.md | 6 ++++-- docs/gitbook/tutorials/flagger-smi-istio.md | 6 ++++-- .../tutorials/gloo-progressive-delivery.md | 6 ++++-- docs/gitbook/tutorials/istio-ab-testing.md | 6 ++++-- .../tutorials/istio-progressive-delivery.md | 12 ++++++++---- docs/gitbook/tutorials/kubernetes-blue-green.md | 6 ++++-- .../tutorials/linkerd-progressive-delivery.md | 12 ++++++++---- .../tutorials/nginx-progressive-delivery.md | 6 ++++-- docs/gitbook/usage/how-it-works.md | 6 ++++-- 13 files changed, 72 insertions(+), 28 deletions(-) diff --git a/docs/gitbook/dev/upgrade-guide.md b/docs/gitbook/dev/upgrade-guide.md index 2b3aa151..c5f2b503 100644 --- a/docs/gitbook/dev/upgrade-guide.md +++ b/docs/gitbook/dev/upgrade-guide.md @@ -23,3 +23,19 @@ Upgrade procedure: **Note** that after upgrading Flagger, all canaries will be triggered as the hash value used for tracking changes is computed differently. You can set `spec.skipAnalysis: true` in all canary manifests before upgrading Flagger, do the upgrade, wait for Flagger to finish the no-op promotions and finally set `skipAnalysis` to `false`. + +Update builtin metrics: +* replace `threshold` with `thresholdRange.min` for request-success-rate +* replace `threshold` with `thresholdRange.max` for request-duration + +```yaml +metrics: +- name: request-success-rate + thresholdRange: + min: 99 + interval: 1m +- name: request-duration + thresholdRange: + max: 500 + interval: 1m +``` diff --git a/docs/gitbook/faq.md b/docs/gitbook/faq.md index 1e75588d..ecc807c4 100644 --- a/docs/gitbook/faq.md +++ b/docs/gitbook/faq.md @@ -237,7 +237,8 @@ Spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m ``` @@ -299,7 +300,8 @@ Spec: - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 1m ``` diff --git a/docs/gitbook/tutorials/appmesh-progressive-delivery.md b/docs/gitbook/tutorials/appmesh-progressive-delivery.md index b1201e6c..4ee1fcb2 100644 --- a/docs/gitbook/tutorials/appmesh-progressive-delivery.md +++ b/docs/gitbook/tutorials/appmesh-progressive-delivery.md @@ -108,12 +108,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing (optional) webhooks: diff --git a/docs/gitbook/tutorials/contour-progressive-delivery.md b/docs/gitbook/tutorials/contour-progressive-delivery.md index 78119bd7..5930c1ca 100644 --- a/docs/gitbook/tutorials/contour-progressive-delivery.md +++ b/docs/gitbook/tutorials/contour-progressive-delivery.md @@ -109,11 +109,13 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 in milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing webhooks: diff --git a/docs/gitbook/tutorials/crossover-progressive-delivery.md b/docs/gitbook/tutorials/crossover-progressive-delivery.md index d2323dd5..8f92bfa0 100644 --- a/docs/gitbook/tutorials/crossover-progressive-delivery.md +++ b/docs/gitbook/tutorials/crossover-progressive-delivery.md @@ -128,12 +128,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing (optional) webhooks: diff --git a/docs/gitbook/tutorials/flagger-smi-istio.md b/docs/gitbook/tutorials/flagger-smi-istio.md index 55580a1c..90291e48 100644 --- a/docs/gitbook/tutorials/flagger-smi-istio.md +++ b/docs/gitbook/tutorials/flagger-smi-istio.md @@ -149,12 +149,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # generate traffic during analysis webhooks: diff --git a/docs/gitbook/tutorials/gloo-progressive-delivery.md b/docs/gitbook/tutorials/gloo-progressive-delivery.md index 9ff5011e..d95e434c 100644 --- a/docs/gitbook/tutorials/gloo-progressive-delivery.md +++ b/docs/gitbook/tutorials/gloo-progressive-delivery.md @@ -121,12 +121,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing (optional) webhooks: diff --git a/docs/gitbook/tutorials/istio-ab-testing.md b/docs/gitbook/tutorials/istio-ab-testing.md index 484f42f0..857cb962 100644 --- a/docs/gitbook/tutorials/istio-ab-testing.md +++ b/docs/gitbook/tutorials/istio-ab-testing.md @@ -82,12 +82,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # generate traffic during analysis webhooks: diff --git a/docs/gitbook/tutorials/istio-progressive-delivery.md b/docs/gitbook/tutorials/istio-progressive-delivery.md index 12dedf43..bb9e318e 100644 --- a/docs/gitbook/tutorials/istio-progressive-delivery.md +++ b/docs/gitbook/tutorials/istio-progressive-delivery.md @@ -85,12 +85,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing (optional) webhooks: @@ -277,10 +279,12 @@ spec: mirror: true metrics: - name: request-success-rate - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration - threshold: 500 + thresholdRange: + max: 500 interval: 1m webhooks: - name: acceptance-test diff --git a/docs/gitbook/tutorials/kubernetes-blue-green.md b/docs/gitbook/tutorials/kubernetes-blue-green.md index 836cbc1e..8598b8ba 100644 --- a/docs/gitbook/tutorials/kubernetes-blue-green.md +++ b/docs/gitbook/tutorials/kubernetes-blue-green.md @@ -110,12 +110,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # acceptance/load testing hooks webhooks: diff --git a/docs/gitbook/tutorials/linkerd-progressive-delivery.md b/docs/gitbook/tutorials/linkerd-progressive-delivery.md index 9721efb4..87c161d1 100644 --- a/docs/gitbook/tutorials/linkerd-progressive-delivery.md +++ b/docs/gitbook/tutorials/linkerd-progressive-delivery.md @@ -84,12 +84,14 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration # maximum req duration P99 # milliseconds - threshold: 500 + thresholdRange: + max: 500 interval: 30s # testing (optional) webhooks: @@ -420,10 +422,12 @@ spec: # Linkerd Prometheus checks metrics: - name: request-success-rate - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration - threshold: 500 + thresholdRange: + max: 500 interval: 30s webhooks: - name: acceptance-test diff --git a/docs/gitbook/tutorials/nginx-progressive-delivery.md b/docs/gitbook/tutorials/nginx-progressive-delivery.md index 4a53c961..f6d9de2f 100644 --- a/docs/gitbook/tutorials/nginx-progressive-delivery.md +++ b/docs/gitbook/tutorials/nginx-progressive-delivery.md @@ -144,7 +144,8 @@ spec: - name: request-success-rate # minimum req success rate (non 5xx responses) # percentage (0-100) - threshold: 99 + thresholdRange: + min: 99 interval: 1m # testing (optional) webhooks: @@ -394,7 +395,8 @@ Edit the canary analysis, remove the max/step weight and add the match condition exact: "canary" metrics: - name: request-success-rate - threshold: 99 + thresholdRange: + min: 99 interval: 1m webhooks: - name: load-test diff --git a/docs/gitbook/usage/how-it-works.md b/docs/gitbook/usage/how-it-works.md index 9f83efd0..4b0cea47 100644 --- a/docs/gitbook/usage/how-it-works.md +++ b/docs/gitbook/usage/how-it-works.md @@ -29,10 +29,12 @@ spec: stepWeight: 5 metrics: - name: request-success-rate - threshold: 99 + thresholdRange: + min: 99 interval: 1m - name: request-duration - threshold: 99 + thresholdRange: + max: 500 interval: 1m webhooks: - name: load-test