Add how-to troubleshoot for charm deployments #953
Conversation
berkayoz
force-pushed
the
KU-2407/charm-troubleshooting
branch
from
f185610 to
398c4b4
Compare
There was a problem hiding this comment.
Thanks for your great work Berkay!
Please consider the comments I made on https://github.com/canonical/k8s-snap/pull/943/files and also apply them to this PR.
berkayoz
force-pushed
the
KU-2407/charm-troubleshooting
branch
from
398c4b4 to
4c89656
Compare
|
thanks for adding the I'm adding more details to it in #949 |
| ## Using the built-in inspection script | ||
|
|
||
| {{product}} ships with a script to compile a complete report on {{product}} and its underlying system. This is an essential tool for bug reports and for investigating whether a system is (or isn’t) working. | ||
|
|
||
| Inspection script can be executed on a specific unit by running the following commands: | ||
|
|
||
| ``` | ||
| juju exec --unit <k8s/unit#> -- sudo /snap/k8s/current/k8s/scripts/inspect.sh /home/ubuntu/inspection-report.tar.gz | ||
| juju scp <k8s/unit#>:/home/ubuntu/inspection-report.tar.gz ./ | ||
| ``` |
| @@ -29,6 +29,7 @@ custom-registry | |||
| Upgrade patch version <upgrade-patch> | |||
| Upgrade minor version <upgrade-minor> | |||
| Validate the cluster <validate> | |||
| troubleshooting | |||
There was a problem hiding this comment.
nit: let's align this with the pattern Title <link> above for consistency.
There was a problem hiding this comment.
How to troubleshoot {{product}} does not seem to work in that pattern. Should we drop the {{product}} part and change the title into just Troubleshooting ?
There was a problem hiding this comment.
+1 on Troubleshooting for the navbar. Leaving the header as is in the page itself is fine.
berkayoz
force-pushed
the
KU-2407/charm-troubleshooting
branch
from
4c89656 to
fc587d3
Compare
There was a problem hiding this comment.
I've added some comments regarding how to get the kube-config out of the charm. I suggesting using /leader instead of /0 since its far more likely to be accurate with any deployed model.
Also, I provided some notes about parsing the output of the action. You should run the output of the actions through yq in order to extract the kubeconfig file from the response
berkayoz
force-pushed
the
KU-2407/charm-troubleshooting
branch
from
1127646 to
65d1942
Compare
|
Great work. Just a small change to how it shows in the navbar and then we are good to merge |
Adds a How-To page on troubleshooting a Canonical Kubernetes charm deployment