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

Edit readme breadcrumbs for TOC purposes #31

Closed
44 changes: 0 additions & 44 deletions content/docs/reference/supportbundle/README.md

This file was deleted.

63 changes: 63 additions & 0 deletions content/docs/reference/supportbundle/support-bundle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Support bundle
Copy link
Collaborator

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.


>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`.
22 changes: 19 additions & 3 deletions content/releases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,29 @@

## MKE 4

### Concepts and Architecture

- Architecture
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need links

Copy link
Collaborator Author

Choose a reason for hiding this comment

The 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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


[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
Copy link
Collaborator

Choose a reason for hiding this comment

The 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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The 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
Expand Down