diff --git a/content/rke/_index.md b/content/rke/_index.md index 97f203f8cf8..e7b5e9c8e4f 100644 --- a/content/rke/_index.md +++ b/content/rke/_index.md @@ -2,5 +2,4 @@ title: RKE weight: 1 showBreadcrumb: false -draft: true --- diff --git a/content/rke/v0.1.x/_index.md b/content/rke/v0.1.x/_index.md index 998ab9143a3..1e02f1cc36b 100644 --- a/content/rke/v0.1.x/_index.md +++ b/content/rke/v0.1.x/_index.md @@ -1,5 +1,4 @@ --- title: v0.1.x showBreadcrumb: false -draft: true --- diff --git a/content/rke/v0.1.x/en/_index.md b/content/rke/v0.1.x/en/_index.md index 6e73709d839..2b3455ff0f7 100644 --- a/content/rke/v0.1.x/en/_index.md +++ b/content/rke/v0.1.x/en/_index.md @@ -2,7 +2,6 @@ title: Overview of RKE shortTitle: RKE weight: 1 -draft: true --- Rancher Kubernetes Engine (RKE) is a light-weight Kubernetes installer that supports installation on bare-metal and virtualized servers. RKE solves a common issue in the Kubernettes community: installation complexity. With RKE, Kubernetes installation is simplified, regardless of what operating systems and platforms you're running. diff --git a/content/rke/v0.1.x/en/config-options/_index.md b/content/rke/v0.1.x/en/config-options/_index.md index aae73acee88..991d57de703 100644 --- a/content/rke/v0.1.x/en/config-options/_index.md +++ b/content/rke/v0.1.x/en/config-options/_index.md @@ -1,7 +1,6 @@ --- title: Config Options weight: 200 -draft: true --- When setting up your `cluster.yml` for RKE, there are a lot of different options that can be configured to control the behavior of how RKE launches Kubernetes. diff --git a/content/rke/v0.1.x/en/config-options/add-ons/_index.md b/content/rke/v0.1.x/en/config-options/add-ons/_index.md index 5eff45459d8..47c90019ef5 100644 --- a/content/rke/v0.1.x/en/config-options/add-ons/_index.md +++ b/content/rke/v0.1.x/en/config-options/add-ons/_index.md @@ -1,7 +1,6 @@ --- title: Add-Ons weight: 250 -draft: true --- RKE supports pluggable add-ons. Add-ons are used to deploy several cluster components including: diff --git a/content/rke/v0.1.x/en/config-options/add-ons/ingress-controllers/_index.md b/content/rke/v0.1.x/en/config-options/add-ons/ingress-controllers/_index.md index 57427c0b822..c54fe406d70 100644 --- a/content/rke/v0.1.x/en/config-options/add-ons/ingress-controllers/_index.md +++ b/content/rke/v0.1.x/en/config-options/add-ons/ingress-controllers/_index.md @@ -1,7 +1,6 @@ --- title: Ingress Controllers weight: 252 -draft: true --- By default, RKE deploys the nginx ingress controller on all schedulable nodes. diff --git a/content/rke/v0.1.x/en/config-options/add-ons/network-plugins/_index.md b/content/rke/v0.1.x/en/config-options/add-ons/network-plugins/_index.md index f91f50888a1..d956e788fa0 100644 --- a/content/rke/v0.1.x/en/config-options/add-ons/network-plugins/_index.md +++ b/content/rke/v0.1.x/en/config-options/add-ons/network-plugins/_index.md @@ -1,7 +1,6 @@ --- title: Network Plug-ins weight: 251 -draft: true --- RKE supports the following network plug-ins that are deployed as add-ons: diff --git a/content/rke/v0.1.x/en/config-options/add-ons/user-defined-add-ons/_index.md b/content/rke/v0.1.x/en/config-options/add-ons/user-defined-add-ons/_index.md index 3c06936b3bd..6aeb9c1f705 100644 --- a/content/rke/v0.1.x/en/config-options/add-ons/user-defined-add-ons/_index.md +++ b/content/rke/v0.1.x/en/config-options/add-ons/user-defined-add-ons/_index.md @@ -1,7 +1,6 @@ --- title: User-Defined Add-Ons weight: 253 -draft: true --- Besides the [network plug-in]({{< baseurl >}}/rke/v0.1.x/en/config-options/network-plugins/) and [ingress controllers]({{< baseurl >}}/rke/v0.1.x/en/config-options/ingress-controllers/), you can define any add-on that you want deployed after the Kubernetes cluster is deployed. diff --git a/content/rke/v0.1.x/en/config-options/authentication/_index.md b/content/rke/v0.1.x/en/config-options/authentication/_index.md index da1796149af..dd9bedff5ef 100644 --- a/content/rke/v0.1.x/en/config-options/authentication/_index.md +++ b/content/rke/v0.1.x/en/config-options/authentication/_index.md @@ -1,7 +1,6 @@ --- title: Authentication weight: 235 -draft: true --- RKE supports x509 authentication strategy. You can additionally define a list of SANs (Subject Alternative Names) to add to the Kubernetes API Server PKI certificates. As an example, this allows you to connect to your Kubernetes cluster API Server through a load balancer instead of a single node. diff --git a/content/rke/v0.1.x/en/config-options/authorization/_index.md b/content/rke/v0.1.x/en/config-options/authorization/_index.md index 886b9712324..1bfd1f16084 100644 --- a/content/rke/v0.1.x/en/config-options/authorization/_index.md +++ b/content/rke/v0.1.x/en/config-options/authorization/_index.md @@ -1,7 +1,6 @@ --- title: Authorization weight: 240 -draft: true --- Kubernetes supports multiple [Authorization Modules](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#authorization-modules). Currently, RKE only supports the [RBAC module](https://kubernetes.io/docs/reference/access-authn-authz/rbac/). diff --git a/content/rke/v0.1.x/en/config-options/bastion-host/_index.md b/content/rke/v0.1.x/en/config-options/bastion-host/_index.md index 6a90b00114a..574e0d20cb2 100644 --- a/content/rke/v0.1.x/en/config-options/bastion-host/_index.md +++ b/content/rke/v0.1.x/en/config-options/bastion-host/_index.md @@ -1,7 +1,6 @@ --- title: Bastion/Jump Host Configuration weight: 220 -draft: true --- Since RKE uses `ssh` to connect to [nodes]({{< baseurl >}}/rke/v0.1.x/en/config-options/nodes/), you can configure to use a bastion host. diff --git a/content/rke/v0.1.x/en/config-options/cloud-providers/_index.md b/content/rke/v0.1.x/en/config-options/cloud-providers/_index.md index 85ebb42f31c..ed5c74546ee 100644 --- a/content/rke/v0.1.x/en/config-options/cloud-providers/_index.md +++ b/content/rke/v0.1.x/en/config-options/cloud-providers/_index.md @@ -1,7 +1,6 @@ --- title: Cloud Providers weight: 245 -draft: true --- RKE supports the ability to set your specific [cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/) for your Kubernetes cluster. There are specific cloud configurations for these cloud providers: diff --git a/content/rke/v0.1.x/en/config-options/example-yamls/_index.md b/content/rke/v0.1.x/en/config-options/example-yamls/_index.md index e5c174b4de0..9fb05a317bb 100644 --- a/content/rke/v0.1.x/en/config-options/example-yamls/_index.md +++ b/content/rke/v0.1.x/en/config-options/example-yamls/_index.md @@ -1,7 +1,6 @@ --- title: Example Cluster.ymls weight: 205 -draft: true --- There are lots of different config options that can be set in the cluster configuration file for RKE. Here are some examples of files: diff --git a/content/rke/v0.1.x/en/config-options/nodes/_index.md b/content/rke/v0.1.x/en/config-options/nodes/_index.md index 5349a834833..993e0c1f7dd 100644 --- a/content/rke/v0.1.x/en/config-options/nodes/_index.md +++ b/content/rke/v0.1.x/en/config-options/nodes/_index.md @@ -1,7 +1,6 @@ --- title: Nodes weight: 210 -draft: true --- The `nodes` directive is the only required section in the `cluster.yml` file. It's used by RKE to specify cluster node(s), ssh credentials used to access the node(s) and which roles these nodes will be in the Kubernetes cluster. diff --git a/content/rke/v0.1.x/en/config-options/private-registries/_index.md b/content/rke/v0.1.x/en/config-options/private-registries/_index.md index 773c61be2cf..05a50dc2d77 100644 --- a/content/rke/v0.1.x/en/config-options/private-registries/_index.md +++ b/content/rke/v0.1.x/en/config-options/private-registries/_index.md @@ -1,7 +1,6 @@ --- title: Private Registries weight: 215 -draft: true --- RKE supports the ability to configure multiple private Docker registries. By passing in your registry and credentials, it allows the nodes to pull images from these private registries. diff --git a/content/rke/v0.1.x/en/config-options/services/_index.md b/content/rke/v0.1.x/en/config-options/services/_index.md index e8eebf7f0cc..905fcecc263 100644 --- a/content/rke/v0.1.x/en/config-options/services/_index.md +++ b/content/rke/v0.1.x/en/config-options/services/_index.md @@ -1,7 +1,6 @@ --- title: Kubernetes Default Services weight: 230 -draft: true --- To deploy Kubernetes, RKE deploys several core components or services in Docker containers on the nodes. Based on the roles of the node, the containers deployed may be different. diff --git a/content/rke/v0.1.x/en/config-options/services/external-etcd/_index.md b/content/rke/v0.1.x/en/config-options/services/external-etcd/_index.md index fb906c62005..aa7280eb3ca 100644 --- a/content/rke/v0.1.x/en/config-options/services/external-etcd/_index.md +++ b/content/rke/v0.1.x/en/config-options/services/external-etcd/_index.md @@ -1,7 +1,6 @@ --- title: External etcd weight: 232 -draft: true --- By default, RKE will launch etcd servers, but RKE also supports being able to use an external etcd. RKE only supports connecting to a TLS enabled etcd setup. diff --git a/content/rke/v0.1.x/en/config-options/services/services-extras/_index.md b/content/rke/v0.1.x/en/config-options/services/services-extras/_index.md index 83aba2af2c5..867d6a98fa2 100644 --- a/content/rke/v0.1.x/en/config-options/services/services-extras/_index.md +++ b/content/rke/v0.1.x/en/config-options/services/services-extras/_index.md @@ -1,7 +1,6 @@ --- title: Extra Args, Extra Binds, and Extra Environment Variables weight: 231 -draft: true --- RKE supports additional service arguments, volume binds and environment variables. diff --git a/content/rke/v0.1.x/en/config-options/system-images/_index.md b/content/rke/v0.1.x/en/config-options/system-images/_index.md index e26261fa7b7..4afe7a91792 100644 --- a/content/rke/v0.1.x/en/config-options/system-images/_index.md +++ b/content/rke/v0.1.x/en/config-options/system-images/_index.md @@ -1,7 +1,6 @@ --- title: System Images weight: 225 -draft: true --- When RKE is deploying Kubernetes, there are several images that are pulled. These images are used as Kubernetes system components as well as helping to deploy these system components. diff --git a/content/rke/v0.1.x/en/installation/_index.md b/content/rke/v0.1.x/en/installation/_index.md index 681ac5b2df4..4ee8b65087d 100644 --- a/content/rke/v0.1.x/en/installation/_index.md +++ b/content/rke/v0.1.x/en/installation/_index.md @@ -1,7 +1,6 @@ --- title: Installation weight: 50 -draft: true --- RKE is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. You can get started in a couple of quick and easy steps: diff --git a/content/rke/v0.1.x/en/installation/etcd-snapshots/_index.md b/content/rke/v0.1.x/en/installation/etcd-snapshots/_index.md index 493b18cacd6..f0c697028bc 100644 --- a/content/rke/v0.1.x/en/installation/etcd-snapshots/_index.md +++ b/content/rke/v0.1.x/en/installation/etcd-snapshots/_index.md @@ -1,7 +1,6 @@ --- title: Backups and Disaster Recovery weight: 65 -draft: true --- As of v0.1.7, you can configure a RKE cluster to automatically take snapshots of etcd. In a disaster scenario, you can restore these snapshots, which are stored on other nodes in the cluster. diff --git a/content/rke/v0.1.x/en/installation/managing-clusters/_index.md b/content/rke/v0.1.x/en/installation/managing-clusters/_index.md index a06008de29c..314e610ba24 100644 --- a/content/rke/v0.1.x/en/installation/managing-clusters/_index.md +++ b/content/rke/v0.1.x/en/installation/managing-clusters/_index.md @@ -1,7 +1,6 @@ --- title: Managing RKE Clusters weight: 60 -draft: true --- ### Adding/Removing Nodes diff --git a/content/rke/v0.1.x/en/installation/os/_index.md b/content/rke/v0.1.x/en/installation/os/_index.md index d06b7f1d36d..6c9af64ac81 100644 --- a/content/rke/v0.1.x/en/installation/os/_index.md +++ b/content/rke/v0.1.x/en/installation/os/_index.md @@ -1,7 +1,6 @@ --- title: Operating System Requirements weight: 55 -draft: true --- RKE runs on almost any Linux OS with Docker installed. Most of the development and testing of RKE occurred on Ubuntu 16.04. However, some OS's have restrictions and specific requirements. diff --git a/content/rke/v0.1.x/en/quick-start-guide/_index.md b/content/rke/v0.1.x/en/quick-start-guide/_index.md new file mode 100644 index 00000000000..70cc961becd --- /dev/null +++ b/content/rke/v0.1.x/en/quick-start-guide/_index.md @@ -0,0 +1,188 @@ +--- +title: Quick Start Guide +short title: Quick Start +weight: 25 +--- + +RKE is a fast, versatile Kubernetes installer that you can use to install Kubernetes on your Linux hosts. You can get started in a couple of quick and easy steps: + +1. [Download the RKE Binary](#download-the-rke-bindary) +2. [Prepare the Nodes for the Kubernetes Cluster](#prepare-the-nodes-for-the-kubernetes-cluster) +3. [Creating the Cluster Configuration File](#creating-the-cluster-configuration-file) +4. [Deploying Kubernetes with RKE](#deploying-kubernetes-with-rke) +5. [Interacting with your Kubernetes Cluster](#interacting-with-your-kubernetes-cluster) + +## Download the RKE binary + +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: + + - **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 [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 + ``` + +3. Confirm that RKE is now executable by running the following command: + + ``` + # MacOS + $ ./rke_darwin-amd64 --version + # Linux + $ ./rke_linux-amd64 --version + ``` + +## Prepare the Nodes for the Kubernetes cluster + +The Kubernetes cluster components are launched using Docker on a Linux machine. You can use any Linux you want, as long as you can install Docker on it. The most commonly used OS is the current Ubuntu LTS release, 16.04. Kubernetes runs integration tests on the following Docker versions: `1.11.2` to `1.13.1`, and `17.03.x`. We follow these tested Docker versions by marking them as supported. + +### Install Docker + +You can either follow the [Docker installation](https://docs.docker.com/install/) instructions or you can use one of Rancher's [install scripts](https://github.com/rancher/install-docker) to install Docker. + +Docker Version | Install Script | +----------|------------------ +1.11.2 | curl https://releases.rancher.com/install-docker/1.11.sh | sh | +1.12.6 | curl https://releases.rancher.com/install-docker/1.12.sh | sh | +1.13.1 | curl https://releases.rancher.com/install-docker/1.13.sh | sh | +17.03.2 | curl https://releases.rancher.com/install-docker/17.03.sh | sh | + +Confirm that a Kubernetes supported version of Docker is installed on your machine, by running `docker version`. + +```bash +$ docker version +Client: + Version: 17.03.2-ce + API version: 1.27 + Go version: go1.7.5 + Git commit: f5ec1e2 + Built: Tue Jun 27 03:35:14 2017 + OS/Arch: linux/amd64 + +Server: + Version: 17.03.2-ce + API version: 1.27 (minimum version 1.12) + Go version: go1.7.5 + Git commit: f5ec1e2 + Built: Tue Jun 27 03:35:14 2017 + OS/Arch: linux/amd64 + Experimental: false +``` + +### Port Requirements + +In order for the Kubernetes cluster to be deployed, port `TCP/6443` needs to be opened to the machine. If you are using an external firewall, make sure you have this port opened between the machine you are using to run `rke` and the machine you are going to use in the cluster. + +#### Opening port TCP/6443 using `iptables`` + +```bash +# Open TCP/6443 for all +iptables -A INPUT -p tcp --dport 6443 -j ACCEPT + +# Open TCP/6443 for one specific IP +iptables -A INPUT -p tcp -s your_ip_here --dport 6443 -j ACCEPT +``` + +#### Opening port TCP/6443 using `firewalld` + +```bash +# Open TCP/6443 for all +firewall-cmd --zone=public --add-port=6443/tcp --permanent +firewall-cmd --reload + +# Open TCP/6443 for one specific IP +firewall-cmd --permanent --zone=public --add-rich-rule=' + rule family="ipv4" + source address="your_ip_here/32" + port protocol="tcp" port="6443" accept' +firewall-cmd --reload +``` + +## Creating the Cluster Configuration File + +RKE uses a cluster configuration file, referred to as `cluster.yml` to determine what nodes will be in the cluster and how to deploy Kubernetes. There are [many configuration options]({{< baseurl >}}/rke/v0.1.x/en/config-options/) that can be set in the `cluster.yml`. In our example, we will be assuming the minimum of one [node]({{< baseurl >}}/rke/v0.1.x/en/config-options/nodes) for your Kubernetes cluster. + +There are two easy ways to create a `cluster.yml`: + +- Using our [minimal `cluster.yml`]({{< baseurl >}}/rke/v0.1.x/en/config-options/example-yamls/#minimal-cluster-yml-example) and updating it based on the node that you will be using. +- Using `rke config` to query for all the information needed. + +### Using `rke config` + +To create a new `cluster.yml`, you can run `rke config` and this command will query 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. The ones that are required for this quick start guide are in the example below. + +> **Note:** As features are added into RKE, the list and order of questions may change. + +```bash +./rke_darwin-amd64 config + +# This example is using one host +[+] Number of Hosts [1]: 1 +# Address where the host is reachable over SSH +[+] SSH Address of host (1) [none]: 10.0.0.1 +# SSH Port to use +[+] SSH Port of host (1) [22]: 22 +[+] SSH Private Key Path of host (10.0.0.1) [none]: ~/.ssh/your_rsa_key +# Username to use for the SSH connection +[+] SSH User of host (10.0.0.1) [ubuntu]: root + +# We'll be configuring all three roles onto this single host +[+] Is host (10.0.0.1) a control host (y/n)? [y]: y +[+] Is host (10.0.0.1) a worker host (y/n)? [n]: y +[+] Is host (10.0.0.1) an Etcd host (y/n)? [n]: y +``` + +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. + +## Deploying Kubernetes with RKE + +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 +``` + +There will be log statements as the Kubernetes cluster is created. + +```bash +$ ./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 +INFO[0000] [network] Pulling image [alpine:latest] on host [10.0.0.1] +... +INFO[0101] Finished building Kubernetes cluster successfully +``` + +The last line should read `Finished building Kubernetes cluster successfully` to indicate that your cluster is ready to use. As part of the Kubernetes creation process, a `kubeconfig` file has been created and written at `kube_config_cluster.yml`, which can be used to start interacting your Kubernetes cluster. + +### Interacting with your Kubernetes cluster + +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. + +```bash +# Confirm that kubectl is working by checking the version of your Kubernetes cluster +$ 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"} +``` + +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 command to your cluster, like requesting the nodes that are in the cluster. + +```bash +$ 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 +``` diff --git a/content/rke/v0.1.x/en/upgrades/_index.md b/content/rke/v0.1.x/en/upgrades/_index.md index c975e1e5279..ca1492fa566 100644 --- a/content/rke/v0.1.x/en/upgrades/_index.md +++ b/content/rke/v0.1.x/en/upgrades/_index.md @@ -1,7 +1,11 @@ --- title: Upgrades +<<<<<<< HEAD:content/rke/v0.1.x/en/upgrades/_index.md weight: 100 draft: true +======= +weight: 70 +>>>>>>> undraft all RKE:content/rke/v0.1.x/en/installation/upgrades/_index.md --- After RKE has deployed Kubernetes, you can upgrade the versions of the components in your Kubernetes cluster, [definition of the Kubernetes services]({{< baseurl >}}/rke/v0.1.x/en/config-options/services/) or [add-ons]({{< baseurl >}}/rke/v0.1.x/en/config-options/add-ons/).