Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 4.1 KB

access-apikey.md

File metadata and controls

79 lines (52 loc) · 4.1 KB
Raw
copyright lastupdated keywords subcollection
years
2014, 2024
2024-09-04
containers, {{site.data.keyword.containerlong_notm}}, kubernetes, infrastructure, rbac, policy
containers

{{site.data.keyword.attribute-definition-list}}

Setting the cluster credentials

{: #access-creds} {: help} {: support}

{{site.data.keyword.containerlong_notm}} accesses the infrastructure portfolio and other services that you use in your cluster by using an API key. This API key stores the credentials of a user in the account to the infrastructure and other services. {{site.data.keyword.containerlong_notm}} uses the API key to order resources in the service, such as new worker nodes or VLANs in IBM Cloud infrastructure. {: shortdesc}

By default, the account owner's credentials are stored in the API key. However, to avoid tying your cluster resources to a specific user, such as the account owner, consider using a functional ID instead of a personal user. In the event of the account owner leaving the organization or being removed from the account, a functional ID prevents other users from losing access to the account and prevents disruptions to services and commands requiring certain credentials that might not be available after the account owner leaves.

Need to remove a user from your account? Make sure you reset your API key. See Removing user credentials and permissions. {: tip}

Resetting the cluster API key

{: #admin-set-credentials}

Complete the following steps to reset the API key that is used by the cluster. When the API key is reset, the previous API key that was used, if any, for the region and resource group is now obsolete. You can then delete the old API key from your list of API keys.

If you use the {{site.data.keyword.block_storage_is_short}} or cluster autoscaler add-ons in your cluster, you must re-create the add-on pods after you reset your API key. For more information, see {{site.data.keyword.block_storage_is_short}} PVC creation fails after API key reset and Autoscaling fails after API key reset. {: important}

Make sure that the user or functional ID that runs this command has the required permissions including the required permissions for other services or integrations. Target the resource group and region that you want to set the API key for. {: important}

  1. As the account owner, invite a functional ID to your {{site.data.keyword.cloud_notm}}.

  2. Assign the functional ID the correct permissions.

  3. Log in as the functional ID or user whose credentials you want to use in the cluster.

    ibmcloud login

    {: pre}

  4. Target the resource group the cluster is in.

    If you don't target a resource group, the API key is set for the default resource group. To list available resource groups, run ibmcloud resource groups. {: note }

    ibmcloud target -g <resource_group_name>

    {: pre}

  5. Reset the API key.

    ibmcloud ks api-key reset --region <region>

    {: pre}

  6. Verify that the API key is set up.

    ibmcloud ks api-key info --cluster <cluster_name_or_ID>

    {: pre}

  7. Repeat these steps for each region and resource group where you want to reset the cluster API key.

Removing user credentials and permissions

{: #apikey-remove-user}

In certain scenarios, such as staffing changes, your organization might need to remove user credentials and permissions from your account. To ensure that processes requiring certain user credentials are not disrupted when a user is removed from the account, you must reset the API key with another user's infrastructure credentials. For more information, see Removing users.