Skip to content

Commit d18076b

Browse files
authored
Adding Nessie to troubleshooting docs (#879)
1 parent 4ca2161 commit d18076b

File tree

2 files changed

+33
-8
lines changed

2 files changed

+33
-8
lines changed

asciidoc/troubleshooting/collecting-diagnostics-for-support.adoc

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,52 @@ When contacting SUSE Support, providing comprehensive diagnostic information is
4242
* *For SL Micro*: Check the https://documentation.suse.com/sle-micro/5.5/html/SLE-Micro-all/cha-adm-support-slemicro.html[SUSE Linux Micro Troubleshooting Guide] documentation on how to gather system information for support with `supportconfig`.
4343
* *For RKE2/Rancher*: Check the https://www.suse.com/support/kb/doc/?id=000020191[The Rancher v2.x Linux log collector script] article to run The Rancher v2.x Linux log collector script.
4444
45-
////
46-
47-
* *Nessie*: Nessie is a powerful diagnostic tool designed to collect logs and configuration data from SUSE Edge environments. It gathers comprehensive information from both the host system and Kubernetes clusters, making it invaluable for troubleshooting and support. To collect logs from a SUSE Edge cluster, connect to any of the control plane nodes and run:
45+
* *For Edge (Nessie)*: Nessie is a powerful diagnostic tool designed to collect logs and configuration data from SUSE Edge environments. It gathers comprehensive information from both the host system and Kubernetes clusters, making it invaluable for troubleshooting and support.
46+
** Nessie has two "modes" a kubernetes mode and a system mode.
47+
*** To collect logs from a SUSE Edge cluster, run (provided that you have access to the kubeconfig file locally):
4848
+
4949
[,shell]
5050
----
51-
podman run --privileged \
51+
podman run --rm --privileged \
5252
-v /etc/rancher/k3s/k3s.yaml:/etc/rancher/k3s/k3s.yaml:ro \
5353
-v /var/log/journal:/var/log/journal:ro \
5454
-v /run/systemd:/run/systemd:ro \
5555
-v /etc/machine-id:/etc/machine-id:ro \
56-
-v /tmp/nessie-logs:/tmp/cluster-logs \
57-
ghcr.io/gagrio/nessie
56+
-v /tmp:/tmp \
57+
-e NESSIE_LOG_DIR="/tmp" \
58+
-e NESSIE_ZIP_DIR="/tmp" \
59+
registry.suse.com/edge/3.4/nessie:1.0.0
5860
----
5961
+
6062
[NOTE]
6163
====
6264
Adjust the paths of the `k3s.yaml/rke2.yaml` file if needed. See https://github.com/suse-edge/support-tools/blob/main/nessie/README.md[Nessie] for more information.
65+
You should be able to run this container in non-privileged mode if you have proper permissions (typically `k3s.yaml` / `rke2-server.yaml` files are owned by root).
66+
====
67+
*** To collect logs in the system mode from the actual operating system, run:
68+
+
69+
[,shell]
70+
----
71+
podman run --rm --privileged \
72+
-v /var/log/journal:/var/log/journal:ro \
73+
-v /run/systemd:/run/systemd:ro \
74+
-v /etc/machine-id:/etc/machine-id:ro \
75+
-v /tmp:/tmp \
76+
-e NESSIE_LOG_DIR="/tmp" \
77+
-e NESSIE_ZIP_DIR="/tmp" \
78+
-e NESSIE_VERBOSE="1" \
79+
-e NESSIE_SKIP_POD_LOGS="true" \
80+
-e NESSIE_SKIP_K8S_CONFIGS="true" \
81+
-e NESSIE_SKIP_METRICS="true" \
82+
registry.suse.com/edge/3.4/nessie:1.0.0
83+
----
84+
+
85+
[NOTE]
86+
====
87+
Please make sure to check https://github.com/suse-edge/support-tools/blob/main/nessie/README.md[Nessie] for more details and information on how to run Nessie in your environment.
88+
Likewise, you should be able to run this container in non-privileged mode provided you have proper permissions.
6389
====
6490
65-
////
6691
6792
.Contact Support
6893
Please check the article available at https://www.suse.com/support/kb/doc/?id=000019452[How-to effectively work with SUSE Technical Support] and the support handbook located at https://www.suse.com/support/handbook/[SUSE Technical Support Handbook] for more details on how to contact SUSE support.

asciidoc/troubleshooting/general-troubleshooting-principles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Before diving into component-specific issues, consider these general principles:
2525
* *Isolate the problem*: Try to narrow down the issue to a specific component or layer (for example, network, storage, OS, Kubernetes, Metal^3^, Ironic,...).
2626
* *Documentation*: Always refer to the official https://documentation.suse.com/suse-edge/[SUSE Edge documentation] and also upstream documentation for detailed information.
2727
* *Versions*: SUSE Edge is an opinionated and thoroughly tested version of different SUSE components. The versions of each component per SUSE Edge release can be observed in the https://documentation.suse.com/suse-edge/support-matrix/html/support-matrix/index.html[SUSE Edge support matrix].
28-
* *Known issues*: For each SUSE Edge release there is a “Known issues” section on the release notes that contains information of issues that will be fixed on future releases but can affect the current one.
28+
* *Known issues*: For each SUSE Edge release there is a “Known issues” section on the release notes that contains information of issues that will be fixed on future releases but can affect the current one.

0 commit comments

Comments
 (0)