From 7242171deefbff84d9e27124e961dea0b3ab89e4 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 29 Aug 2018 16:35:48 -0700 Subject: [PATCH 1/2] adding new requirements topic and linking to it in single node installs. --- .../en/installation/requirements/_index.md | 72 +++++++++++++++++++ .../en/installation/single-node/_index.md | 23 +----- .../single-node-install-external-lb/_index.md | 22 +----- 3 files changed, 74 insertions(+), 43 deletions(-) create mode 100644 content/rancher/v2.x/en/installation/requirements/_index.md diff --git a/content/rancher/v2.x/en/installation/requirements/_index.md b/content/rancher/v2.x/en/installation/requirements/_index.md new file mode 100644 index 00000000000..29283735acf --- /dev/null +++ b/content/rancher/v2.x/en/installation/requirements/_index.md @@ -0,0 +1,72 @@ +--- +title: Requirements +weight: 1 +aliases: +--- + +Whether you're configuring Rancher to run in a single-node or high-availability setup, each node running Rancher Server must meet the following requirements. + +{{% tabs %}} +{{% tab "Operating Systems" %}} +Rancher is supported on the following operating systems and their subsequent releases. + +* Ubuntu 16.04 (64-bit) +* Red Hat Enterprise Linux 7.5 (64-bit) +* RancherOS 1.4 (64-bit) +{{% /tab %}} +{{% tab "Hardware" %}} +Hardware requirements scale based on the size of your Rancher deployment. Provision each individual node according to the requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Deployment SizeClustersNodesvCPUsRAM
SmallUp to 10Up to 5024GB
MediumUp to 100Up to 500832GB
LargeOver 100Over 500Contact Rancher
+
+ +{{% /tab %}} +{{% tab "Software" %}} +A supported version of [Docker](https://www.docker.com/) is required. + +Supported Versions: + +* `1.12.6` +* `1.13.1` +* `17.03.2` + +[Docker Documentation: Installation Instructions](https://docs.docker.com/) +{{% /tab %}} +{{% tab "Ports" %}} +The following diagram depicts the basic port requirements for Rancher. + +![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png) + +{{< requirements_ports_rancher >}} +{{< requirements_ports_rke >}} +{{< ports_aws_securitygroup_nodedriver >}} +{{% /tab %}} +{{% /tabs %}} \ No newline at end of file diff --git a/content/rancher/v2.x/en/installation/single-node/_index.md b/content/rancher/v2.x/en/installation/single-node/_index.md index 7be8f6043eb..6a578ecd16e 100644 --- a/content/rancher/v2.x/en/installation/single-node/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/_index.md @@ -12,28 +12,7 @@ For development environments, we recommend installing Rancher by running a singl ## 1. Provision Linux Host -Provision a single Linux host to launch your Rancher Server. - -### Requirements - -{{% tabs %}} -{{% tab "Operating Systems" %}} -{{< requirements_os >}} -{{% /tab %}} -{{% tab "Hardware" %}} -{{< requirements_hardware >}} -{{% /tab %}} -{{% tab "Software" %}} -{{< requirements_software >}} -{{< note_server-tags >}} -{{% /tab %}} -{{% tab "Ports" %}} -The following diagram depicts the basic port requirements for Rancher. For a comprehensive list, see [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/). - -![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png) -{{% /tab %}} -{{% /tabs %}} - +Provision a single Linux host according to our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements) to launch your {{< product >}} Server. ## 2. Choose an SSL Option and Install Rancher diff --git a/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md index 74ac5e7df34..3f1698f7f7f 100644 --- a/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md @@ -21,27 +21,7 @@ For development environments, we recommend installing Rancher by running a singl ## 1. Provision Linux Host -Provision a single Linux host to launch your {{< product >}} Server. - -### Host Requirements - -{{% tabs %}} -{{% tab "Operating System" %}} -{{< requirements_os >}} -{{% /tab %}} -{{% tab "Hardware" %}} -{{< requirements_hardware >}} -{{% /tab %}} -{{% tab "Software" %}} -{{< requirements_software >}} -{{< note_server-tags >}} -{{% /tab %}} -{{% tab "Ports" %}} -The following diagram depicts the basic port requirements for Rancher. For a comprehensive list, see [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/). - -![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png) -{{% /tab %}} -{{% /tabs %}} +Provision a single Linux host according to our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements) to launch your {{< product >}} Server. ## 2. Choose an SSL Option and Install Rancher From 377832bb30e4efbc99856f65a40fd0cbbd5cd64f Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 29 Aug 2018 17:02:29 -0700 Subject: [PATCH 2/2] adding requirements link to ha setups and cluster setups --- .../rke-clusters/_index.md | 18 +------------- .../rke-clusters/custom-nodes/_index.md | 17 +------------ .../installation/ha/create-nodes-lb/_index.md | 22 +---------------- .../ha/rke-add-on/layer-4-lb/_index.md | 24 +------------------ .../ha/rke-add-on/layer-7-lb/_index.md | 24 +------------------ .../quickstart-manual-setup/_index.md | 23 +----------------- 6 files changed, 6 insertions(+), 122 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/_index.md index 47515a3d332..d5f24679f95 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/_index.md @@ -23,20 +23,4 @@ RKE launched clusters are separated into two categories: ### Requirements -If you use RKE to set up a cluster, your cluster nodes must meet the following requirements. - -{{< accordion id="os" label="Operating System" >}} - {{< requirements_os >}} -{{< /accordion >}} -{{< accordion id="hardware" label="Hardware" >}} - {{< requirements_hardware >}} -{{< /accordion >}} -{{< accordion id="software" label="Software" >}} - {{< requirements_software >}} -{{< /accordion >}} -{{< accordion id="ports-rancher" label="Ports for Rancher" >}} - {{< requirements_ports_rancher >}} -{{< /accordion >}} -{{< accordion id="ports-rke" label="Ports for RKE" >}} - {{< requirements_ports_rke >}} -{{< /accordion >}} \ No newline at end of file +If you use RKE to set up a cluster, your cluster nodes must meet our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). \ No newline at end of file diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md index d8d02e2aa06..dd27877c907 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md @@ -42,22 +42,7 @@ Provision the host according to the requirements below. ### Requirements -{{< accordion id="os" label="Operating System" >}} - {{< requirements_os >}} -{{< /accordion >}} -{{< accordion id="hardware" label="Hardware" >}} - {{< requirements_hardware >}} -{{< /accordion >}} -{{< accordion id="software" label="Software" >}} - {{< requirements_software >}} -{{< /accordion >}} -{{< accordion id="ports-rancher" label="Ports for Rancher" >}} - {{< requirements_ports_rancher >}} -{{< /accordion >}} -{{< accordion id="ports-rke" label="Ports for RKE" >}} - {{< requirements_ports_rke >}} -{{< /accordion >}} - +Each node in your cluster must meet our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). ## Create the Custom Cluster diff --git a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md index 1a00ac78b24..bec3e28dd4c 100644 --- a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md @@ -11,27 +11,7 @@ Use your provider of choice to provision 3 nodes and a Load Balancer endpoint fo ### Host Requirements -#### Operating System - -{{< requirements_os >}}
- -#### Nodes - -{{< requirements_hardware >}}
- -#### Software - -{{< requirements_software >}} - -{{< note_server-tags >}} - -#### Ports - -{{< requirements_ports_rancher_rke >}} - -
- -If you block ports internally on the nodes see the full [ports list]({{< baseurl >}}/rancher/v2.x/en/installation/references/) for all the communication details. +View the requirements for nodes hosting Rancher at [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). ### Load Balancer 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 86685653fde..3c5510aa0e7 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 @@ -36,29 +36,7 @@ Installation of Rancher in a high-availability configuration involves multiple p ## 1. Provision Linux Hosts -Before you install Rancher, confirm you meet the host requirements. Provision 3 new Linux hosts using the requirements below. - -### Host Requirements - -#### Operating System - -{{< requirements_os >}} - -#### Hardware - -{{< requirements_hardware >}} - -#### Software - -{{< requirements_software >}} - -{{< note_server-tags >}} - -#### Ports - -The following diagram depicts the basic port requirements for Rancher. For a comprehensive list, see [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/). - -![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png) +Provision three Linux hosts according to our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). ## 2. Configure Load Balancer 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 94a0fd7a989..85cc8646cdb 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 @@ -66,29 +66,7 @@ Installation of Rancher in a high-availability configuration involves multiple p
## 1. Provision Linux Hosts -Before you install Rancher, confirm you meet the host requirements. Provision 3 new Linux hosts using the requirements below. - -### Requirements - -#### Operating System - -{{< requirements_os >}} - -#### Hardware - -{{< requirements_hardware >}} - -#### Software - -{{< requirements_software >}} - -{{< note_server-tags >}} - -#### Ports - -The following diagram depicts the basic port requirements for Rancher. For a comprehensive list, see [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/). - -![Basic Port Requirements]({{< baseurl >}}/img/rancher/port-communications.png) +Provision three Linux hosts according to our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements). ## 2. Configure Load Balancer diff --git a/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md b/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md index d46f7938548..2d4a3a0b82a 100644 --- a/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md +++ b/content/rancher/v2.x/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md @@ -38,29 +38,8 @@ This Quick Start Guide is divided into different tasks for easier consumption. > > For a full list of port requirements, refer to [Single Node Installation]({{< baseurl >}}/rancher/v2.x/en/installation/references). - Provision the host according to the requirements below. + Provision the host according to our [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements/). -{{% accordion id="os" label="Operating System" %}} -{{< requirements_os >}} -{{% /accordion %}} -{{% accordion id="hardware" label="Hardware" %}} -Memory: 4GB -{{% /accordion %}} -{{% accordion id="software" label="Software" %}} -Docker - - **Supported Docker versions:** - - - `1.12.6` - - `1.13.1` - - `17.03.2` - - >**Notes:** - > - > - For Docker installation instructions, visit their [documentation](https://docs.docker.com/install/). - > - Docker requirements apply to both your Linux host and your cluster nodes. -{{% /accordion %}} -
### 2. Install Rancher To install Rancher on your host, connect to it and then use a shell to install.