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 f64297f1e8e..20d9008d5be 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 @@ -15,6 +15,10 @@ RKE launched clusters are separated into two categories: Using Rancher, you can create pools of nodes based on a [node template]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers. The available cloud providers to create a node template are decided based on active [node drivers]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers). The benefit of using a node hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher will automatically create another node to join the cluster to ensure that the count of the node pool is as expected. + Starting 2.2, you will create [cloud credential]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#cloud-credentials) to store credentials for launching nodes in your cloud providers. 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. + - Multiple node templates can share the same cloud credential to create node pools. 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. + - [Custom Nodes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/custom-nodes/): For use cases where you want to provision bare-metal servers, on-premise virtual machines, or bring virtual machines that already exist in a cloud provider. With this option, you will run a Rancher agent Docker container on the machine. diff --git a/content/rancher/v2.x/en/user-settings/_index.md b/content/rancher/v2.x/en/user-settings/_index.md index 7c71f6f01cf..7a9f47294ce 100644 --- a/content/rancher/v2.x/en/user-settings/_index.md +++ b/content/rancher/v2.x/en/user-settings/_index.md @@ -11,7 +11,8 @@ Within Rancher, each user has a number of settings associated with their login: The available user settings are: -- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key. +- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key.gferfgre +- [Cloud Credentials]({{< baseurl >}}/rancher/v2.x/en/user-settings/node-templates): Manage cloud credentials [used by Node Templates]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters). - [Node Templates]({{< baseurl >}}/rancher/v2.x/en/user-settings/node-templates): Manage templates [used by Rancher to provision nodes for clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters). - [Preferences]({{< baseurl >}}/rancher/v2.x/en/user-settings/preferences): Sets superficial preferences for the Rancher UI. - Log Out: Ends your user session. 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 new file mode 100644 index 00000000000..4500b09c3ec --- /dev/null +++ b/content/rancher/v2.x/en/user-settings/cloud-credentials/_index.md @@ -0,0 +1,41 @@ +--- +title: Managing Cloud Credentials +weight: 7010 +--- + +When you provision a cluster [hosted by an infrastructure provider]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. + +Starting rancher 2.2, Node Templates use Cloud Credentials to access the credential information required to provision nodes in the cloud providers. The same cloud credential can be used by multiple node templates. This saves you the hassle of re-entering access keys for the cloud provider. Cloud Credentials are stored in Kubernetes Secrets. + +You can create cloud credentials in two contexts: + +- While [provisioning a node pool cluster]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools). +- At any time, from your [user settings](#creating-a-node-template-from-user-settings). + +When you create a cloud credential, it is bound to your user profile. Cloud Credentials cannot be shared among users. + +## Creating a Cloud Credential from User Settings + +1. From your user settings, select **User Avatar > Cloud Credentials**. +1. Click **Add Cloud Credential**. +1. Select one of the Cloud Credential Types available, these correspond to the available cloud providers for Node Templates. +1. Enter required values for the type you selected. + +**Result:** The cloud credential is configured. You can use the cloud credential later when you [create a node template]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-templates). + +## Updating a Cloud Credential + +When your access credentials change or you want to rotate or invalidate credential data, you can update a cloud credential. + +1. From your user settings, select **User Avatar > Cloud Credentials**. +1. Choose the cloud credential you want to edit and click on the vertical ellipsis button at the end of the row and choose **Edit**. +1. Enter updated information and click **Save**. + +**Result:** The cloud credential has been updated and configured. Existing node templates using this cloud credential will automatically use the updated information when [new nodes are added]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools). + +## Deleting a Cloud Credential + +When cloud credential is no longer used by any node template, you can delete it from your user settings. + +1. From your user settings, select **User Avatar > Cloud Credentials**. +1. Select one or more cloud credentials from the list. Then click **Delete**. Confirm the delete when prompted. \ No newline at end of file diff --git a/static/img/rancher/user-settings.png b/static/img/rancher/user-settings.png index ca545e752a4..4567a556787 100644 Binary files a/static/img/rancher/user-settings.png and b/static/img/rancher/user-settings.png differ