From 175d4dc82984d7d0ce16f8c9afe7a5c45b660340 Mon Sep 17 00:00:00 2001 From: anders-elastisys Date: Wed, 28 Aug 2024 08:56:48 +0200 Subject: [PATCH] docs: update diagnostics script usage --- docs/operator-manual/common.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/operator-manual/common.md b/docs/operator-manual/common.md index d09202e8cfd..573175fcda6 100644 --- a/docs/operator-manual/common.md +++ b/docs/operator-manual/common.md @@ -276,26 +276,38 @@ 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. + Ensure that you have put fingerprints received from Elastisys in a file named `${CK8S_CONFIG_PATH}/diagnostics_receiver.gpg`. - `CK8S_PGP_FP= ./bin/ck8s diagnostics ` + ```bash + ./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` + ```bash + ./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 + ./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 + ./bin/ck8s diagnostics namespace ingress-nginx + ``` + + - It is also possible to set which GPG keys should be used by setting `CK8S_PGP_FP`: + + ```bash + export CK8S_PGP_FP=, + ./bin/ck8s diagnostics namespace ingress-nginx ```