Skip to content

access-pod-identity.md

Latest commit

 

History

History
161 lines (120 loc) · 8.9 KB

access-pod-identity.md

File metadata and controls

161 lines (120 loc) · 8.9 KB
copyright
years
2014, 2026
lastupdated 2026-04-15
keywords kubernetes, openshift, infrastructure, rbac, policy
subcollection openshift

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

Authorizing resources with IAM trusted profiles

{: #pod-iam-identity}

[Virtual Private Cloud]{: tag-vpc} [Classic infrastructure]{: tag-classic-inf} [{{site.data.keyword.satelliteshort}}]{: tag-satellite}

Learn how to setup access to or for your resources by using trusted profiles. {: shortdesc}

You can enable IAM trusted profiles by running the ibmcloud oc cluster master refresh command. {: tip}

In IAM : Start by creating an IAM trusted profile. Then, link the trusted profile with your {{site.data.keyword.openshiftlong_notm}} compute resource by selecting conditions to match with your clusters, including a Kubernetes namespace and service account in the clusters. Finally, assign access policies to the {{site.data.keyword.cloud_notm}} services that you want your apps to use.

In your cluster : Through Kubernetes service account token volume projection{: external}, the apps that run in your linked cluster's Kubernetes namespace{: external} and use the namespace's service account can exchange the service account public key to get an {{site.data.keyword.cloud_notm}} IAM access token. Your app can use this access token to authenticate API requests to {{site.data.keyword.cloud_notm}} services, such as databases, {{site.data.keyword.watson}}, or VPC infrastructure. Through the access policies of the trusted profile, you control what actions the token lets the app perform.

Creating an IAM trusted profile

{: #iam-trusted-profile-create}

To create a trusted profile in your account, see Creating trusted profiles in the IAM documentation. Note that to create a trusted profile, you must be the account owner. Additionally, the following access roles are required.

Set the default trusted profile for the cluster

{: #iam-trusted-profile-set}

To set a trusted profile for a single cluster, run the ibmcloud oc experimental trusted-profile set command.

If you want all the clusters in a resource group to use the same trusted profile, run the ibmcloud oc experimental trusted-profile default set command.

Get the details of your trusted profile

{: #iam-trusted-profile-get}

To get the default trusted profile for clusters in the same resource group, run the ibmcloud oc experimental trusted-profile default get command.

Configure your application pods to authenticate with {{site.data.keyword.cloud_notm}} services

{: #iam-identity-pod}

Give application pods that run in your {{site.data.keyword.openshiftlong}} cluster access to {{site.data.keyword.cloud_notm}} services by using trusted profiles in {{site.data.keyword.cloud_notm}} Identity and Access Management (IAM). As a developer, you can configure your application pods to authenticate with {{site.data.keyword.cloud_notm}} services in clusters that are linked to an IAM trusted profile set up. {: shortdesc}

To complete these steps, you do not need to have the administrator access role. However, you must meet the following requirements: Viewer platform access role; Writer service access role for the cluster in {{site.data.keyword.cloud_notm}} IAM for {{site.data.keyword.containershort}}; the iam-identity.profile.create and iam-identity.profile.linkToResource actions for the IAM identity service. {: note}

Before you begin:

To configure your application pods to authenticate with {{site.data.keyword.cloud_notm}} services:

  1. Design your pod configuration file to use service account token volume projection{: external}.

    1. In the containers section, mount the identity token in the volumeMounts section.

      ...
    volumeMounts:
    - mountPath: /var/run/secrets/tokens
      name: sa-token

      {: codeblock}

    2. In the volumes section, set up the service account token volume projection.

      Modify the expirationSeconds field to control how long the token is valid for. To retrieve IAM tokens, the service account token expiration must be 1 hour or less. {: tip}

      ...
volumes:
  - name: sa-token
    projected:
      sources:
      - serviceAccountToken:
          path: sa-token
          expirationSeconds: 3600
          audience: iam
...

      {: codeblock}

  2. Design your app to exchange the service account projected token for an IAM token that you can use for subsequent API calls to {{site.data.keyword.cloud_notm}} services. Review the following example authentication request. Replace ${profile_id} with the ID of the trusted profile that the cluster is linked to. To list available profile IDs, you or the account administrator can use the ibmcloud iam tps command, the GET 'https://iam.cloud.ibm.com/v1/profiles/?account_id=<account_id>', or you can view the trusted profiles in the IAM console{: external}.

    curl -s -X POST \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -H "Accept: application/json" \
    -d grant_type=urn:ibm:params:oauth:grant-type:cr-token \
    -d cr_token=$(cat /var/run/secrets/tokens/sa-token) \
    -d profile_id=${profile_id} \
    https://iam.cloud.ibm.com/identity/token

    {: codeblock}

  3. Before your app is deployed, try the following example Kubernetes job to test the token exchange. In the following Kubernetes job, a curl pod makes an API request to {{site.data.keyword.cloud_notm}} IAM to verify that the cluster's public key is exchanged for an IAM access token. Your app might call other {{site.data.keyword.cloud_notm}} services that the trusted profile authorizes.

    apiVersion: batch/v1
kind: Job
metadata:
  name: token-exchange-job
  namespace: default
spec:
  template:
    spec:
      containers:
      - name: curl
        image: curlimages/curl:7.77.0
        command: ["/bin/sh"]
        args: ["-c", "curl -s -H \"Content-Type: application/x-www-form-urlencoded\" -H \"Accept: application/json\" -d grant_type=urn:ibm:params:oauth:grant-type:cr-token -d cr_token=$(cat /var/run/secrets/tokens/sa-token) -d profile_id=<profile_id> https://iam.cloud.ibm.com/identity/token"]
        volumeMounts:
        - mountPath: /var/run/secrets/tokens
          name: sa-token
      restartPolicy: Never
      serviceAccountName: default
      volumes:
      - name: sa-token
        projected:
          sources:
          - serviceAccountToken:
              path: sa-token
              expirationSeconds: 3600
              audience: iam

    {: codeblock}

  4. Deploy the job.

    kubectl apply -f exchange-job.yaml

    {: pre}

  5. Review the job details to verify it was successful.

    oc describe job token-exchange-job

    {: pre}

  6. Review the output for the job completed and succeeded messages to verify the job was a success.

  7. If the job succeeded, check your {{site.data.keyword.cloudaccesstrailshort}} global events in Frankfurt to verify the log line with details on the Trusted Profile request. If the job failed, review your configuration and try again.