From 91ea7aed183be21f4cfdf3fbe087b7167377eab1 Mon Sep 17 00:00:00 2001 From: anders-elastisys Date: Mon, 12 Aug 2024 14:14:16 +0200 Subject: [PATCH] docs: update ck8s diagnostics command usage --- docs/operator-manual/common.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/operator-manual/common.md b/docs/operator-manual/common.md index 6b74c681ed4..622faab442a 100644 --- a/docs/operator-manual/common.md +++ b/docs/operator-manual/common.md @@ -275,9 +275,29 @@ To ensure that you have configured S3 correctly, run the following snippet: If you are struggling, don't hesitate to [file a ticket](https://elastisys.atlassian.net/servicedesk/customer/portals). - You can run the following command from the [compliantkubernetes-apps](https://github.com/elastisys/compliantkubernetes-apps) repository to collect diagnostic information that will help us support you. + You can run the following command from the [compliantkubernetes-apps](https://github.com/elastisys/compliantkubernetes-apps) repository to collect diagnostic information that will help us support you. - `CK8S_PGP_FP= ./bin/ck8s diagnostics [sc|wc]` + `CK8S_PGP_FP= ./bin/ck8s diagnostics ` + +
Show more examples on using the diagnostics command + The command `ck8s diagnostics` can be provided with different flags to gather additional information from your environment, to see all available options run: + + `./bin/ck8s diagnostics --help` + + Some example use cases: + + - To include config files found in `CK8S_CONFIG_PATH`: + + ```bash + CK8S_PGP_FP= ./bin/ck8s diagnostics --include-config + ``` + + - To retrieve more information such as YAML manifests for resources in a specific namespace, in this example `ingress-nginx`: + + ```bash + CK8S_PGP_FP= ./bin/ck8s diagnostics --namespace ingress-nginx + ``` +
Please also provide us with your terminal in a text format. We need to look both at the commands you typed and their output.