Updating deployment guide#126
Conversation
|
Thanks so much @chethanuk - I'll review this by tomorrow, just need to finish up a few other things today! |
|
Looks like CI won't run because we only mirror the fintechstudios repo to GitLab, not yours. I'm not sure how to solve this without either moving entirely to GitLab or to another CI provider, but since these are just doc changes I don't think it's a big issue to add them without CI runs. Update: #127 |
austince
left a comment
austince
left a comment
There was a problem hiding this comment.
Thanks so much for this! Just have some small notes.
| Please have a look at the [`docs`](docs/README.md) for information on getting started using | ||
| the operator. | ||
|
|
||
| To deploying and using the operator look at [`deploying`](docs/guides/deployment.md) |
There was a problem hiding this comment.
What do you think about this slight tweak?
| To deploying and using the operator look at [`deploying`](docs/guides/deployment.md) | |
| For deploying and using the operator, look at [`deploying`](docs/guides/deployment.md) |
| # In this case, add the `top-speed` namespace associated with the sample manifests in `/config/samples`. | ||
|
|
||
| # Create the `top-speed` namespace if it doesn't exist | ||
| kubectl create namespace top-speed || true |
There was a problem hiding this comment.
Do you think we could keep this in? Installing the VVP with the additional namespace support was failing for me yesterday if the namespace didn't already exist.
| @@ -0,0 +1,55 @@ | |||
| # Install cert-manager | |||
|
|
|||
| Install the CustomResourceDefinition resources separately. | |||
There was a problem hiding this comment.
This is great! Could we also just add a link to their official install guide in case this becomes outdated?
| # Using the Cert created by the operator chart for serving webhooks. | ||
| # Pointed at the webhook conversion service of the operator. | ||
| ### For helm 3: | ||
| # Try dryrun to check the rendered templates |
There was a problem hiding this comment.
Thanks for adding the Helm 3 docs! Do you think we could remove the dry run bits though? I think it would be best if people could just run each of these commands and have it deploy without modification.
| NOTE: If you don't have cert-manager you may get following error: | ||
|
|
||
| ```bash | ||
| Error: Internal error occurred: failed calling webhook "webhook.cert-manager.io": Post https://cert-manager-webhook.cert-manager.svc:443/mutate?timeout=30s: no endpoints available for service "cert-manager-webhook" | ||
| ``` | ||
|
|
||
| To deploy cert-manager[`check out this guide`](./cert-manager.md) |
There was a problem hiding this comment.
What do you think about moving this to the top of the guide where Cert-Manager is mentioned?
| ## Or, for the Community Edition | ||
| For helm 2: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
I think these extra ```bash sections are throwing off something with rendering. Could we remove them and just keep the whole thing in the ```shell block?
2 participants
No description provided.