From f63ca48a1f5de2dd9505b3fbb9404b9a97cb2128 Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Fri, 6 Nov 2020 08:43:00 -0800 Subject: [PATCH] Clean up comments around old topology labels --- pkg/util/node/node.go | 5 ++-- .../k8s.io/api/core/v1/well_known_labels.go | 23 +++++++++++-------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/pkg/util/node/node.go b/pkg/util/node/node.go index e075ef4a590..15cabbb4fb0 100644 --- a/pkg/util/node/node.go +++ b/pkg/util/node/node.go @@ -187,13 +187,14 @@ func GetZoneKey(node *v1.Node) string { return "" } - // TODO: prefer stable labels for zone in v1.18 + // TODO: "failure-domain.beta..." names are deprecated, but will + // stick around a long time due to existing on old extant objects like PVs. + // Maybe one day we can stop considering them (see #88493). zone, ok := labels[v1.LabelFailureDomainBetaZone] if !ok { zone, _ = labels[v1.LabelTopologyZone] } - // TODO: prefer stable labels for region in v1.18 region, ok := labels[v1.LabelFailureDomainBetaRegion] if !ok { region, _ = labels[v1.LabelTopologyRegion] diff --git a/staging/src/k8s.io/api/core/v1/well_known_labels.go b/staging/src/k8s.io/api/core/v1/well_known_labels.go index a506f17f65b..1b6529bc249 100644 --- a/staging/src/k8s.io/api/core/v1/well_known_labels.go +++ b/staging/src/k8s.io/api/core/v1/well_known_labels.go @@ -19,16 +19,21 @@ package v1 const ( LabelHostname = "kubernetes.io/hostname" - LabelFailureDomainBetaZone = "failure-domain.beta.kubernetes.io/zone" - LabelFailureDomainBetaRegion = "failure-domain.beta.kubernetes.io/region" - LabelTopologyZone = "topology.kubernetes.io/zone" - LabelTopologyRegion = "topology.kubernetes.io/region" + LabelTopologyZone = "topology.kubernetes.io/zone" + LabelTopologyRegion = "topology.kubernetes.io/region" - // Legacy names for compat. - LabelZoneFailureDomain = LabelFailureDomainBetaZone // deprecated, remove after 1.20 - LabelZoneRegion = LabelFailureDomainBetaRegion // deprecated, remove after 1.20 - LabelZoneFailureDomainStable = LabelTopologyZone - LabelZoneRegionStable = LabelTopologyRegion + // These label have been deprecated since 1.17, but will be supported for + // the foreseeable future, to accommodate things like long-lived PVs that + // use them. New users should prefer the "topology.kubernetes.io/*" + // equivalents. + LabelFailureDomainBetaZone = "failure-domain.beta.kubernetes.io/zone" // deprecated + LabelFailureDomainBetaRegion = "failure-domain.beta.kubernetes.io/region" // deprecated + + // Retained for compat when vendored. Do not use these consts in new code. + LabelZoneFailureDomain = LabelFailureDomainBetaZone // deprecated + LabelZoneRegion = LabelFailureDomainBetaRegion // deprecated + LabelZoneFailureDomainStable = LabelTopologyZone // deprecated + LabelZoneRegionStable = LabelTopologyRegion // deprecated LabelInstanceType = "beta.kubernetes.io/instance-type" LabelInstanceTypeStable = "node.kubernetes.io/instance-type"