mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 04:28:15 +00:00
cloud creds update
This commit is contained in:
Denise Schannon
@@ -15,16 +15,16 @@ 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.
|
||||
As of v2.2.0, [cloud credential]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#cloud-credentials) are created to store credentials for launching nodes in your infrastructure providers. There are two benefits of using a cloud credential:
|
||||
- Credentials are stored as a Kubernetes secret, which is not only more secure, but it also allows you to edit a node template without having to enter your credentials every time.
|
||||
- Multiple node templates can share the same cloud credential to create node pools. If your key is compromised or expired, the cloud credential can be updated in a single place, which allows all node templates that are using it to be updated at once.
|
||||
|
||||
- [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.
|
||||
|
||||
>**Note:** If you want to reuse a node from a previous custom cluster, [clean the node]({{< baseurl >}}/rancher/v2.x/en/admin-settings/removing-rancher/rancher-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### Requirements
|
||||
|
||||
@@ -12,7 +12,7 @@ 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.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).
|
||||
- [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-pools/#node-templates) to [provision nodes for clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters). Note: Available as of v2.2.0.
|
||||
- [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.
|
||||
|
||||
@@ -3,39 +3,45 @@ title: Managing Cloud Credentials
|
||||
weight: 7010
|
||||
---
|
||||
|
||||
When you create 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.
|
||||
_Available as of v2.2.0_
|
||||
|
||||
When you create 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.
|
||||
|
||||
Node templates use cloud credentials to access the credential information required to provision nodes in the infrastructure providers. The same cloud credential can be used by multiple node templates. By using a cloud credential, you do not have to re-enter access keys for the same cloud provider. Cloud credentials are stored as Kubernetes secrets.
|
||||
|
||||
Starting rancher v2.2.0, 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 for a 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).
|
||||
- [During creation of a node template]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for a cluster.
|
||||
- In the **User Settings**
|
||||
|
||||
When you create a cloud credential, it is bound to your user profile. Cloud Credentials cannot be shared among users.
|
||||
All cloud credentials are bound to the user profile of who created it. They **cannot** be shared across 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 from the drop down menu; these correspond to the available cloud providers for Node Templates.
|
||||
1. Enter required values for the type you've selected.
|
||||
1. Enter a name for the cloud credential.
|
||||
1. Select a **Cloud Credential Type** from the drop down. The values of this dropdown is based on the `active` [node drivers]({{< baseurl >}}/rancher/v2.x/en/tools/drivers/node-drivers/) in Rancher.
|
||||
1. Based on the selected cloud credential type, enter the required values to authenticate with the infrastructure provider.
|
||||
1. Click **Create**.
|
||||
|
||||
**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).
|
||||
**Result:** The cloud credential is created and can immediately be used to [create node templates]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/#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.
|
||||
When access credentials are changed or compromised, updating a cloud credential allows you to rotate those credentials while keeping the same node template.
|
||||
|
||||
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**.
|
||||
1. Choose the cloud credential you want to edit and click the **Vertical Ellipsis (...) > Edit**.
|
||||
1. Update the credential 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).
|
||||
**Result:** The cloud credential is updated with the new access credentials. All existing node templates using this cloud credential will automatically use the updated information whenever [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.
|
||||
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. Select one or more cloud credentials from the list. Then click **Delete**. Confirm the delete when prompted.
|
||||
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.
|
||||
|
||||
@@ -33,4 +33,4 @@ When creating new node templates from your user settings, you can clone an exist
|
||||
When you no longer use a node template, you can delete it from your user settings.
|
||||
|
||||
1. From your user settings, select **User Avatar > Node Templates**.
|
||||
1. Select one or more template from the list. Then click **Delete**. Confirm the delete when prompted.
|
||||
1. Select one or more template from the list. Then click **Delete**. Confirm the delete when prompted.
|
||||
|
||||
Reference in New Issue
Block a user