From 83f240eb8732b496c6cd7b4944134d2c6fe1e702 Mon Sep 17 00:00:00 2001 From: parth-gr Date: Wed, 16 Aug 2023 13:48:46 +0530 Subject: [PATCH 1/2] helm: improvement in docs values.overide isn't used for cephcluster we use values.yaml so updated the doc with the change Signed-off-by: parth-gr (cherry picked from commit 41aa70aedf0842438b65e6d58ec537bb0a5fdb95) --- .../Helm-Charts/ceph-cluster-chart.gotmpl.md | 13 ++++++++----- Documentation/Helm-Charts/ceph-cluster-chart.md | 13 ++++++++----- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md b/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md index 422f4f22b..70515c1a1 100644 --- a/Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md +++ b/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 diff --git a/Documentation/Helm-Charts/ceph-cluster-chart.md b/Documentation/Helm-Charts/ceph-cluster-chart.md index 383cc3cff..dc4c6b3b1 100644 --- a/Documentation/Helm-Charts/ceph-cluster-chart.md +++ b/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 From 626070be6295d61c399f1300bd316edc300aab1a Mon Sep 17 00:00:00 2001 From: parth-gr Date: Mon, 21 Aug 2023 19:55:20 +0530 Subject: [PATCH 2/2] helm: update the default version tag to master updating this to ease the local testing using helm for master branch repo Signed-off-by: parth-gr (cherry picked from commit 67f294b6234b21b230aa5f5a427f10ccc128e6a5) --- build/makelib/helm.mk | 2 +- deploy/charts/rook-ceph/values.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build/makelib/helm.mk b/build/makelib/helm.mk index 74fab6d74..2bb970c8e 100644 --- a/build/makelib/helm.mk +++ b/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 diff --git a/deploy/charts/rook-ceph/values.yaml b/deploy/charts/rook-ceph/values.yaml index 35ce4c967..854b8a58b 100644 --- a/deploy/charts/rook-ceph/values.yaml +++ b/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