docs: Add metric.query deprecation notice

This commit is contained in:
stefanprodan
2020-03-10 09:22:25 +02:00
parent c5dffbaa3f
commit 523903e0af
2 changed files with 3 additions and 2 deletions
+1
View File
@@ -11,6 +11,7 @@ Canary CRD changes in `canaries.flagger.app/v1beta1`:
* the `spec.analysis.alerts` array can reference `alertproviders.flagger.app/v1beta1` resources
* the `spec.analysis.metrics[].templateRef` can reference a `metrictemplate.flagger.app/v1beta1` resource
* the `metric.threshold` field has been deprecated and replaced with `metric.thresholdRange`
* the `metric.query` field has been deprecated and replaced with `metric.templateRef`
* the `spec.targetRef` can reference `DaemonSet` kind
Upgrade procedure:
+2 -2
View File
@@ -214,14 +214,14 @@ type CanaryMetric struct {
// Interval represents the windows size
Interval string `json:"interval,omitempty"`
// Max value accepted for this metric
// Deprecated: Max value accepted for this metric (replaced by ThresholdRange)
Threshold float64 `json:"threshold"`
// Range value accepted for this metric
// +optional
ThresholdRange *CanaryThresholdRange `json:"thresholdRange,omitempty"`
// Prometheus query for this metric (deprecated in favor of TemplateRef)
// Deprecated: Prometheus query for this metric (replaced by TemplateRef)
// +optional
Query string `json:"query,omitempty"`