Merge pull request #53438 from lmktfy/20251124_k8s_config_good_practice

k8s-ci-robot · web-flow · commit 5b9bb69fcd34 · 2025-11-24T23:54:36.000-08:00
Publish blog article "Kubernetes Configuration Good Practices"
diff --git a/content/en/blog/_posts/2023-03-30-kubescape-validating-admission-policy-library.md b/content/en/blog/_posts/2023-03-30-kubescape-validating-admission-policy-library.md
@@ -115,8 +115,8 @@ would otherwise allow API requests to sneak past the validation rule by using th
 version. {{< /note >}}
 
 The `validations` include the CEL rules for the objects. There are three different expressions,
-catering for the fact that a Pod `spec` can be at the root of the object (a [naked
-pod](/docs/concepts/configuration/overview/#naked-pods-vs-replicasets-deployments-and-jobs)),
+catering for the fact that a Pod `spec` can be at the root of the object (a _naked
+pod_,
 under `template` (a workload controller or a Job), or under `jobTemplate` (a CronJob).
 
 In the event that any `spec` does not have `readOnlyRootFilesystem` set to true, the object will not
diff --git a/content/en/blog/_posts/2025-11-25-kubernetes-configuration-best-practices/index.md b/content/en/blog/_posts/2025-11-25-kubernetes-configuration-best-practices/index.md
@@ -1,11 +1,10 @@
 ---
 layout: blog
 title: "Kubernetes Configuration Good Practices"
-date: 2025-11-11
-slug: kubernetes-configuration-good-practices
+date: 2025-11-25T00:00:00+00:00
+slug: configuration-good-practices
 evergreen: true
 author: Kirti Goyal
-draft: true
 ---
 
 Configuration is one of those things in Kubernetes that seems small until it's not. Configuration is at the heart of every Kubernetes workload.
@@ -14,7 +13,9 @@ A missing quote, a wrong API version or a misplaced YAML indent can ruin your en
 This blog brings together tried-and-tested configuration best practices. The small habits that make your Kubernetes setup clean, consistent and easier to manage. 
 Whether you are just starting out or already deploying apps daily, these are the little things that keep your cluster stable and your future self sane. 
 
-## General Configuration Practices
+_This blog is inspired by the original *Configuration Best Practices* page, which has evolved through contributions from many members of the Kubernetes community._
+
+## General configuration practices
 
 ### Use the latest stable API version 
 Kubernetes evolves fast. Older APIs eventually get deprecated and stop working. So, whenever you are defining resources, make sure you are using the latest stable API version. 
diff --git a/content/en/docs/concepts/configuration/overview.md b/content/en/docs/concepts/configuration/overview.md
diff --git a/content/en/docs/concepts/overview/working-with-objects/_index.md b/content/en/docs/concepts/overview/working-with-objects/_index.md
@@ -124,10 +124,8 @@ satisfy the StatefulSet specification.
 Different kinds of objects can also have different `.status`; again, the API reference pages
 detail the structure of that `.status` field, and its content for each different type of object.
 
-{{< note >}}
-See [Configuration Best Practices](/docs/concepts/configuration/overview/) for additional
+See [Kubernetes Configuration Best Practices](/blog/2025/11/25/configuration-good-practices/) for additional
 information on writing YAML configuration files.
-{{< /note >}}
 
 ## Server side field validation
 
diff --git a/content/en/docs/reference/kubectl/_index.md b/content/en/docs/reference/kubectl/_index.md
@@ -69,7 +69,7 @@ where `command`, `TYPE`, `NAME`, and `flags` are:
 
   * To specify resources with one or more files:  `-f file1 -f file2 -f file<#>`
 
-    * [Use YAML rather than JSON](/docs/concepts/configuration/overview/#general-configuration-tips)
+    * Use YAML rather than JSON
       since YAML tends to be more user-friendly, especially for configuration files.<br/>
       Example: `kubectl get -f ./pod.yaml`
 
diff --git a/content/en/docs/reference/kubectl/conventions.md b/content/en/docs/reference/kubectl/conventions.md
@@ -39,7 +39,7 @@ reconciled by a controller to a different value.
 
 For `kubectl run` to satisfy infrastructure as code:
 
-* Tag the image with a version-specific tag and don't move that tag to a new version. For example, use `:v1234`, `v1.2.3`, `r03062016-1-4`, rather than `:latest` (For more information, see [Best Practices for Configuration](/docs/concepts/configuration/overview/#container-images)).
+* Tag the image with a version-specific tag and don't move that tag to a new version. For example, use `:v1234`, `v1.2.3`, `r03062016-1-4`, rather than `:latest` (For more information, see [Kubernetes Configuration Good Practices](/blog/2025/11/25/configuration-good-practices/)).
 * Check in the script for an image that is heavily parameterized.
 * Switch to configuration files checked into source control for features that are needed, but not expressible via `kubectl run` flags.
 
diff --git a/static/_redirects.base b/static/_redirects.base
@@ -477,6 +477,8 @@
 /docs/tasks/administer-cluster/namespaces-walkthrough/   /docs/tutorials/cluster-management/namespaces-walkthrough/ 301
 /uk/docs/tasks/administer-cluster/namespaces-walkthrough/   /uk/docs/tutorials/cluster-management/namespaces-walkthrough/ 301
 
+/docs/concepts/configuration/overview/ /blog/2025/11/25/configuration-good-practices/ 301
+
 /blog/2025/09/23/introducing-headlamp-plugin-for-karpenter/ /blog/2025/10/06/introducing-headlamp-plugin-for-karpenter/ 301
 
 /kubertenes     /blog/2024/06/06/10-years-of-kubernetes/ 302
