public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-12 12:07:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

updating os requirements and port requirements

Browse Source
This commit is contained in:
Denise Schannon
2018-06-22 21:20:28 -07:00
parent 4dd719208c
commit afdd1c35d8
8 changed files with 147 additions and 315 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/installation/references/_index.md
+2 -1
View File
@@ -11,4 +11,5 @@ The following diagram displays the basic port requirements for Rancher. If you n
![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png)
{{< requirements_ports >}}
{{< requirements_ports_rancher >}}
{{< requirements_ports_rke >}}
content/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-custom/_index.md
+3 -1
View File
@@ -36,7 +36,9 @@ Provision the host according to the requirements below.
{{< requirements_software >}}
{{< requirements_ports >}}
{{< requirements_ports_rancher >}}
{{< requirements_ports_rke >}}
>**Bare-Metal Server Note:**
>
content/rke/v0.1.x/en/installation/_index.md
+10 -82
View File
@@ -4,8 +4,6 @@ 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:
1. [Download the RKE Binary](#download-the-rke-bindary)
@@ -14,19 +12,6 @@ RKE is a fast, versatile Kubernetes installer that you can use to install Kubern
4. [Deploying Kubernetes with RKE](#deploying-kubernetes-with-rke)
5. [Interacting with your Kubernetes Cluster](#interacting-with-your-kubernetes-cluster)
## Requirements
- For Kubernetes versions 1.8, 1.9 and 1.10, Docker versions `1.11.2` up to `1.13.1` and `17.03.x` are validated
- OpenSSH 7.0+ must be installed on each node for stream local forwarding to work
- The SSH user used for node access must be a member of the `docker` group on the node:
```
usermod -aG docker <user_name>
```
- Ports 6443, 2379, and 2380 should be opened between cluster nodes.
- Swap should be disabled on any worker nodes
## 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:
@@ -58,72 +43,9 @@ RKE is a fast, versatile Kubernetes installer that you can use to install Kubern
## 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.
The Kubernetes cluster components are launched using Docker on a Linux distro. You can use any Linux you want, as long as you can install Docker on it.
### 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 | <code>curl https://releases.rancher.com/install-docker/1.11.sh &#124; sh</code> |
1.12.6 | <code>curl https://releases.rancher.com/install-docker/1.12.sh &#124; sh</code> |
1.13.1 | <code>curl https://releases.rancher.com/install-docker/1.13.sh &#124; sh</code> |
17.03.2 | <code>curl https://releases.rancher.com/install-docker/17.03.sh &#124; sh</code> |
Confirm that a Kubernetes supported version of Docker is installed on your machine, by running `docker version`.
```
$ 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.
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``
```
# 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`
```
# 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
```
Review the [OS requirements]({{< baseurl >}}/rke/v0.1.x/en/installation/os/) and configure each node appropriately.
## Creating the Cluster Configuration File
@@ -136,7 +58,13 @@ There are two easy ways to create a `cluster.yml`:
### Using `rke config`
RKE provides the command `rke config` to generate a cluster configuration template or to interactivity generate a working cluster configuration file. Review [our cluster configuration options]({{< baseurl >}}/rke/v0.1.x/en/config-options/) to understand what each question means.
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.
```
./rke_darwin-amd64 config
```
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`
```
@@ -203,7 +131,7 @@ Client Version: version.Info{Major:"1", Minor:"10", GitVersion:"v1.10.0", GitCom
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.
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
content/rke/v0.1.x/en/installation/os/_index.md
+77 -10
View File
@@ -1,28 +1,95 @@
---
title: Operating System Notes
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.
### OS Requirements
- For Kubernetes versions 1.8, 1.9 and 1.10, Docker versions `1.11.2` up to `1.13.1` and `17.03.x` are validated
- OpenSSH 7.0+ must be installed on each node for stream local forwarding to work
- The SSH user used for node access must be a member of the `docker` group on the node:
- [SSH user]({{< baseurl >}}/rke/v0.1.x/en/config-options/nodes/#ssh-user) - The SSH user used for node access must be a member of the `docker` group on the node:
```
usermod -aG docker <user_name>
```
- Ports 6443, 2379, and 2380 should be opened between cluster nodes.
- Swap should be disabled on any worker nodes
### Software
## Atomic Hosts
- Docker - Each Kubernetes version supports different Docker versions.
Before trying to use RKE with Atomic hosts, there are a couple of updates to the OS that need to occur in order to get RKE working.
Kubernetes Version | Docker 1.12.6 | Docker 1.13.1 | Docker 17.03.2 |
----|----|----|----|
v1.10.x | X | X | X |
v1.9.x | X | X | X |
v1.8.x | X | X | X |
You can either follow the [Docker installation](https://docs.docker.com/install/) instructions or use one of Rancher's [install scripts](https://github.com/rancher/install-docker) to install Docker.
Docker Version | Install Script |
----------|------------------
17.03.2 | <code>curl https://releases.rancher.com/install-docker/17.03.sh &#124; sh</code> |
1.13.1 | <code>curl https://releases.rancher.com/install-docker/1.13.sh &#124; sh</code> |
1.12.6 | <code>curl https://releases.rancher.com/install-docker/1.12.sh &#124; sh</code> |
Confirm that a Kubernetes supported version of Docker is installed on your machine, by running `docker version`.
```
$ 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
```
- OpenSSH 7.0+ - In order to SSH into each node, OpenSSH must be installed on each node.
### Ports
{{< requirements_ports_rke >}}
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 nodes that you are going to use in the cluster.
#### Opening port TCP/6443 using `iptables``
```
# 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`
```
# 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
```
## Notes about Atomic Nodes
Before trying to use RKE with Atomic nodes, there are a couple of updates to the OS that need to occur in order to get RKE working.
### Container Volumes
content/rke/v0.1.x/en/quick-start-guide/_index.md
-170
View File
@@ -1,170 +0,0 @@
---
title: Quick Start Guide
short title: Quick Start
weight: 25
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:
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 distro. You can use any Linux you want, as long as you can install Docker on it.
As Kubernetes only supports Docker `1.11.2` to `1.13.1`, and `17.03.x`, RKE also supports the same Docker versions.
### Install Docker
You can either follow the [Docker installation](https://docs.docker.com/install/) instructions or use one of Rancher's [install scripts](https://github.com/rancher/install-docker) to install Docker.
Docker Version | Install Script |
----------|------------------
1.11.2 | <code>curl https://releases.rancher.com/install-docker/1.11.sh &#124; sh</code> |
1.12.6 | <code>curl https://releases.rancher.com/install-docker/1.12.sh &#124; sh</code> |
1.13.1 | <code>curl https://releases.rancher.com/install-docker/1.13.sh &#124; sh</code> |
17.03.2 | <code>curl https://releases.rancher.com/install-docker/17.03.sh &#124; sh</code> |
Confirm that a Kubernetes supported version of Docker is installed on your machine, by running `docker version`.
```
$ 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, the follow ports need to be opened to allow the cluster nodes communicate with each other:
- Ports 6443, 2379, and 2380
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.
## 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 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. 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.
```
./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.
```
$ ./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.
```
# 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 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
NAME STATUS ROLES AGE VERSION
10.0.0.1 Ready controlplane,etcd,worker 35m v1.10.3-rancher1
```
content/rke/v0.1.x/en/installation/upgrades/_index.md → content/rke/v0.1.x/en/upgrades/_index.md
+1 -1
View File
@@ -1,6 +1,6 @@
---
title: Upgrades
weight: 70
weight: 100
draft: true
---
layouts/shortcodes/requirements_ports_rancher.html
+53
View File
@@ -0,0 +1,53 @@
<div>
<p><strong>Rancher nodes:</strong><br/>Nodes running the <code>rancher/rancher</code> container</p>
<h6>Rancher nodes - Inbound rules</h6>
<table>
<tr>
<th>Protocol</th>
<th>Port</th>
<th align="left">Source</th>
<th align="left">Description</th>
</tr>
<tr>
<td>TCP</td>
<td>80</td>
<td><ul><li>Load balancer/proxy that does external SSL termination</li></ul></td>
<td>Rancher UI/API when external SSL termination is used</td>
</tr>
<tr>
<td>TCP</td>
<td>443</td>
<td><ul><li>etcd nodes</li><li>controlplane nodes</li><li>worker nodes</li><li>Hosted/Imported Kubernetes</li><li>any that needs to be able to use UI/API</li></ul></td>
<td>Rancher agent, Rancher UI/API, kubectl</td>
</tr>
</table>
<h6>Rancher nodes - Outbound rules</h6>
<table>
<tr>
<th>Protocol</th>
<th>Port</th>
<th align="left">Destination</th>
<th align="left">Description</th>
</tr>
<tr>
<td>TCP</td>
<td>22</td>
<td><ul><li>Any node IP from a node created using Node Driver</li></td>
<td>SSH provisioning of nodes using Node Driver</td>
</tr>
<tr>
<td>TCP</td>
<td>443</td>
<td><ul><li>35.160.43.145/32</li><li>35.167.242.46/32</li><li>52.33.59.17/32</li></td>
<td>git.rancher.io (catalogs)</td>
</tr>
<tr>
<td>TCP</td>
<td>6443</td>
<td><ul><li>Hosted/Imported Kubernetes API</li></td>
<td>Kubernetes apiserver</td>
</tr>
</table>
<br/>
</div>
layouts/shortcodes/requirements_ports.html → layouts/shortcodes/requirements_ports_rke.html
+1 -50
View File
@@ -1,53 +1,4 @@
<div>
<p><strong>Rancher nodes:</strong><br/>Nodes running the <code>rancher/rancher</code> container</p>
<h6>Rancher nodes - Inbound rules</h6>
<table>
<tr>
<th>Protocol</th>
<th>Port</th>
<th align="left">Source</th>
<th align="left">Description</th>
</tr>
<tr>
<td>TCP</td>
<td>80</td>
<td><ul><li>Load balancer/proxy that does external SSL termination</li></ul></td>
<td>Rancher UI/API when external SSL termination is used</td>
</tr>
<tr>
<td>TCP</td>
<td>443</td>
<td><ul><li>etcd nodes</li><li>controlplane nodes</li><li>worker nodes</li><li>Hosted/Imported Kubernetes</li><li>any that needs to be able to use UI/API</li></ul></td>
<td>Rancher agent, Rancher UI/API, kubectl</td>
</tr>
</table>
<h6>Rancher nodes - Outbound rules</h6>
<table>
<tr>
<th>Protocol</th>
<th>Port</th>
<th align="left">Destination</th>
<th align="left">Description</th>
</tr>
<tr>
<td>TCP</td>
<td>22</td>
<td><ul><li>Any node IP from a node created using Node Driver</li></td>
<td>SSH provisioning of nodes using Node Driver</td>
</tr>
<tr>
<td>TCP</td>
<td>443</td>
<td><ul><li>35.160.43.145/32</li><li>35.167.242.46/32</li><li>52.33.59.17/32</li></td>
<td>git.rancher.io (catalogs)</td>
</tr>
<tr>
<td>TCP</td>
<td>6443</td>
<td><ul><li>Hosted/Imported Kubernetes API</li></td>
<td>Kubernetes apiserver</td>
</tr>
</table>
<div>
<p><strong>etcd nodes:</strong><br/>Nodes with the role <strong>etcd</strong></p>
<h6>etcd nodes - Inbound rules</h6>
<table>