add information about cloud credential during node provisioning

2026-09-25 12:38:05 +00:00 · 2019-03-22 12:57:29 -07:00
parent d5336febce
commit 9a3e31feea
8 changed files with 46 additions and 3 deletions
@@ -17,6 +17,16 @@ 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 
+
+Starting 2.2, Node templates will use cloud credentials to store credentials for launching nodes in your cloud provider. There are two benefits of using cloud credential -
+
+- Credentials are stored in Kubernetes secrets for security. This also means you no longer have to enter credential every time you edit a node template.
+
+- After you create cloud credential in Rancher, it's saved so that this credential can be used again to create other node templates. 
+
+- So when your keys are expired or compromised, you can just update cloud credential in one place and changes will be updated to all the node templates using it.
+
 ## 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/tools/drivers/node-drivers/#activating-deactivating-node-drivers), or you can [add your own custom node driver]({{< baseurl >}}/rancher/v2.x/en/tools/drivers/node-drivers/#adding-custom-node-drivers).
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -0,0 +1,11 @@
+<blockquote>
+	<p>
+		Starting 2.2, account access information will be stored in <b>Cloud Credentials</b>.<br></br>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.
+	</p>
+</blockquote>
+
+<p>
+	<ul> 
+	<li>To create a new cloud credential, enter <b>Name</b> and <strong>Account Access </strong> data, then click <strong>Create</strong>.</li>
+	</ul>
+</p>