From 1eb1685db20584d3bf7320e76244fc3e44a9b40d Mon Sep 17 00:00:00 2001 From: raaizik <132667934+raaizik@users.noreply.github.com> Date: Thu, 9 Oct 2025 14:39:18 +0300 Subject: [PATCH] docs: discourage freezing default values in user values.yaml (fix #16523) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Users sometimes copy‑paste the entire default `values.yaml` into their own configs, which “freezes” all defaults and prevents them from inheriting new defaults in future chart versions. This change enhances the Helm chart documentation to emphasize that: - Only *overridden* fields should be declared by users. - Avoid duplicating all default values. - Leaving fields unset allows users to benefit from upstream default updates. These adjustments help maintain upgrade compatibility, reduce config bloat, and make it easier to adopt new defaults. Closes: #16523 Signed-off-by: raaizik <132667934+raaizik@users.noreply.github.com> Co-Authored-By: Travis Nielsen (cherry picked from commit f6c734a576c6d39ec3a4ef63b8056aeb3b1b7020) --- Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md | 3 +++ Documentation/Helm-Charts/ceph-cluster-chart.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md b/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md index 406c47d3b..e3494d66b 100644 --- a/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md +++ b/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md @@ -40,6 +40,9 @@ The `release` channel is the most recent release of Rook that is considered stab The example install assumes you have first installed the [Rook Operator Helm Chart](operator-chart.md) and created your customized values.yaml. +!!! tip + Instead of copying the entire default `values.yaml`, create a new `values.yaml` file that only includes the settings you want to override. + ```console helm repo add rook-release https://charts.rook.io/release helm install --create-namespace --namespace rook-ceph rook-ceph-cluster \ diff --git a/Documentation/Helm-Charts/ceph-cluster-chart.md b/Documentation/Helm-Charts/ceph-cluster-chart.md index 939c6d0e8..6eb5f9470 100644 --- a/Documentation/Helm-Charts/ceph-cluster-chart.md +++ b/Documentation/Helm-Charts/ceph-cluster-chart.md @@ -43,6 +43,9 @@ The `release` channel is the most recent release of Rook that is considered stab The example install assumes you have first installed the [Rook Operator Helm Chart](operator-chart.md) and created your customized values.yaml. +!!! tip + Instead of copying the entire default `values.yaml`, create a new `values.yaml` file that only includes the settings you want to override. + ```console helm repo add rook-release https://charts.rook.io/release helm install --create-namespace --namespace rook-ceph rook-ceph-cluster \