From 285691ba6e752ba1935542be74fbbc70ccd19bb9 Mon Sep 17 00:00:00 2001
From: Kory <57411706+KoryKessel-Mirantis@users.noreply.github.com>
Date: Fri, 7 Jun 2024 18:55:22 +0200
Subject: [PATCH] [DOC] Edit supportbundle content initial (#22)

---
 .../docs/reference/supportbundle/README.md    | 44 -------------
 .../reference/supportbundle/support-bundle.md | 63 +++++++++++++++++++
 2 files changed, 63 insertions(+), 44 deletions(-)
 delete mode 100644 content/docs/reference/supportbundle/README.md
 create mode 100644 content/docs/reference/supportbundle/support-bundle.md

diff --git a/content/docs/reference/supportbundle/README.md b/content/docs/reference/supportbundle/README.md
deleted file mode 100644
index 342cf74d..00000000
--- a/content/docs/reference/supportbundle/README.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Support bundle
-
-For the Alpha.1 release, MKE 4 deploys k0s v1.29.3, which does not inherently support Replicated's [support bundle tool](https://troubleshoot.sh/docs/support-bundle/introduction/).
-
-To manually collect a support bundle, you can use the following steps:
-
-- SSH into the manager node.
-- Download and install the `support-bundle` tool:
-  ```shell
-  curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/support-bundle_linux_amd64.tar.gz | tar xzvf -
-  ```
-- Create a YAML file that describes the support bundle configuration. For example, create a file named `support-bundle-worker.yaml` with the following content:
-```yaml
-  apiVersion: troubleshoot.sh/v1beta2
-  kind: SupportBundle
-  metadata:
-    name: sample
-  spec:
-    collectors:
-      - logs:
-          selector:
-            - app.kubernetes.io/name=boundless-operator-webhook
-        namespace: boundless-system
-        name: logs/boundless-system
-      - logs:
-          selector:
-            - control-plane=controller-manager
-          namespace: boundless-system
-          name: logs/boundless-system
-  ```
-  This configuration collects the following information:
-  - Cluster information
-  - Cluster resources
-  - Logs from the `boundless-operator-controller-manager` and `boundless-operator-webhook` pods will be stored in the `logs/` directory of the output.
-  
-Another option is to collect host information by utilizing the YAML file provided by k0s in https://docs.k0sproject.io/stable/support-bundle-worker.yaml
-
-- Run the `support-bundle` tool:
-    ```shell
-    ./support-bundle --kubeconfig /var/lib/k0s/pki/admin.conf <support-bundle-worker.yaml>
-    ```
-    NOTE: 
-    - The `support-bundle` tool requires the `kubeconfig` file to be passed as an argument. The `kubeconfig` file is located at `/var/lib/k0s/pki/admin.conf`.
-    - The support bundle will be saved to a file named `support-bundle-<timestamp>.tar.gz`.
\ No newline at end of file
diff --git a/content/docs/reference/supportbundle/support-bundle.md b/content/docs/reference/supportbundle/support-bundle.md
new file mode 100644
index 00000000..44f0a99b
--- /dev/null
+++ b/content/docs/reference/supportbundle/support-bundle.md
@@ -0,0 +1,63 @@
+# Support bundle
+
+>For the Alpha.1 release, MKE 4 deploys k0s v1.29.3, which does not inherently
+support the [Replicated support bundle
+tool](https://troubleshoot.sh/docs/support-bundle/introduction/).
+
+**To manually collect a support bundle:**
+
+1. SSH into the manager node.
+2. Download and install the `support-bundle` tool:
+
+   ```shell
+   curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/support-bundle_linux_amd64.tar.gz | tar xzvf -
+   ```
+3. Create a YAML file that details the support bundle configuration.
+
+   Example `support-bundle-worker.yaml` file:
+
+   ```yaml
+     apiVersion: troubleshoot.sh/v1beta2
+     kind: SupportBundle
+     metadata:
+       name: sample
+     spec:
+       collectors:
+         - logs:
+             selector:
+               - app.kubernetes.io/name=blueprint-webhook
+           namespace: blueprint-system
+           name: logs/blueprint-system
+         - logs:
+             selector:
+               - control-plane=controller-manager
+             namespace: blueprint-system
+             name: logs/blueprint-system
+     ```
+
+     This configuration accomplishes the following:
+
+     - Captures of cluster information
+     - Sets of cluster resources
+     - Collects logs from the `blueprint-controller-manager` and
+       `blueprint-operator-webhook` pods, in the `logs/` directory of the
+       output.
+
+**To collect host information using the k0s-provided YAML file:**
+
+1. Obtain the [k0s-provided YAML
+   file](https://docs.k0sproject.io/stable/support-bundle-worker.yaml).
+
+   >MKE 4 Alpha 1.0 deploys k0s v1.29.3, which does not inherently support the [Replicated support bundle tool](https://troubleshoot.sh/docs/support-bundle/introduction/).
+
+2. Run the `support-bundle` tool:
+
+    ```shell
+    ./support-bundle --kubeconfig /var/lib/k0s/pki/admin.conf <support-bundle-worker.yaml>
+    ```
+
+>**NOTES**:
+>- The `support-bundle` tool requires that the `kubeconfig` file be passed as
+>  an argument. The `kubeconfig` file is located at
+>  `/var/lib/k0s/pki/admin.conf`.
+>- The support bundle is saved to a file named `support-bundle-<timestamp>.tar.gz`.
\ No newline at end of file