Authorize an Astro Deployment to cloud resources using workload identity

Attach an IAM role to your Deployment

You can attach an AWS IAM role to your Deployment to grant the Deployment all of the role’s permissions.

Using IAM roles provides the greatest amount of flexibility for authorizing Deployments to your cloud. For example, you can use existing IAM roles on new Deployments, or your can attach a single IAM role to multiple Deployments that all require the same level of access to your cloud.

Prerequisites

• Minimum Astro Runtime version:
  • 9.15.0
  • 10.9.0
  • 11.5.0
• A new or existing IAM role in your data sources with the required permissions you want your Deployment to have.
• If using AWS CloudShell, the required CLIs are enabled by default.
• If you use a local terminal, the following CLIs are required:
  • AWS CLI
  • jq
  • openSSL

Step 1: Authorize the Deployment to your IAM role

To authorize your Deployment, create an IAM role to assign as your Deployment’s workload identity:

1. Create an IAM role to delegate permissions to in an AWS service. Grant the role any permission that the Deployment will need in your AWS account. Copy the IAM role ARN to use later in this setup.
2. In the Astro UI, select your Deployment and then click Details. In the Advanced section, click Edit.
3. In the Workload Identity menu, select Customer Managed Identity.
4. Enter your IAM role ARN when prompted, then copy and run the provided CLI command. Click Save Configuration to save the IAM role as a selectable configuration.
5. Click Update Deployment to apply the selected IAM role to the Deployment.
6. (Optional) Repeat these steps for each Astro Deployment that needs to access your AWS resources. Or, you can edit the <DeploymentNamespace> value in Condition when setting up the Workload Identity for one of the following scenarios to apply to multiple Deployments.

1
{
2
    "Condition": {
3
        "StringLike": {
4
            "<clusterOIDCIssuerUrl>:aud": "sts.amazonaws.com",
5
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-kpo"
6
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-dag-processor-serviceaccount"
7
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-scheduler-serviceaccount"
8
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-triggerer-serviceaccount"
9
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-apiserver-serviceaccount"
10
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:<DeploymentNamespace>:<DeploymentNamespace>-worker-serviceaccount"
11
        }
12
    }
13
}

1
{
2
    "Condition": {
3
        "StringLike": {
4
            "<clusterOIDCIssuerUrl>:aud": "sts.amazonaws.com",
5
            "<clusterOIDCIssuerUrl>:sub": "system:serviceaccount:*:*"
6
        }
7
    }
8
}

Step 2: Create an Airflow connection

Now that your Deployment is authorized, you can connect it to your cloud using an Airflow connection. Create an Amazon Web Services connection in either the Astro UI or the Airflow UI for your Deployment and specify the following fields:

• Connection Id: Enter a name for the connection.

If you don’t see Amazon Web Services as a connection type in the Airflow UI, ensure you have installed its provider package in your Astro project’s requirements.txt file. See Use Provider in the Astronomer Registry for the latest package.

Alternative setup: Authorize your Deployment with AWS IAM roles

Step 1: Authorize the Deployment in your cloud

To grant a Deployment access to a service that is running in an AWS account not managed by Astronomer, use AWS IAM roles to authorize your Deployment’s workload identity. IAM roles on AWS are often used to manage the level of access a specific user, object, or group of users has to a resource, such as Amazon S3 buckets, Redshift instances, and secrets backends.

To authorize your Deployment, create an IAM role that is assumed by the Deployment’s workload identity:

1. In the Astro UI, select your Deployment and then click Details. Copy the Deployment’s Workload Identity.

2. In the AWS account that contains your AWS service, create an IAM role. See Creating a role to delegate permissions to an AWS service.

3. In the AWS Management Console, go to the Identity and Access Management (IAM) dashboard.

4. Click Roles and in the Role name column, select the role you created in Step 2.

5. Click Trust relationships.

6. Click Edit trust policy and paste the workload identity you copied from Step 1 in the trust policy. Your policy should look like the following:

   1
   {
   2
     "Version": "2012-10-17",
   3
     "Statement": [
   4
       {
   5
         "Effect": "Allow",
   6
         "Principal": {
   7
           "AWS": ["<workload-identity-role>"]
   8
         },
   9
         "Action": "sts:AssumeRole"
   10
       }
   11
     ]
   12
   }

7. Click Update policy.

Repeat these steps for each Astro Deployment that needs to access your AWS resources.

Step 2: Create an Airflow connection

Now that your Deployment is authorized, you can connect it to your cloud using an Airflow connection. Either create an Amazon Web Services connection in the Astro UI or the Airflow UI for your Deployment and specify the following fields:

• Connection Id: Enter a name for the connection.

• Extra:

  1
  {
  2
    "role_arn": "<your-role-arn>",
  3
    "region_name": "<your-region>"
  4
  }

If you don’t see Amazon Web Services as a connection type in the Airflow UI, ensure you have installed its provider package in your Astro project’s requirements.txt file. See Use Provider in the Astronomer Registry for the latest package.