From 2024e132b7f4111de03619cb1c5e4848df5c9d7a Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 14:45:24 -0700 Subject: [PATCH 1/7] adding high-level description of cluster options --- .../rke-clusters/options/_index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 8dbef6dea51..d24363a15a8 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -2,3 +2,14 @@ title: Cluster Options weight: 2250 --- + +As you configure a new cluster that's provisioned using RKE, you can can choose custom Kubernetes (K8s) options. + +You can configure K8s options one of two ways: + +- [Rancher UI](#rancher-ui): Use the Rancher UI to select options that are commonly customized when setting up a K8s cluster. +- [Config File](#config-file): Alternatively, you can create a RKE config file to customize any option offered by K8s. + +## Rancher UI + +## Config File \ No newline at end of file From 6f59a75556d5d1836ca5be1d7f8938f55612de81 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 16:06:28 -0700 Subject: [PATCH 2/7] adding cluster option docs --- .../rke-clusters/options/_index.md | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index d24363a15a8..05178979e67 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -12,4 +12,31 @@ You can configure K8s options one of two ways: ## Rancher UI -## Config File \ No newline at end of file +When creating a cluster using one of the options described in [Rancher Launched Kubenernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), you can configure basic K8s options using the **Cluster Options** section. + +From this section allows you choose: + +- The version of Kubernetes installed on your cluster nodes. Rancher uses its own version of Kubernetes based on [hyperkube](https://hub.docker.com/r/kubernetesonarm/hyperkube/), but packaged with more utilities. + +- Whether your nodes allow installation of an unsupported version of Docker (i.e., a version not listed in the Rancher requirements). + +- The Network Provider that the cluster uses. Out of the box, Rancher supports: + + - Flannel + + - Calico + + - Canal (default) + +- Whether or not to use a cloud provider. + +- Whether or not to use a pod security policy. You must have an existing pod security policy configured before you can use this option. + +## Config File + +Instead of using the Rancher UI to choose K8s options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the options available in an RKE installation. + +- To edit an RKE config file directly from the Rancher UI, click **Edit as YAML**. +- To read from an existing RKE file, click **Read from File**. + +For an example of RKE config file syntax, see the RKE documentation. \ No newline at end of file From 6e2049b568e3abb6938eb867b0f896f1612a935b Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 16:11:58 -0700 Subject: [PATCH 3/7] fixing typos --- .../en/cluster-provisioning/rke-clusters/options/_index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 05178979e67..255da8a95da 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -3,7 +3,7 @@ title: Cluster Options weight: 2250 --- -As you configure a new cluster that's provisioned using RKE, you can can choose custom Kubernetes (K8s) options. +As you configure a new cluster that's provisioned using RKE, you can choose custom Kubernetes (K8s) options. You can configure K8s options one of two ways: @@ -12,9 +12,9 @@ You can configure K8s options one of two ways: ## Rancher UI -When creating a cluster using one of the options described in [Rancher Launched Kubenernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), you can configure basic K8s options using the **Cluster Options** section. +When creating a cluster using one of the options described in [Rancher Launched Kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), you can configure basic K8s options using the **Cluster Options** section. -From this section allows you choose: +From this section you can choose: - The version of Kubernetes installed on your cluster nodes. Rancher uses its own version of Kubernetes based on [hyperkube](https://hub.docker.com/r/kubernetesonarm/hyperkube/), but packaged with more utilities. From 6469d454fcecef2aaf770b78032b79ad293f0048 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 18:04:29 -0700 Subject: [PATCH 4/7] replaced instances of K8s --- .../rke-clusters/options/_index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 255da8a95da..39acbd54821 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -3,16 +3,16 @@ title: Cluster Options weight: 2250 --- -As you configure a new cluster that's provisioned using RKE, you can choose custom Kubernetes (K8s) options. +As you configure a new cluster that's provisioned using RKE, you can choose custom Kubernetes options. -You can configure K8s options one of two ways: +You can configure Kubernetes options one of two ways: -- [Rancher UI](#rancher-ui): Use the Rancher UI to select options that are commonly customized when setting up a K8s cluster. -- [Config File](#config-file): Alternatively, you can create a RKE config file to customize any option offered by K8s. +- [Rancher UI](#rancher-ui): Use the Rancher UI to select options that are commonly customized when setting up a Kubernetes cluster. +- [Config File](#config-file): Alternatively, you can create a RKE config file to customize any option offered by Kubernetes. ## Rancher UI -When creating a cluster using one of the options described in [Rancher Launched Kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), you can configure basic K8s options using the **Cluster Options** section. +When creating a cluster using one of the options described in [Rancher Launched Kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters), you can configure basic Kubernetes options using the **Cluster Options** section. From this section you can choose: @@ -34,7 +34,7 @@ From this section you can choose: ## Config File -Instead of using the Rancher UI to choose K8s options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the options available in an RKE installation. +Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the options available in an RKE installation. - To edit an RKE config file directly from the Rancher UI, click **Edit as YAML**. - To read from an existing RKE file, click **Read from File**. From 4a11399bbb0cba85a01e7633433604be6be78a55 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 18:12:41 -0700 Subject: [PATCH 5/7] added new links and fixed existing links --- .../rke-clusters/options/_index.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 39acbd54821..85e191c0231 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -3,12 +3,12 @@ title: Cluster Options weight: 2250 --- -As you configure a new cluster that's provisioned using RKE, you can choose custom Kubernetes options. +As you configure a new cluster that's provisioned using [RKE]({{< baseurl >}}/rke/v0.1.x/en/), you can choose custom Kubernetes options. You can configure Kubernetes options one of two ways: - [Rancher UI](#rancher-ui): Use the Rancher UI to select options that are commonly customized when setting up a Kubernetes cluster. -- [Config File](#config-file): Alternatively, you can create a RKE config file to customize any option offered by Kubernetes. +- [Config File](#config-file): Alternatively, you can create a [RKE config file]({{< baseurl >}}/rke/v0.1.x/en/config-options/) to customize any option offered by Kubernetes. ## Rancher UI @@ -20,23 +20,24 @@ From this section you can choose: - Whether your nodes allow installation of an unsupported version of Docker (i.e., a version not listed in the Rancher requirements). -- The Network Provider that the cluster uses. Out of the box, Rancher supports: +- The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. Out of the box, Rancher supports: - - Flannel + - [Flannel](https://github.com/coreos/flannel#flannel) - - Calico + - [Calico](https://docs.projectcalico.org/v3.1/introduction/) - - Canal (default) + - [Canal] (https://github.com/projectcalico/canal) (default) -- Whether or not to use a cloud provider. + +- Whether or not to use a [cloud provider]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/cloud-providers). -- Whether or not to use a pod security policy. You must have an existing pod security policy configured before you can use this option. +- Whether or not to use a [pod security policy]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies). You must have an existing pod security policy configured before you can use this option. ## Config File -Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the options available in an RKE installation. +Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the [options available]({{< baseurl >}}/rke/v0.1.x/en/config-options/) in an RKE installation. - To edit an RKE config file directly from the Rancher UI, click **Edit as YAML**. - To read from an existing RKE file, click **Read from File**. -For an example of RKE config file syntax, see the RKE documentation. \ No newline at end of file +For an example of RKE config file syntax, see the [RKE documentation]({{< baseurl >}}/rke/v0.1.x/en/example-yamls/). \ No newline at end of file From 283f939bcd21700782b164df164bf59c000647c6 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 18 Jul 2018 18:22:23 -0700 Subject: [PATCH 6/7] updating bullet for docker supported version check --- .../v2.x/en/cluster-provisioning/rke-clusters/options/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index 85e191c0231..f8448abc3ca 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -18,7 +18,7 @@ From this section you can choose: - The version of Kubernetes installed on your cluster nodes. Rancher uses its own version of Kubernetes based on [hyperkube](https://hub.docker.com/r/kubernetesonarm/hyperkube/), but packaged with more utilities. -- Whether your nodes allow installation of an unsupported version of Docker (i.e., a version not listed in the Rancher requirements). +- Whether Rancher should check if the nodes are running a supported or unsupported version of Docker. If you only allow supported versions, the cluster automatically fails to launch. - The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. Out of the box, Rancher supports: From 6f266567d20e095737efee694849ab447ce211e5 Mon Sep 17 00:00:00 2001 From: Denise Date: Wed, 18 Jul 2018 20:48:26 -0700 Subject: [PATCH 7/7] Update _index.md --- .../rke-clusters/options/_index.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md index f8448abc3ca..237595ef51c 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/_index.md @@ -18,18 +18,20 @@ From this section you can choose: - The version of Kubernetes installed on your cluster nodes. Rancher uses its own version of Kubernetes based on [hyperkube](https://hub.docker.com/r/kubernetesonarm/hyperkube/), but packaged with more utilities. -- Whether Rancher should check if the nodes are running a supported or unsupported version of Docker. If you only allow supported versions, the cluster automatically fails to launch. +- Whether Rancher should check if the nodes are running a supported or unsupported version of Docker. If you only allow supported versions, the cluster automatically fails to launch if you have an unsupported version of Docker. Each Kubernetes version is tied to specific Docker versions based on what Kubernetes tests against. - The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. Out of the box, Rancher supports: - - [Flannel](https://github.com/coreos/flannel#flannel) + - **[Canal](https://github.com/projectcalico/canal)**: In v2.0.0 - v2.0.4 and v2.0.6, this was the default option for these clusters was Canal with network isolation. With the network isolation automatically enabled, it prevented any pod communication between [projects]({{< baseurl >}}/rancher/v2.x/en/kubernetes-in-rancher/projects-and-namespaces/). - - [Calico](https://docs.projectcalico.org/v3.1/introduction/) + - **[Flannel](https://github.com/coreos/flannel#flannel)**: In v2.0.5, this was the default option, which did not prevent any network isolation between projects. - - [Canal] (https://github.com/projectcalico/canal) (default) + - **[Calico](https://docs.projectcalico.org/v3.1/introduction/)** + > **Note:** Please carefully select which network provider you want to use as Kubernetes doesn't allow switching between network providers. Once a cluster is created with a network provider, you would need to tear down the entire cluster and all applications to be able to switch to a different one. -- Whether or not to use a [cloud provider]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/cloud-providers). +- Whether or not to use a [cloud provider]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/cloud-providers). If you want to use [volumes and storage]({{< baseurl >}}/rancher/v2.x/en/kubernetes-in-rancher/volumes-and-storage/) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. + > **Note:** If your cloud provider is not listed as an option, you will need to use the [config file option](#config-file) to use that cloud provider. PLease reference the [RKE's cloud provider documentation]({{< baseurl >}}/rke/v0.1.x/en/config-options/cloud-providers/) on how to configure these other cloud providers. - Whether or not to use a [pod security policy]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies). You must have an existing pod security policy configured before you can use this option. @@ -40,4 +42,4 @@ Instead of using the Rancher UI to choose Kubernetes options for the cluster, ad - To edit an RKE config file directly from the Rancher UI, click **Edit as YAML**. - To read from an existing RKE file, click **Read from File**. -For an example of RKE config file syntax, see the [RKE documentation]({{< baseurl >}}/rke/v0.1.x/en/example-yamls/). \ No newline at end of file +For an example of RKE config file syntax, see the [RKE documentation]({{< baseurl >}}/rke/v0.1.x/en/example-yamls/).