-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Edit supportbundle content initial (#22)
- Loading branch information
1 parent
be88301
commit 285691b
Showing
2 changed files
with
63 additions
and
44 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`. |