From d9bdc192a7e6e1afdfe7d4802bacffd08e442189 Mon Sep 17 00:00:00 2001 From: Rey Lejano Date: Wed, 31 Mar 2021 05:26:19 -0700 Subject: [PATCH] follow-up PR to update deprecation policy for k8s metrics originally in PR 27202 --- content/en/docs/reference/using-api/deprecation-policy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/reference/using-api/deprecation-policy.md b/content/en/docs/reference/using-api/deprecation-policy.md index ef040b1b8c..eed4341628 100644 --- a/content/en/docs/reference/using-api/deprecation-policy.md +++ b/content/en/docs/reference/using-api/deprecation-policy.md @@ -457,12 +457,12 @@ string '(Deprecated from x.y)' and a warning log will be emitted during metric registration. Like their stable undeprecated counterparts, deprecated metrics will be automatically registered to the metrics endpoint and therefore visible. -On a subsequent release (when the metric's deprecatedVersion is equal to +On a subsequent release (when the metric's `deprecatedVersion` is equal to _current_kubernetes_version - 3_)), a deprecated metric will become a _hidden_ metric. **_Unlike_** their deprecated counterparts, hidden metrics will _no longer_ be automatically registered to the metrics endpoint (hence hidden). However, they can be explicitly enabled through a command line flag on the binary -(i.e. `--show-hidden-metrics-for-version=`). This provides cluster admins an +(`--show-hidden-metrics-for-version=`). This provides cluster admins an escape hatch to properly migrate off of a deprecated metric, if they were not able to react to the earlier deprecation warnings. Hidden metrics should be deleted after one release.