completing draft of how to edit an existing cluster

2026-09-26 13:08:11 +00:00 · 2018-08-21 19:24:40 -07:00
parent 06b31c87a9
commit 8503882438
4 changed files with 94 additions and 18 deletions
@@ -18,7 +18,7 @@ A _Kubernetes Cluster_ is a cluster that uses the [Kubernetes container-orchestr

 Each computing resource in a Kubernetes Cluster is called a _node_. Nodes can be either bare-metal servers or virtual machines. Kubernetes classifies nodes into three types: _etcd_ nodes, _control plane_ nodes, and _worker_ nodes.

-#### etcd Nodes
+#### etcd Nodes 

 [etcd](https://kubernetes.io/docs/concepts/overview/components/#etcd) nodes run the etcd database. The etcd database component is a key value store used as Kubernetes storage for all cluster data, such as cluster coordination and state management.

@@ -3,9 +3,24 @@ title: Editing Clusters
 weight: 3015
 ---

-## Editing the Cluster Membership
+After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. To edit your cluster, open the **Global** view, make sure the **Clusters** tab is selected, and then select **Ellipsis > Edit** for the cluster that you want to edit.

-Following cluster creation, you can add users as cluster members so that they can access its resources.
+<sup>To Edit an Existing Cluster</sup>
+![Edit Cluster]({{< baseurl >}}/img/rancher/edit-cluster.png)
+
+The options and settings available for an existing cluster change based on the method that you used to provision the cluster. For example, only clusters provisioned by RKE have **Cluster Options** available for editing.
+
+The following table lists the options and settings available for each cluster type:
+
+ Cluster Type | Member Roles | Cluster Options | Node Pools
+---------|----------|---------|---------|
+ [RKE-Launched]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/#rancher-launched-kubernetes) | ✓ | ✓ | ✓ |
+ [Hosted Kubernetes Cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/#hosted-kubernetes-cluster) | ✓ |  |  |
+ [Imported]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/#import-existing-cluster) | ✓ |  |  |
+
+## Editing Cluster Membership
+
+Cluster administrators can edit the membership for a cluster, controlling which Rancher users can access the cluster and what features they can use.

 >**Ping and MS FS Caveats:**
 >
@@ -45,35 +60,96 @@ Following cluster creation, you can add users as cluster members so that they ca
 - To revoke cluster membership, select the user and click **Delete**. This action deletes membership, not the user.
 - To modify a user's roles in the cluster, delete them from the cluster, and then re-add them with modified roles.

-## Cluster Options
+## Upgrading Kubernetes

->**Note:** These cluster options are only available for [clusters that Rancher has launched Kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/).  
+Following an upgrade to the latest version of Rancher, you can update your existing clusters to use latest version of Kubernetes supported by Rancher. Prior to release, we test Rancher with the latest versions of to ensure compatibility. Any version of Kubernetes listed in the Rancher UI is fully supported.

-### Adding/Changing a Pod Security Policy
+>**Recommended:** Before upgrading Kubernetes, [backup your cluster]({{< baseurl >}}/rancher/v2.x/en/backups).

-If you don't apply a PSP as you create your cluster, you can always add one later.
+1. From the **Global** view, find the cluster for which you want to upgrade Kubernetes. Select **Vertical Ellipsis (...) > Edit**.

->**Prerequisite:**
->Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies/).
+1. Expand **Cluster Options**.

-1. From the **Global** view, find the cluster that you want to apply your PSP to. Select **Vertical Ellipsis (...) > Edit** for the cluster you want to enable PSPs for.
+1. From the **Kubernetes Version** drop-down, choose the version of Kubernetes that you want to use for the cluster.

-2. Expand the **Cluster Options** accordion.
+1. Click **Save**.
+
+**Result:** Kubernetes is upgraded for the cluster.
+
+## Adding a Pod Security Policy
+
+When your cluster is running pods with security-sensitive configurations, assign it a [pod security policy]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies/), which is a set of rules that monitors the conditions and settings in your pods. If a pod doesn't meet the rules specified in your policy, the policy stops it from running.
+
+You can assign a pod security policy when you provision a cluster. However, if you need to relax or restrict security for your pods later, you can update the policy while editing your cluster.
+
+1. From the **Global** view, find the cluster to which you want to apply a pod security policy. Select **Vertical Ellipsis (...) > Edit**.
+
+2. Expand **Cluster Options**.

 3. From **Pod Security Policy Support**, select **Enabled**.

-    >**Note:** Not all cluster providers support PSPs, so this option may not be available.
+    >**Note:** This option is only available for clusters provisioned by RKE.

-    **Step Result:** The **Default Pod Security Policy** drop-down activates.
+4. From **Default Pod Security Policy** drop-down, select the policy you want to apply to the cluster.

-4. From **Default Pod Security Policy**, select the PSP you want to apply to the cluster.
+	Rancher ships with [policies]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies/#default-pod-security-policies) of `restricted` and `unrestricted`, although you can [create custom policies]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies/#default-pod-security-policies) as well.	

 5. Click **Save**.

-**Result:** The PSP is applied to the cluster and any projects within the cluster.
+**Result:** The pod security policy is applied to the cluster and any projects within the cluster.

->**Note:** Any workloads that are already running in a cluster or project before a PSP is assigned will not be checked if it complies with the PSP. Workloads would need to be cloned or upgraded to see if they pass the PSP.
+>**Note:** Workloads already running before assignment of a pod security policy are grandfathered in. Even if they don't meet your pod security policy, workloads running before assignment of the policy continue to run.
+>
+>To check if a running workload passes your pod security policy, clone or upgrade it.

-### Node pools
+## Editing Other Cluster Options

-Changing the nodes in a RKE cluster
+In [clusters launched by RKE]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/), you can edit any of the remaining options that follow.
+
+>**Note:** These options are not available for imported clusters or hosted Kubernetes clusters.
+
+<sup>Options for RKE Clusters</sup>
+![Cluster Options]({{< baseurl >}}/img/rancher/cluster-options.png)
+
+
+Option | Description |
+---------|----------|
+ Kubernetes Version | The version of Kubernetes installed on each cluster node. For more detail, see [Upgrading Kubernetes](#upgrading-kubernetes). |
+ Network Provider | The [container networking interface]({{< baseurl >}}/rancher/v2.x/en/faq/networking/cni-providers/) that powers networking for your cluster.<br/><br/>**Note:** You can only choose this option while provisioning your cluster. It cannot be edited later. |
+ Project Network Isolation | If you're using the Canal network provider, you can choose whether to enable or disable inter-project communication. |
+ Nginx Ingress | If you want to publish your applications in a high-availability configuration, and you're hosting your nodes with a cloud-provider that doesn't have a native load-balancing feature, enable this option to use Nginx ingress within the cluster. |
+ Metrics Server Monitoring | Each cloud provider capable of launching a cluster using RKE can collect metrics and monitoring for your cluster nodes. Enable this option to view your node metrics from your cloud provider's portal. |
+ Pod Security Policy Support | Enables [pod security policies]({{< baseurl >}}/rancher/v2.x/en/admin-settings/pod-security-policies/) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. |
+ Docker version on nodes | Configures whether nodes are allowed to run versions of Docker that Rancher doesn't officially support. If you choose to require a [supported Docker version]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install-external-lb/#software), Rancher will stop pods from running on nodes that don't have a supported Docker version installed. |
+ Docker Root Directory | The directory on your cluster nodes where you've installed Docker. If you install Docker on your nodes to a non-default directory, update this path. |
+ Default Pod Security Policy | If you enable **Pod Security Policy Support**, use this drop-down to choose the pod security policy that's applied to the cluster. |
+ Cloud Provider | If you're using a cloud provider to host cluster nodes launched by RKE, enable [this option]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/options/cloud-providers/) so that you can use the cloud provider's native features. If you want to store persistent data for your cloud-hosted cluster, this option is required.  |
+
+## Managing Node Pools
+
+In clusters [launched by RKE]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/), you can:
+
+- Add new [pools of nodes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/) to your cluster. The nodes added to the pool are provisioned according to the [node template]({{< baseurl >}}/rancher/v2.x/en/user-settings/node-templates/) that you use.
+
+	- Click **+** and follow the directions on screen to create a new template.
+	
+	- You can also reuse existing templates by selecting one from the **Template** drop-down.
+
+- Redistribute Kubernetes nodes amongst your node pools by making different checkbox selections  
+
+- Scale the number of nodes in a pool up or down (although, if you simply want to maintain your node scale, we recommend using the cluster's [Nodes tab]({{< baseurl >}}/rancher/v2.x/en/k8s-in-rancher/nodes/#nodes-provisioned-by-node-pool) instead.)
+
+>**Note:** The Node Pools section is not available for imported clusters or clusters hosted by a Kubnernetes provider.
+
+## Editing Cluster as YAML
+
+>**Note:** In Rancher v2.0.5 and v2.0.6, the names of services in the Config File (YAML) should contain underscores only: `kube_api` and `kube_controller`.
+
+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**.
+
+![image]({{< baseurl >}}/img/rancher/cluster-options-yaml.png)
+
+For an example of RKE config file syntax, see the [RKE documentation]({{< baseurl >}}/rke/v0.1.x/en/example-yamls/).