Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Edit supportbundle content initial #22

Merged
merged 4 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions content/docs/reference/supportbundle/README.md

This file was deleted.

60 changes: 60 additions & 0 deletions content/docs/reference/supportbundle/support-bundle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# 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).
KoryKessel-Mirantis marked this conversation as resolved.
Show resolved Hide resolved

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`.