Merge pull request #12762 from rook/mergify/bp/release-1.12/pr-12734

helm: improvement in docs (backport #12734)

Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md

@@ -41,14 +41,17 @@ Rook currently publishes builds of this chart to the `release` and `master` chan
 The release channel is the most recent release of Rook that is considered stable for the community.
 
 The example install assumes you have first installed the [Rook Operator Helm Chart](operator-chart.md)
-and created your customized values-override.yaml.
+and created your customized values.yaml.
 
 ```console
 helm repo add rook-release https://charts.rook.io/release
 helm install --create-namespace --namespace rook-ceph rook-ceph-cluster \
-   --set operatorNamespace=rook-ceph rook-release/rook-ceph-cluster -f values-override.yaml
+   --set operatorNamespace=rook-ceph rook-release/rook-ceph-cluster -f values.yaml
 ```
 
+!!! Note
+    --namespace specifies the cephcluster namespace, which may be different from the rook operator namespace.
+
 ## Configuration
 
 The following table lists the configurable parameters of the rook-operator chart and their default values.
@@ -123,7 +126,7 @@ If you have an existing CephCluster CR that was created without the helm chart a
 chart to start managing the cluster:
 
 1. Extract the `spec` section of your existing CephCluster CR and copy to the `cephClusterSpec`
-   section in `values-override.yaml`.
+   section in `values.yaml`.
 
 2. Add the following annotations and label to your existing CephCluster CR:
 
@@ -137,7 +140,7 @@ chart to start managing the cluster:
 
 1. Run the `helm install` command in the [Installing section](#release) to create the chart.
 
-2. In the future when updates to the cluster are needed, ensure the values-override.yaml always
+2. In the future when updates to the cluster are needed, ensure the values.yaml always
    contains the desired CephCluster spec.
 
 ### **Development Build**
@@ -146,7 +149,7 @@ To deploy from a local build from your development environment:
 
 ```console
 cd deploy/charts/rook-ceph-cluster
-helm install --create-namespace --namespace rook-ceph rook-ceph-cluster -f values-override.yaml .
+helm install --create-namespace --namespace rook-ceph rook-ceph-cluster -f values.yaml .
 ```
 
 ## Uninstalling the Chart

Documentation/Helm-Charts/ceph-cluster-chart.md

@@ -44,14 +44,17 @@ Rook currently publishes builds of this chart to the `release` and `master` chan
 The release channel is the most recent release of Rook that is considered stable for the community.
 
 The example install assumes you have first installed the [Rook Operator Helm Chart](operator-chart.md)
-and created your customized values-override.yaml.
+and created your customized values.yaml.
 
 ```console
 helm repo add rook-release https://charts.rook.io/release
 helm install --create-namespace --namespace rook-ceph rook-ceph-cluster \
-   --set operatorNamespace=rook-ceph rook-release/rook-ceph-cluster -f values-override.yaml
+   --set operatorNamespace=rook-ceph rook-release/rook-ceph-cluster -f values.yaml
 ```
 
+!!! Note
+    --namespace specifies the cephcluster namespace, which may be different from the rook operator namespace.
+
 ## Configuration
 
 The following table lists the configurable parameters of the rook-operator chart and their default values.
@@ -150,7 +153,7 @@ If you have an existing CephCluster CR that was created without the helm chart a
 chart to start managing the cluster:
 
 1. Extract the `spec` section of your existing CephCluster CR and copy to the `cephClusterSpec`
-   section in `values-override.yaml`.
+   section in `values.yaml`.
 
 2. Add the following annotations and label to your existing CephCluster CR:
 
@@ -164,7 +167,7 @@ chart to start managing the cluster:
 
 1. Run the `helm install` command in the [Installing section](#release) to create the chart.
 
-2. In the future when updates to the cluster are needed, ensure the values-override.yaml always
+2. In the future when updates to the cluster are needed, ensure the values.yaml always
    contains the desired CephCluster spec.
 
 ### **Development Build**
@@ -173,7 +176,7 @@ To deploy from a local build from your development environment:
 
 ```console
 cd deploy/charts/rook-ceph-cluster
-helm install --create-namespace --namespace rook-ceph rook-ceph-cluster -f values-override.yaml .
+helm install --create-namespace --namespace rook-ceph rook-ceph-cluster -f values.yaml .
 ```
 
 ## Uninstalling the Chart

build/makelib/helm.mk

@@ -40,7 +40,7 @@ $(HELM_OUTPUT_DIR)/$(1)-$(VERSION).tgz: $(HELM) $(HELM_OUTPUT_DIR) $(shell find
 	@echo === helm package $(1)
 	@rm -rf $(OUTPUT_DIR)/$(1)
 	@cp -aL $(HELM_CHARTS_DIR)/$(1) $(OUTPUT_DIR)
-	@$(SED_IN_PLACE) 's|VERSION|$(VERSION)|g' $(OUTPUT_DIR)/$(1)/values.yaml
+	@$(SED_IN_PLACE) 's|master|$(VERSION)|g' $(OUTPUT_DIR)/$(1)/values.yaml
 	@$(HELM) lint $(abspath $(OUTPUT_DIR)/$(1)) --set image.tag=$(VERSION)
 	@$(HELM) package --version $(VERSION) --app-version $(VERSION) -d $(HELM_OUTPUT_DIR) $(abspath $(OUTPUT_DIR)/$(1))
 $(HELM_INDEX): $(HELM_OUTPUT_DIR)/$(1)-$(VERSION).tgz

deploy/charts/rook-ceph/values.yaml

@@ -7,7 +7,7 @@ image:
   repository: rook/ceph
   # -- Image tag
   # @default -- `master`
-  tag: VERSION
+  tag: master
   # -- Image pull policy
   pullPolicy: IfNotPresent