diff --git a/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md b/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md index 61c731d2d43..0437530f6bd 100644 --- a/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md +++ b/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md @@ -61,13 +61,10 @@ To take recurring snapshots, enable the `etcd-snapshot` service, which is a serv 5. Open **Terminal** and change directory to the location of the RKE binary. Your `rancher-cluster.yml` file must reside in the same directory. -6. Run one of the following commands: +6. Run the following command: ``` - # MacOS - ./rke_darwin-amd64 up --config rancher-cluster.yml - # Linux - ./rke_linux-amd64 up --config rancher-cluster.yml + rke up --config rancher-cluster.yml ``` @@ -84,10 +81,7 @@ When you're about to upgrade Rancher or restore it to a previous snapshot, you s 2. Enter the following command. Replace `` with any name that you want to use for the snapshot (e.g. `upgrade.db`). ``` - # MacOS - ./rke_darwin-amd64 etcd snapshot-save --name --config rancher-cluster.yml - # Linux - ./rke_linux-amd64 etcd snapshot-save --name --config rancher-cluster.yml + rke etcd snapshot-save --name --config rancher-cluster.yml ``` **Result:** RKE takes a snapshot of `etcd` running on each `etcd` node. The file is saved to `/opt/rke/etcd-snapshots`. diff --git a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md index bb6f251614d..babaced624b 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md @@ -23,7 +23,7 @@ Installation of Rancher in a high-availability configuration involves multiple p - [1. Provision Linux Hosts](#1-provision-linux-hosts) - [2. Configure Load Balancer](#2-configure-load-balancer) - [3. Configure DNS](#3-configure-dns) -- [4. Download RKE](#4-download-rke) +- [4. Install RKE](#4-install-rke) - [5. Download RKE Config File Template](#5-download-rke-config-file-template) - [6. Configure Nodes](#6-configure-nodes) - [7. Configure Certificates](#7-configure-certificates) @@ -139,40 +139,16 @@ Choose a fully qualified domain name (FQDN) that you want to use to access Ranch
-## 4. Download RKE +## 4. Install RKE -RKE is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. We will be using RKE to setup our cluster and run Rancher. +RKE (Rancher Kubernetes Engine) is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. We will use RKE to setup our cluster and run Rancher. -1. From your workstation, open a web browser and navigate to our [RKE Releases](https://github.com/rancher/rke/releases/latest) page. Download the latest RKE installer applicable to your Operating System: +1. Follow the [RKE Install]({{< baseurl >}}/rke/v0.1.x/en/installation) instructions. - - **MacOS**: `rke_darwin-amd64` - - **Linux**: `rke_linux-amd64` - - **Windows**: `rke_windows-amd64.exe` - -2. Make the RKE binary that you just downloaded executable. Open Terminal, change directory to the location of the RKE binary, and then run one of the commands below. - - >**Using Windows?** - >The file is already an executable. Skip to [Download Config File Template](#5-download-rke-config-file-template). +2. Confirm that RKE is now executable by running the following command: ``` - # MacOS - $ chmod +x rke_darwin-amd64 - # Linux - $ chmod +x rke_linux-amd64 - ``` - -3. Confirm that RKE is now executable by running the following command: - - ``` - # MacOS - $ ./rke_darwin-amd64 --version - # Linux - $ ./rke_linux-amd64 --version - ``` - - **Step Result:** You receive output similar to what follows: - ``` - rke version v + rke --version ``` ## 5. Download RKE Config File Template @@ -387,10 +363,7 @@ With all configuration in place, use RKE to launch Rancher. You can complete thi 3. Enter one of the `rke up` commands listen below. ``` -# MacOS -./rke_darwin-amd64 up --config rancher-cluster.yml -# Linux -./rke_linux-amd64 up --config rancher-cluster.yml +rke up --config rancher-cluster.yml ``` **Step Result:** The output should be similar to the snippet below: diff --git a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md index 256a2543e46..d9eae55f92b 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md @@ -23,7 +23,7 @@ Installation of Rancher in a high-availability configuration involves multiple p - [1. Provision Linux Hosts](#1-provision-linux-hosts) - [2. Configure Load Balancer](#2-configure-load-balancer) - [3. Configure DNS](#3-configure-dns) -- [4. Download RKE](#4-download-rke) +- [4. Install RKE](#4-install-rke) - [5. Download RKE Config File Template](#5-download-rke-config-file-template) - [6. Configure Nodes](#6-configure-nodes) - [7. Configure Certificates](#7-configure-certificates) @@ -87,40 +87,16 @@ Choose a fully qualified domain name (FQDN) that you want to use to access Ranch
-## 4. Download RKE +## 4. Install RKE -RKE is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. We will be using RKE to setup our cluster and run Rancher. +RKE (Rancher Kubernetes Engine) is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. We will use RKE to setup our cluster and run Rancher. -1. From your workstation, open a web browser and navigate to our [RKE Releases](https://github.com/rancher/rke/releases/latest) page. Download the latest RKE installer applicable to your Operating System: +1. Follow the [RKE Install]({{< baseurl >}}/rke/v0.1.x/en/installation) instructions. - - **MacOS**: `rke_darwin-amd64` - - **Linux**: `rke_linux-amd64` - - **Windows**: `rke_windows-amd64.exe` - -2. Make the RKE binary that you just downloaded executable. Open Terminal, change directory to the location of the RKE binary, and then run one of the commands below. - - >**Using Windows?** - >The file is already an executable. Skip to [Download RKE Config File Template](#5-download-rke-config-file-template). +2. Confirm that RKE is now executable by running the following command: ``` - # MacOS - $ chmod +x rke_darwin-amd64 - # Linux - $ chmod +x rke_linux-amd64 - ``` - -3. Confirm that RKE is now executable by running the following command: - - ``` - # MacOS - $ ./rke_darwin-amd64 --version - # Linux - $ ./rke_linux-amd64 --version - ``` - - **Step Result:** You receive output similar to what follows: - ``` - rke version v + rke --version ``` ## 5. Download RKE Config File Template @@ -275,10 +251,7 @@ With all configuration in place, use RKE to launch Rancher. You can complete thi 3. Enter one of the `rke up` commands listen below. ``` - # MacOS - ./rke_darwin-amd64 up --config rancher-cluster.yml - # Linux - ./rke_linux-amd64 up --config rancher-cluster.yml + rke up --config rancher-cluster.yml ``` **Step Result:** The output should be similar to the snippet below: diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md index 18d9414f8ee..2d98fbf9917 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md @@ -28,10 +28,7 @@ This document is for upgrading Rancher HA installed with the RKE Add-On yaml. Se 1. Enter the following command. Replace `` with any name that you want to use for the snapshot (e.g. `upgrade.db`). ``` - # MacOS - ./rke_darwin-amd64 etcd snapshot-save --name --config rancher-cluster.yml - # Linux - ./rke_linux-amd64 etcd snapshot-save --name --config rancher-cluster.yml + rke etcd snapshot-save --name --config rancher-cluster.yml ``` **Result:** RKE takes a snapshot of `etcd` running on each `etcd` node. The file is saved to `/opt/rke/etcd-snapshots`. diff --git a/content/rke/v0.1.x/en/installation/_index.md b/content/rke/v0.1.x/en/installation/_index.md index 4ee201aea49..bead2e1cab9 100644 --- a/content/rke/v0.1.x/en/installation/_index.md +++ b/content/rke/v0.1.x/en/installation/_index.md @@ -19,25 +19,30 @@ RKE is a fast, versatile Kubernetes installer that you can use to install Kubern - **Linux**: `rke_linux-amd64` - **Windows**: `rke_windows-amd64.exe` -2. Make the RKE binary that you just downloaded executable. Open Terminal, change directory to the location of the RKE binary, and then run one of the commands below. +2. Copy the RKE binary to a folder in your `$PATH` and rename it `rke` (or `rke.exe` for Windows) + + ``` + # MacOS + $ mv rke_darwin-amd64 rke + # Linux + $ mv rke_linux-amd64 rke + # Windows PowerShell + > mv rke_windows-amd64.exe rke.exe + ``` + +3. Make the RKE binary that you just downloaded executable. Open Terminal, change directory to the location of the RKE binary, and then run one of the commands below. >**Using Windows?** >The file is already an executable. Skip to [Prepare the Nodes for the Kubernetes Cluster](#prepare-the-nodes-for-the-kubernetes-cluster). ``` - # MacOS - $ chmod +x rke_darwin-amd64 - # Linux - $ chmod +x rke_linux-amd64 + $ chmod +x rke ``` -3. Confirm that RKE is now executable by running the following command: +4. Confirm that RKE is now executable by running the following command: ``` - # MacOS - $ ./rke_darwin-amd64 --version - # Linux - $ ./rke_linux-amd64 --version + $ rke --version ``` ## Prepare the Nodes for the Kubernetes cluster @@ -57,27 +62,18 @@ There are two easy ways to create a `cluster.yml`: ### Using `rke config` -To create a new `cluster.yml`, run `rke config` and this command prompts you for all the information needed to build your cluster. Review [our cluster configuration options]({{< baseurl >}}/rke/v0.1.x/en/config-options/) to understand what each question means. +Run `rke config` to create a new `cluster.yml` in the current directory. This command will prompt you for all the information needed to build a cluster. See [cluster configuration options]({{< baseurl >}}/rke/v0.1.x/en/config-options/) for details on the various options. ``` -./rke_darwin-amd64 config +rke config --name cluster.yml ``` -After answering the list of questions, there is a `cluster.yml` created in the directory where you launched the `rke config` command. After the `cluster.yml` is created, you can edit the file to make any changes. - -#### Creating a Basic `cluster.yml` -``` -$ rke config --name cluster.yml -``` - -After answering the list of questions, there is a `cluster.yml` created in the directory where you launched the `rke config` command. - #### Creating an Empty `cluster.yml` -If you want an empty `cluster.yml` template, you can use the `--empty` flag so that a template is produced, but there are no values in the template. +You can create an empty template `cluster.yml` file by specifying the `--empty` flag. ``` -$ rke config --empty --name cluster.yml +rke config --empty --name cluster.yml ``` #### Printing the `cluster.yml` @@ -85,7 +81,7 @@ $ rke config --empty --name cluster.yml Instead of creating a file, you can print the generated configuration to stdout using the `--print` flag. ``` -$ rke config --print +rke config --print ``` ### High Availability @@ -99,16 +95,8 @@ To create an HA cluster, specify more than one host with role `controlplane`. After you've created your `cluster.yml`, you can deploy your cluster with a simple command. This command assumes the `cluster.yml` file is in the same directory as where you are running the command. ``` -# MacOS -$ ./rke_darwin-amd64 up -# Linux -$ ./rke_linux-amd64 up -``` +rke up -There will be log statements as the Kubernetes cluster is created. - -``` -$ ./rke_darwin-amd64 up INFO[0000] Building Kubernetes cluster INFO[0000] [dialer] Setup tunnel for host [10.0.0.1] INFO[0000] [network] Deploying port listener containers @@ -123,9 +111,11 @@ The last line should read `Finished building Kubernetes cluster successfully` to In order to start interacting with your Kubernetes cluster, you will use a different binary called `kubectl`. You will need to [install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your local machine. You can connect to the RKE created cluster by using the `kube_config_cluster.yml` that was generated when you deployed Kubernetes. +Confirm that kubectl is working by checking the version of your Kubernetes cluster + ``` -# Confirm that kubectl is working by checking the version of your Kubernetes cluster -$ kubectl --kubeconfig kube_config_cluster.yml version +kubectl --kubeconfig kube_config_cluster.yml version + Client Version: version.Info{Major:"1", Minor:"10", GitVersion:"v1.10.0", GitCommit:"fc32d2f3698e36b93322a3465f63a14e9f0eaead", GitTreeState:"clean", BuildDate:"2018-03-27T00:13:02Z", GoVersion:"go1.9.4", Compiler:"gc", Platform:"darwin/amd64"} Server Version: version.Info{Major:"1", Minor:"8+", GitVersion:"v1.8.9-rancher1", GitCommit:"68595e18f25e24125244e9966b1e5468a98c1cd4", GitTreeState:"clean", BuildDate:"2018-03-13T04:37:53Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"} ``` @@ -133,7 +123,7 @@ Server Version: version.Info{Major:"1", Minor:"8+", GitVersion:"v1.8.9-rancher1" The client and server version are reported, indicating that you have a local `kubectl` client and are able to request the server version from the newly built cluster. Now, you can issue [any kubectl command](https://kubernetes.io/docs/reference/kubectl/kubectl/) to your cluster, like requesting the nodes that are in the cluster. ``` -$ kubectl --kubeconfig kube_config_cluster.yml get nodes +kubectl --kubeconfig kube_config_cluster.yml get nodes NAME STATUS ROLES AGE VERSION 10.0.0.1 Ready controlplane,etcd,worker 35m v1.10.3-rancher1 ```