-
Notifications
You must be signed in to change notification settings - Fork 16
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
Edit readme breadcrumbs for TOC purposes #31
Changes from 5 commits
f3b7bf2
797bc07
9ae1c7c
d4c351e
331568a
a96c1df
526c913
069e3b2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
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`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,13 +2,29 @@ | |
|
||
## MKE 4 | ||
|
||
### Concepts and Architecture | ||
|
||
- Architecture | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. need links There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Configured links, but for now they will not all work as not all of the pertinent content topic PRs have been reviewed and merged. |
||
- Configuration | ||
- Migration configuration | ||
|
||
### Setup | ||
[Install mkectl](../docs/setup/README.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We still need it for https://github.com/Mirantis/mke-docs/blob/main/content/docs/setup/README.md |
||
|
||
[Get Started with MKE 4](../docs/setup/getting-started/README.md) | ||
- [Get Started with MKE 4](../docs/setup/getting-started/README.md) | ||
- Prerequisites | ||
- Installation | ||
- Using the cluster | ||
- k0s in AWS | ||
- Uninstallation | ||
- [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md) | ||
|
||
### Reference | ||
|
||
[Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md) | ||
- Authentication | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would you rather to have a sperate section with all the links? Or just add links to the following "Features" table with their deliverable releases? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Discussed in Slack. |
||
- [Backup and restore](../docs/reference/backuprestore/backup-restore.md) | ||
- [Ingress controller](../docs/reference/ingress/ingress-controller.md) | ||
- [Monitoring](../docs/reference/monitoring/monitoring.md) | ||
- [Support bundle](../docs/reference/supportbundle/support-bundle.md) | ||
|
||
### Features | ||
This table summarizes MKE 4 features, their status, and links to guides | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change does not belong to this PR.