From 4e0849d1a1d41d6e3a2dacd5d0b34c946eb320ac Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Tue, 11 Jun 2024 12:50:29 +0200 Subject: [PATCH] Edits in response to review by Magda Dziadosz. --- .../getting-started/Using-the-cluster.md | 12 ++--- .../setup/getting-started/create-a-cluster.md | 21 ++++---- .../setup/getting-started/install-mke4-cli.md | 50 +++++++++++-------- .../upgrade-prerequisites.md | 14 ++++-- 4 files changed, 54 insertions(+), 43 deletions(-) diff --git a/content/docs/setup/getting-started/Using-the-cluster.md b/content/docs/setup/getting-started/Using-the-cluster.md index 62a500e3..673dfb9f 100644 --- a/content/docs/setup/getting-started/Using-the-cluster.md +++ b/content/docs/setup/getting-started/Using-the-cluster.md @@ -1,6 +1,4 @@ - - -## Using the cluster +# Using the cluster You can use `kubectl` with the `mke` context to interact with the cluster, though it is necessary to specify the configuration. `mkectl` outputs the @@ -10,22 +8,20 @@ You can apply ``.mke.kubeconfig`` using any one of the following methods: - Set the KUBECONFIG env var to point to `~/.mke/mke.kubeconfig` - Example: - ```shell - `export KUBECONFIG=~/.mke/.kubeconfig` + export KUBECONFIG=~/.mke/.kubeconfig ``` - Append the contents to the default kubeconfig: ```shell - `cat ~/.mke/mke.kubeconfig >> ~/.kube/config` + cat ~/.mke/mke.kubeconfig >> ~/.kube/config ``` - Specify the config as a command argument: ```shell - `kubectl --kubeconfig ~/.mke/mke.kubeconfig` + kubectl --kubeconfig ~/.mke/mke.kubeconfig ``` Example output: diff --git a/content/docs/setup/getting-started/create-a-cluster.md b/content/docs/setup/getting-started/create-a-cluster.md index ef1ef41d..7fea6f6e 100644 --- a/content/docs/setup/getting-started/create-a-cluster.md +++ b/content/docs/setup/getting-started/create-a-cluster.md @@ -1,16 +1,17 @@ -## Create a cluster +# Create a cluster -### Dependencies +## Dependencies A number of tools must be installed on your system before you can install MKE 4: -* mkectl -* k0sctl -* kubectl + +- mkectl +- k0sctl +- kubectl Refer to [Install the MKE 4 CLI](install-mke4-cli.md) for detailed information. -### Init +## Initialization MKE 4 installation is performed through the use of a single YAML file, detailing the desired cluster configuration. To generate this YAML file, run @@ -28,7 +29,7 @@ of nodes. requirements](prerequisites.md#system-requirements-for-cluster-nodes). > > Node provisioning is managed by the cluster administrators. You can, for -instance, use [Terraform](https://www.terraform.io/) to create the nodes in a +instance, use Terraform to create the nodes in a cloud provider. [Example Terraform configuration](k0s-in-aws/terraform-scenario.md). @@ -98,7 +99,7 @@ monitoring: -### Install +## Installation To perform the installation, run the `apply` command with the generated YAML configuration file: @@ -107,10 +108,10 @@ configuration file: mkectl apply -f mke.yaml ``` -### Known limitations +## Known limitations - `mkectl apply` configures `mke` context in the default kubeconfig file that -is normally located at `~/.kube/config`. If the default kubeconfig is changed, +is located at `~/.kube/config`. If the default kubeconfig is changed, and the `mke` context becomes invalid or unavailable, `mkectl` will be unable to manage the cluster until the kubeconfig is restored. - You must not attempt to create a new cluster until you have first deleted the diff --git a/content/docs/setup/getting-started/install-mke4-cli.md b/content/docs/setup/getting-started/install-mke4-cli.md index c4185abd..0578ff70 100644 --- a/content/docs/setup/getting-started/install-mke4-cli.md +++ b/content/docs/setup/getting-started/install-mke4-cli.md @@ -10,7 +10,7 @@ You can download `mkectl`, the MKE CLI tool, from the S3 bucket: - [Windows x86_64 image](https://s3.us-east-2.amazonaws.com/packages-stage-mirantis.com/v4.0.0-alpha1.0/mkectl_windows_x86_64.zip) Envisioned as a single binary, capable of managing MKE 4 clusters without any -additional dependencies, as of `MKE 4.0.0-alpha.1.0` the MKE CLI still requires +additional dependencies, as of `MKE 4.0.0-alpha.1.0` the MKE CLI requires that you have the following tools installed on your system: - `kubectl`, version `1.29.0` or later ([download](https://kubernetes.io/docs/tasks/tools/#kubectl)) @@ -28,7 +28,7 @@ dependencies: To override the default versions, pass the variables `K0SCTL_VERSION`,`MKECTL_VERSION`and `KUBECTL_VERSION`. ->The `install.sh` script detects whether kubectl is already installed on your +>The `install.sh` script detects whether `kubectl` is already installed on your >system and will not overwrite it. It also detects the operating system and the >underlying architecture, based on which it will install the `k0sctl`, `kubectl` and `mkectl` binaries in `/usr/local/bin`. Thus, you must ensure that @@ -39,36 +39,46 @@ To override the default versions, pass the variables `K0SCTL_VERSION`,`MKECTL_VE ```shell sudo /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Mirantis/mke-docs/main/content/docs/setup/install.sh)" ``` -3. Confirm the installations: +2. Confirm dependency installations: 1. To confirm `mkectl`, run: ```shell - mkectl version + mkectl version ``` + Expected output: + ```shell - Version: v4.0.0-alpha.1.0 - ``` + Version: v4.0.0-alpha.1.0 + ``` + 2. To confirm `k0sctl`, run: - ```shell - k0sctl version - ``` + + ```shell + k0sctl version + ``` + Expected output: + ```shell - version: v0.17.8 - commit: b061291 - ``` - 3. To confirm kubectl, run: - ```shell - kubectl version - ``` + version: v0.17.8 + commit: b061291 + ``` + + 3. To confirm `kubectl`, run: + + ```shell + kubectl version + ``` + Expected output: + ```shell - Client Version: v1.30.0 - Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3 - Server Version: v1.29.3+k0s - ``` + Client Version: v1.30.0 + Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3 + Server Version: v1.29.3+k0s + ``` ### Start Debug mode To turn the debug mode on, run: diff --git a/content/docs/setup/upgrade-from-mke-3/upgrade-prerequisites.md b/content/docs/setup/upgrade-from-mke-3/upgrade-prerequisites.md index 6f9a99a8..dbd29cdd 100644 --- a/content/docs/setup/upgrade-from-mke-3/upgrade-prerequisites.md +++ b/content/docs/setup/upgrade-from-mke-3/upgrade-prerequisites.md @@ -1,8 +1,6 @@ -# Upgrade from MKE 3 to MKE 4 +# Upgrade prerequisites -## Prerequisites - -Verify that you have the following components in place before you begin the upgrade process: +Verify that you have the following components in place before you begin upgrading MKE3 to MKE 4: - A running MKE 3.7.x cluster: @@ -21,6 +19,9 @@ Verify that you have the following components in place before you begin the upgr ```shell mkectl version ``` + + Example output: + ```shell Version: v4.0.0-alpha.1.0 ``` @@ -31,12 +32,15 @@ Verify that you have the following components in place before you begin the upgr k0sctl version ``` + Example output: + ```shell version: v0.17.4 commit: 372a589 ``` + - A `hosts.yaml` file, to provide the information required by `mkectl` to - connect to each node by way of SSH. + connect to each node with SSH. Example `hosts.yaml` file: