helm: improvement in docs #12734
helm: improvement in docs #12734
Conversation
parth-gr
force-pushed
the
helm-improvements
branch
2 times, most recently
from
808f376
to
c076dfd
Compare
| @@ -36,6 +36,9 @@ helm repo add rook-release https://charts.rook.io/release | |||
| helm install --create-namespace --namespace rook-ceph rook-ceph rook-release/rook-ceph -f values.yaml | |||
| ``` | |||
|
|
|||
| !!! Note | |||
| --namespace specify the operator namespace. | |||
There was a problem hiding this comment.
Do you think this note is necessary? I don't see what other namespace it would be confused with, or that needs clarifying. The --namespace flag is a common helm flag, so it seems ok not to explain more.
There was a problem hiding this comment.
Yes right the --namespace is provided by helm,
But first time I really get confused as we generally use namespace as cephcluster namespace,
I am fine keeping it or not keeping it, as per your suggestion.
There was a problem hiding this comment.
I vote to remove this note in the operator helm chart doc. We can keep the clarification in the other doc since the cluster helm chart has both the cluster namespace and operator namespace.
| @@ -7,7 +7,7 @@ image: | |||
| repository: rook/ceph | |||
| # -- Image tag | |||
| # @default -- `master` | |||
| tag: VERSION | |||
There was a problem hiding this comment.
The helm build replaces this version when it publishes the helm chart, so I don't think we can change this.
There was a problem hiding this comment.
I just make the build change,
Lemme know if it's feels good, otherwise, I can revert the changes
There was a problem hiding this comment.
I believe this will work fine since the makefile is updated.
- You're making this change so it's easier to test the local helm chart with the master tag, right?
- Please create a new commit for this tag change. It's not just a doc improvement like the rest.
There was a problem hiding this comment.
Yes exactly,
Added it as separate commit
Thanks
parth-gr
force-pushed
the
helm-improvements
branch
from
c076dfd
to
b995f9d
Compare
| @@ -36,6 +36,9 @@ helm repo add rook-release https://charts.rook.io/release | |||
| helm install --create-namespace --namespace rook-ceph rook-ceph rook-release/rook-ceph -f values.yaml | |||
| ``` | |||
|
|
|||
| !!! Note | |||
| --namespace specify the operator namespace. | |||
There was a problem hiding this comment.
I vote to remove this note in the operator helm chart doc. We can keep the clarification in the other doc since the cluster helm chart has both the cluster namespace and operator namespace.
| @@ -7,7 +7,7 @@ image: | |||
| repository: rook/ceph | |||
| # -- Image tag | |||
| # @default -- `master` | |||
| tag: VERSION | |||
There was a problem hiding this comment.
I believe this will work fine since the makefile is updated.
- You're making this change so it's easier to test the local helm chart with the master tag, right?
- Please create a new commit for this tag change. It's not just a doc improvement like the rest.
values.overide isn't used for cephcluster we use values.yaml so updated the doc with the change Signed-off-by: parth-gr <paarora@redhat.com>
parth-gr
force-pushed
the
helm-improvements
branch
from
b995f9d
to
bb082a5
Compare
updating this to ease the local testing using helm for master branch repo Signed-off-by: parth-gr <paarora@redhat.com>
parth-gr
force-pushed
the
helm-improvements
branch
from
bb082a5
to
67f294b
Compare
helm: improvement in docs (backport #12734)
Description of your changes:
values.overide isn't used for cephcluster
we use values.yaml so updated the doc with the
change
Which issue is resolved by this Pull Request:
Resolves #
Checklist:
skip-cion the PR.