Merge pull request #609 from btat/k3s-version

Remove command to install K3s without specifying version
2026-09-25 04:28:15 +00:00 · 2023-05-19 09:34:39 -07:00
parent 04074b9a24 2df1e2acca
commit 73f87e951e
7 changed files with 41 additions and 36 deletions
@@ -64,9 +64,9 @@ For more information on private registries configuration file for K3s, refer to

 ### 3. Install K3s

-Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/)
+Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/).

-To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script.
+To specify the K3s (Kubernetes) version, use the INSTALL_K3S_VERSION (e.g., `INSTALL_K3S_VERSION="v1.24.10+k3s1"`) environment variable when running the K3s installation script.

 Obtain the K3s binary from the [releases](https://github.com/k3s-io/k3s/releases) page, matching the same version used to get the airgap images tar.
 Also obtain the K3s install script at https://get.k3s.io
@@ -77,17 +77,16 @@ Place the install script anywhere on each node, and name it `install.sh`.
 Install K3s on each server:

 ```
-INSTALL_K3S_SKIP_DOWNLOAD=true ./install.sh
+INSTALL_K3S_SKIP_DOWNLOAD=true INSTALL_K3S_VERSION=<VERSION> ./install.sh
 ```

 Install K3s on each agent:

 ```
-INSTALL_K3S_SKIP_DOWNLOAD=true K3S_URL=https://myserver:6443 K3S_TOKEN=mynodetoken ./install.sh
+INSTALL_K3S_SKIP_DOWNLOAD=true INSTALL_K3S_VERSION=<VERSION> K3S_URL=https://<SERVER>:6443 K3S_TOKEN=<TOKEN> ./install.sh
 ```

-Note, take care to ensure you replace `myserver` with the IP or valid DNS of the server and replace `mynodetoken` with the node-token from the server.
-The node-token is on the server at `/var/lib/rancher/k3s/server/node-token`
+Where `<SERVER>` is the IP or valid DNS of the server and `<TOKEN>` is the node-token from the server found at `/var/lib/rancher/k3s/server/node-token`.

 :::note

@@ -15,14 +15,16 @@ The full installation requirements are [here](../../../pages-for-subheaders/inst

 ## Install K3s on Linux

+Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/).
+
+To specify the K3s (Kubernetes) version, use the INSTALL_K3S_VERSION (e.g., `INSTALL_K3S_VERSION="v1.24.10+k3s1"`) environment variable when running the K3s installation script.
+
 Install a K3s cluster by running this command on the Linux machine:

 ```
-curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION="***" sh -s - server --cluster-init
+curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=<VERSION> sh -s - server --cluster-init
 ```

-Rancher needs to be installed on a supported Kubernetes version. To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script. Refer to the [support maintenance terms](https://rancher.com/support-maintenance-terms/).
-
 Using `--cluster-init` allows K3s to use embedded etcd as the datastore and has the ability to convert to an HA setup. Refer to [High Availability with Embedded DB](https://rancher.com/docs/k3s/latest/en/installation/ha-embedded/).

 Save the IP of the Linux machine.
@@ -20,7 +20,10 @@ In both single-node setups, Rancher can be installed with Helm on the Kubernetes

 These instructions assume you have set up two nodes, a load balancer, a DNS record, and an external MySQL database as described in [this section.](../infrastructure-setup/ha-k3s-kubernetes-cluster.md)

-Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script.
+Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [Rancher Support Matrix](https://rancher.com/support-maintenance-terms/).
+
+To specify the K3s (Kubernetes) version, use the INSTALL_K3S_VERSION (e.g., `INSTALL_K3S_VERSION="v1.24.10+k3s1"`) environment variable when running the K3s installation script.
+
 ## Installing Kubernetes

 ### 1. Install Kubernetes and Set up the K3s Server
@@ -30,15 +33,12 @@ When running the command to start the K3s Kubernetes API server, you will pass i
 1. Connect to one of the Linux nodes that you have prepared to run the Rancher server.
 1. On the Linux node, run this command to start the K3s server and connect it to the external datastore:
  ```
-  curl -sfL https://get.k3s.io | sh -s - server \
-    --datastore-endpoint="mysql://username:password@tcp(hostname:3306)/database-name"
-  ```
-  To specify the K3s version, use the INSTALL_K3S_VERSION environment variable:
-  ```sh
-  curl -sfL https://get.k3s.io |  INSTALL_K3S_VERSION=vX.Y.Z sh -s - server \
-    --datastore-endpoint="mysql://username:password@tcp(hostname:3306)/database-name"
+  curl -sfL https://get.k3s.io |  INSTALL_K3S_VERSION=<VERSION> sh -s - server \
+    --datastore-endpoint="<DATASTORE_ENDPOINT>"
    ```

+  Where `<DATASTORE_ENDPOINT>` is the connection URI for your datastore. For example, `mysql://username:password@tcp(hostname:3306)/database-name` if you're using MySQL. Valid datastores include  etcd, MySQL, PostgreSQL, or SQLite (default).
+
  :::note

  The datastore endpoint can also be passed in using the environment variable `$K3S_DATASTORE_ENDPOINT`.