diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/_index.md index dbbd556addb..bc0a779c4dd 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/_index.md @@ -17,6 +17,18 @@ A node template is the saved configuration for the parameters to use when provis After you create a node template in Rancher, it's saved so that you can use this template again to create other node pools. Node templates are bound to your login. After you add a template, you can remove them from your user profile. +## Cloud Credentials + +_Available as of v2.2.0_ + +Node templates can use cloud credentials to store credentials for launching nodes in your cloud provider, which has some benefits: + +- Cloud credentials are stored as Kubernetes secrets for security. Credentials are no longer needed to be re-entered any time you want to edit a node template. + +- After the cloud credential is created, it can be re-used to create additional node templates. + +- When access and secret keys are expired or compromised, the cloud credential can be updated with the new information, which will automatically be updated for all the node templates referencing this cloud credential. + ## Node Drivers If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it]({{< baseurl >}}/rancher/v2.x/en/admin-settings/drivers/node-drivers/#activating-deactivating-node-drivers), or you can [add your own custom node driver]({{< baseurl >}}/rancher/v2.x/en/admin-settings/drivers/node-drivers/#adding-custom-node-drivers). diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md index dfece5159ba..de3220c8c2c 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md @@ -24,10 +24,12 @@ Use {{< product >}} to create a Kubernetes cluster in Azure. 2. Complete the **Azure Options** form. - - **Placement** sets the geographical region where where your cluster is hosted and other location metadata. - - **Account Access** stores your account information for authenticating with Azure. + {{< step_create-cloud-credential >}} + + - **Placement** sets the geographical region where where your cluster is hosted and other location metadata. + - **Network** configures the networking used in your cluster. - **Instance** customizes your VM configuration. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md index 479683c182c..bd33b64fc16 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md @@ -25,6 +25,8 @@ Use {{< product >}} to create a Kubernetes cluster using DigitalOcean. [DigitalOcean Instructions: How To Generate a Personal Access Token](https://www.digitalocean.com/community/tutorials/how-to-use-the-digitalocean-api-v2#how-to-generate-a-personal-access-token) + {{< step_create-cloud-credential >}} + 3. Complete the **DigitalOcean Options** form. - **Droplet Options** provision your cluster's geographical region and specifications. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md index 899f4d7d3ac..0e8633b8342 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md @@ -31,6 +31,8 @@ Use {{< product >}} to create a Kubernetes cluster in Amazon EC2. * **Account Access** is where you configure the region of the nodes, and the credentials (Access Key and Secret Key) used to create the machine. See [Prerequisistes](#prerequisistes) how to create the Access Key and Secret Key and the needed permissions. + {{< step_create-cloud-credential >}} + - **Zone and Network** configures the availability zone and network settings for your cluster. - **Security Groups** creates or configures the Security Groups applied to your nodes. Please refer to [Amazon EC2 security group when using Node Driver]({{< baseurl >}}/rancher/v2.x/en/installation/references/#amazonec2-securitygroup-nodedriver) to see what rules are created in the `rancher-nodes` Security Group. - **Instance** configures the instances that will be created. Make sure you configure the correct **SSH User** for the configured AMI. diff --git a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md index 8eb4e5373cb..a4dfe1bb8af 100644 --- a/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md +++ b/content/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md @@ -61,6 +61,8 @@ To create a cluster, you need to create at least one vSphere [node template]({{< 4. Under [Account Access](#account-access) enter the vCenter FQDN or IP address and the credentials for the vSphere user account (see [Prerequisites](#prerequisites)). + {{< step_create-cloud-credential >}} + 5. Under [Instance Options](#instance-options), configure the number of vCPUs, memory, and disk size for the VMs created by this template. 6. **Optional:** Enter the URL pointing to a [RancherOS]({{< baseurl >}}/os/v1.x/en/) cloud-config file in the [Cloud Init](#instance-options) field. diff --git a/content/rancher/v2.x/en/user-settings/cloud-credentials/_index.md b/content/rancher/v2.x/en/user-settings/cloud-credentials/_index.md index 1e5e3efe9a4..627c8098c1f 100644 --- a/content/rancher/v2.x/en/user-settings/cloud-credentials/_index.md +++ b/content/rancher/v2.x/en/user-settings/cloud-credentials/_index.md @@ -43,5 +43,7 @@ When access credentials are changed or compromised, updating a cloud credential In order to delete cloud credentials, there must not be any node template associated with it. If you are unable to delete the cloud credential, [delete any node templates]({{< baseurl >}}/rancher/v2.x/en/user-settings/node-templates/#deleting-a-node-template) that are still associated to that cloud credential. 1. From your user settings, select **User Avatar > Cloud Credentials**. -1. You can either individually delete a cloud credential or bulk delete. To individually delete one, choose the cloud credential you want to edit and click the **Vertical Ellipsis (...) > Delete**. To bulk delete cloud credentials, select one or more cloud credentials from the list. Click **Delete**. +1. You can either individually delete a cloud credential or bulk delete. + - To individually delete one, choose the cloud credential you want to edit and click the **Vertical Ellipsis (...) > Delete**. + - To bulk delete cloud credentials, select one or more cloud credentials from the list. Click **Delete**. 1. Confirm that you want to delete these cloud credentials. diff --git a/content/rancher/v2.x/en/user-settings/node-templates/_index.md b/content/rancher/v2.x/en/user-settings/node-templates/_index.md index eec473d33fa..bc81cab4d0c 100644 --- a/content/rancher/v2.x/en/user-settings/node-templates/_index.md +++ b/content/rancher/v2.x/en/user-settings/node-templates/_index.md @@ -18,6 +18,18 @@ When you create a node template, it is bound to your user profile. Node template **Result:** The template is configured. You can use the template later when you [provision a node pool cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools). +## Updating a Node Template + +1. From your user settings, select **User Avatar > Node Templates**. +1. Choose the Node Template you want to edit and click the **Vertical Ellipsis (...) > Edit**. + + **Note:** + Starting 2.2, you'll have to enter Account Access Information and create a **cloud credential** before editing node template. This will save you the hassle of re-entering access information everytime you edit a node template. + +1. Edit the required information and click **Save**. + +**Result:** The node template is updated with new information. All node pools using this node template will automatically use the updated information when new nodes are added. + ## Cloning Node Templates When creating new node templates from your user settings, you can clone an existing template and quickly update its settings rather than creating a new one from scratch. Cloning templates saves you the hassle of re-entering access keys for the cloud provider. diff --git a/layouts/shortcodes/step_create-cloud-credential.html b/layouts/shortcodes/step_create-cloud-credential.html new file mode 100644 index 00000000000..2bace0b576e --- /dev/null +++ b/layouts/shortcodes/step_create-cloud-credential.html @@ -0,0 +1,11 @@ +
+

+ Starting 2.2, account access information will be stored in Cloud Credentials.

Cloud Credentials are stored in Kubernetes secrets. Multiple node templates can use the same cloud credential. You can either use an existing cloud credential or create a new one on this page. +

+
+ +

+

+