Wrap the cert-manager re-configuration instructions for easier reading #1216
Conversation
jetstack-bot
added
dco-signoff: yes
✅ Deploy Preview for cert-manager-website ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
wallrj
force-pushed
the
clearer-cert-manager-reconfiguration-instructions
branch
from
4ee90ad
to
4695a37
Compare
And explain that extraArgs and version must be specified to avoid changing the version while reconfiguring cert-manager. Signed-off-by: Richard Wall <richard.wall@jetstack.io>
wallrj
force-pushed
the
clearer-cert-manager-reconfiguration-instructions
branch
from
4695a37
to
08e028d
Compare
There was a problem hiding this comment.
Thanks Richard, I have read through the changes and I think this is an improvement although I regret that we spend so much time on Helm specific stuff. I guess at some point it'd be good to have a user survey to understand what are the most common installation mechanisms and what the trend is to see whether this is reasonable.
/lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: irbekrm, wallrj The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Preview: https://deploy-preview-1216--cert-manager-website.netlify.app/docs/projects/approver-policy/
In the existing documentation , the
helm upgradecommand also installs and the command is one long line which is difficult to read.The documentation assumes that if the user has already installed cert-manager, that they used the
--set installCRDs=trueflag,which is not the recommended helm install method so I added a note about that.
I considered recommending
helm upgrade --reuse-valuesto retain what ever values the user originally supplied when they installed cert-manager, but that's not safe either, becauseextraArgsmay or may not have already been customized.Instead I recommended that the user check existing values before reconfiguring.