From f3b7bf2fd335d64c311161aa64515c0ae71e8e17 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 31 May 2024 19:42:01 +0200 Subject: [PATCH 1/8] Initial edit of MKE 4 supportbundle content, including text changes and content restructuring/granulation. --- .../docs/reference/supportbundle/README.md | 44 -------------- .../reference/supportbundle/support-bundle.md | 60 +++++++++++++++++++ 2 files changed, 60 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 - ``` - 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-.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..e0269c62 --- /dev/null +++ b/content/docs/reference/supportbundle/support-bundle.md @@ -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: + + - Capture of cluster information + - Setting of cluster resources + - Collection of 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). + +2. Run the `support-bundle` tool: + + ```shell + ./support-bundle --kubeconfig /var/lib/k0s/pki/admin.conf + ``` + +>**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-.tar.gz`. \ No newline at end of file From 797bc076d1d2cac716d0987db4ca78d5b8664e8e Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 7 Jun 2024 12:53:15 +0200 Subject: [PATCH 2/8] Edits made in response to review by Magda Dziadosz. --- content/docs/reference/supportbundle/support-bundle.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/reference/supportbundle/support-bundle.md b/content/docs/reference/supportbundle/support-bundle.md index e0269c62..4cf32ece 100644 --- a/content/docs/reference/supportbundle/support-bundle.md +++ b/content/docs/reference/supportbundle/support-bundle.md @@ -4,7 +4,7 @@ support the [Replicated support bundle tool](https://troubleshoot.sh/docs/support-bundle/introduction/). -## To manually collect a support bundle: +**To manually collect a support bundle:** 1. SSH into the manager node. 2. Download and install the `support-bundle` tool: @@ -37,13 +37,13 @@ tool](https://troubleshoot.sh/docs/support-bundle/introduction/). This configuration accomplishes the following: - - Capture of cluster information - - Setting of cluster resources - - Collection of logs from the `blueprint-controller-manager` and + - 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 +**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). From 9ae1c7c1ffbf0c294e825e393802f979684bbb46 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 7 Jun 2024 18:40:51 +0200 Subject: [PATCH 3/8] Edit to include a note directive for step one of collect host information using YAML file. --- content/docs/reference/supportbundle/support-bundle.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/content/docs/reference/supportbundle/support-bundle.md b/content/docs/reference/supportbundle/support-bundle.md index 4cf32ece..06399690 100644 --- a/content/docs/reference/supportbundle/support-bundle.md +++ b/content/docs/reference/supportbundle/support-bundle.md @@ -45,7 +45,12 @@ tool](https://troubleshoot.sh/docs/support-bundle/introduction/). **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). +1. Obtain the [k0s-provided YAML + file](https://docs.k0sproject.io/stable/support-bundle-worker.yaml). + + !!! note "A very important title of a very important note" + + 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: From d4c351ea701bf4c3b36fb9e182cb8c0aa301a8f9 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 7 Jun 2024 18:46:54 +0200 Subject: [PATCH 4/8] Fixed non-working Note directive inserted with previous commit. --- content/docs/reference/supportbundle/support-bundle.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/docs/reference/supportbundle/support-bundle.md b/content/docs/reference/supportbundle/support-bundle.md index 06399690..44f0a99b 100644 --- a/content/docs/reference/supportbundle/support-bundle.md +++ b/content/docs/reference/supportbundle/support-bundle.md @@ -48,9 +48,7 @@ tool](https://troubleshoot.sh/docs/support-bundle/introduction/). 1. Obtain the [k0s-provided YAML file](https://docs.k0sproject.io/stable/support-bundle-worker.yaml). - !!! note "A very important title of a very important note" - - 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/). + >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: From 331568a4c22509258fcd7a9cf918691026094330 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 7 Jun 2024 21:32:43 +0200 Subject: [PATCH 5/8] Initial edit of README.md, to transform it into a TOC for docs content. --- content/releases/README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index a1daeebc..6c138f18 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -2,13 +2,29 @@ ## MKE 4 +### Concepts and Architecture + +- Architecture +- Configuration +- Migration configuration ### Setup -[Install mkectl](../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 +- [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 From a96c1df48c9db00d6a0a65c736f8c0208d716c06 Mon Sep 17 00:00:00 2001 From: Kory <57411706+KoryKessel-Mirantis@users.noreply.github.com> Date: Fri, 7 Jun 2024 23:18:37 +0200 Subject: [PATCH 6/8] Delete content/docs/reference/supportbundle/support-bundle.md --- .../reference/supportbundle/support-bundle.md | 63 ------------------- 1 file changed, 63 deletions(-) delete mode 100644 content/docs/reference/supportbundle/support-bundle.md diff --git a/content/docs/reference/supportbundle/support-bundle.md b/content/docs/reference/supportbundle/support-bundle.md deleted file mode 100644 index 44f0a99b..00000000 --- a/content/docs/reference/supportbundle/support-bundle.md +++ /dev/null @@ -1,63 +0,0 @@ -# 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 - ``` - ->**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-.tar.gz`. \ No newline at end of file From 526c9136ebad9720d4598e949b0416d29dcb9ca9 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Sat, 8 Jun 2024 00:16:33 +0200 Subject: [PATCH 7/8] Edit in response to RyanZ comments. Addition of links to TOC entries. --- content/releases/README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 6c138f18..47ecd264 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -4,36 +4,42 @@ ### Concepts and Architecture -- Architecture -- Configuration -- Migration configuration +- [Architecture](../docs/concepts/architecture/architecture.md) +- [Configuration](../docs/concepts/architecture/configuration.md) +- [Migrate configuration](../docs/concepts/architecture/migrate-configuration.md) ### Setup - [Get Started with MKE 4](../docs/setup/getting-started/README.md) - - Prerequisites - - Installation - - Using the cluster - - k0s in AWS - - Uninstallation + - [Prerequisites](../docs/setup/getting-started/prerequisites.md) + - [Installation](../docs/setup/getting-started/installation.md) + - [Using the cluster](../docs/setup/getting-started/using-the-cluster.md) + - [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md) + - [Uninstallation](../docs/setup/getting-started/uninstallation.md) - [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md) ### Reference -- Authentication +- [Authentication](../docs/reference/authentication/authentication.md) - [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) +### Known issues + +- [Known issues](known-issues.md) + ### Features -This table summarizes MKE 4 features, their status, and links to guides + +The table that follows details MKE 4 features and their current status. In +addition, where applicable, the table offers links to associated documentation. | Feature | Pre-Release | Status | |------------------------------------------------------------------|-------|----------| | Authentication | alpha.1| MVP | | Authorization | alpha.1 | MVP | -| [Backup & Restore](../docs/reference/backuprestore/README.md) | alpha.1 | MVP | +| [Backup and restore](../docs/reference/backuprestore/backup-restore.md) | alpha.1 | MVP | | CIS Benchmark | | | | CLI | | | | Cloud Providers | | | @@ -41,7 +47,7 @@ This table summarizes MKE 4 features, their status, and links to guides | cAdvisor | | | | gMSA | | | | GPU Feature Discovery | | | -| [Ingress](../docs/reference/ingress/README.md) | alpha.1| MVP | | +| [Ingress](../docs/reference/ingress/ingress-controller.md) | alpha.1| MVP | | | [Kubernetes](../docs/concepts/architecture/README.md#Components) | alpha.1 | MVP 1.29 | | | Life Cycle Management | | | | Licensing | | | From 069e3b2797af64e7a5805702ab77b41d7d781da9 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Mon, 10 Jun 2024 21:20:28 +0200 Subject: [PATCH 8/8] Change filename of installation.md to create-a-cluster.md and correct link. --- content/releases/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/releases/README.md b/content/releases/README.md index 47ecd264..9ad36954 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -12,7 +12,7 @@ - [Get Started with MKE 4](../docs/setup/getting-started/README.md) - [Prerequisites](../docs/setup/getting-started/prerequisites.md) - - [Installation](../docs/setup/getting-started/installation.md) + - [Create a cluster](../docs/setup/getting-started/create-a-cluster.md) - [Using the cluster](../docs/setup/getting-started/using-the-cluster.md) - [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md) - [Uninstallation](../docs/setup/getting-started/uninstallation.md)