From e73dcd94c6cdadd87c3ee0d4ee7d782a01f1e194 Mon Sep 17 00:00:00 2001 From: Alay Patel Date: Tue, 22 Oct 2024 10:38:20 -0400 Subject: [PATCH] add documentation for KEP 4017 PodIndexLabel going GA Signed-off-by: Alay Patel --- .../en/docs/concepts/workloads/controllers/statefulset.md | 6 +++--- .../feature-gates/pod-index-label.md | 4 ++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/content/en/docs/concepts/workloads/controllers/statefulset.md b/content/en/docs/concepts/workloads/controllers/statefulset.md index 177dd3b371..2c6e678a3f 100644 --- a/content/en/docs/concepts/workloads/controllers/statefulset.md +++ b/content/en/docs/concepts/workloads/controllers/statefulset.md @@ -252,13 +252,13 @@ the StatefulSet. ### Pod index label -{{< feature-state for_k8s_version="v1.28" state="beta" >}} +{{< feature-state feature_gate_name="PodIndexLabel" >}} When the StatefulSet {{}} creates a Pod, the new Pod is labelled with `apps.kubernetes.io/pod-index`. The value of this label is the ordinal index of the Pod. This label allows you to route traffic to a particular pod index, filter logs/metrics -using the pod index label, and more. Note the feature gate `PodIndexLabel` must be enabled for this -feature, and it is enabled by default. +using the pod index label, and more. Note the feature gate `PodIndexLabel` is enabled and locked by default for this +feature, in order to disable it, users will have to use server emulated version v1.31. ## Deployment and Scaling Guarantees diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates/pod-index-label.md b/content/en/docs/reference/command-line-tools-reference/feature-gates/pod-index-label.md index be509292c6..40118ee749 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates/pod-index-label.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates/pod-index-label.md @@ -9,5 +9,9 @@ stages: - stage: beta defaultValue: true fromVersion: "1.28" + toVersion: "1.31" + - stage: stable + defaultValue: true + fromVersion: "1.32" --- Enables the Job controller and StatefulSet controller to add the pod index as a label when creating new pods. See [Job completion mode docs](/docs/concepts/workloads/controllers/job#completion-mode) and [StatefulSet pod index label docs](/docs/concepts/workloads/controllers/statefulset/#pod-index-label) for more details.