Document charm commands #938
Conversation
There was a problem hiding this comment.
Great work @eaudetcobello, thanks a lot! Left some minor comments.
| ```{include} ../../_parts/commands/charm/pre-upgrade-check.md | ||
| ``` | ||
|
|
||
| ```{include} ../../_parts/commands/charm/pre-upgrade-check.md |
There was a problem hiding this comment.
I think one of these should be get-kubeconfig.md
|
|
||
| ### Options | ||
|
|
||
| None. |
There was a problem hiding this comment.
I think we have a server param, at least according to the code: https://github.com/canonical/k8s-operator/blob/main/charms/worker/k8s/src/charm.py#L1053-L1068
|
|
||
| ### Synopsis | ||
|
|
||
| Retrieve public Kubernetes cluster config, including credentials |
There was a problem hiding this comment.
Maybe we can also mention that it's only executable on on control plane nodes.
There was a problem hiding this comment.
Also Retrieve **the** public Kubernetes, including **its** credentials and some punctuation add the end please.
| @@ -0,0 +1,9 @@ | |||
| # Command reference | |||
There was a problem hiding this comment.
| # Command reference | |
| # Charm command reference |
|
|
||
| ### Synopsis | ||
|
|
||
| Run necessary pre-upgrade checks before executing a charm upgrade. |
There was a problem hiding this comment.
Please add some additional information on what this check does and why we run it before the upgrade.
| ### Options | ||
|
|
||
| None. |
There was a problem hiding this comment.
Can we remove this section?
| ``` | ||
| Retrieve the cluster config: |
There was a problem hiding this comment.
Switch lines 7 and 8 please and undo the indent on line 10.
|
|
||
| ### Synopsis | ||
|
|
||
| Retrieve public Kubernetes cluster config, including credentials |
There was a problem hiding this comment.
Also Retrieve **the** public Kubernetes, including **its** credentials and some punctuation add the end please.
Document charm commands
This PR documents the k8s charm commands.