- Create an Astronomer account.
- Create a new AWS account with the required AWS resources.
- Create the IAM policies used by Astro. This includes a cross-account IAM role that Astro can assume and permissions boundaries for IAM entities.
Prerequisites
-
A new AWS account with the minimum EC2 service quotas. For security reasons, AWS accounts with existing infrastructure aren’t supported.
The following table lists the required EC2 service quotas.
-
A CIDR block with a range of
/20. If you don’t have a preferred CIDR block, Astro will provision a VPC using a default of172.20.0.0/20. Astro uses this VPC for 2 public subnets and 2 private subnets. See AWS resource reference. - Permissions to create a stack using CloudFormation.
-
The following domains added to your organization’s allowlist for any user and CI/CD environments:
https://cloud.astronomer.io/https://api.astronomer.io/https://images.astronomer.cloud/https://auth.astronomer.io/https://updates.astronomer.io/https://install.astronomer.io/https://astro-<your-org>.datakin.com/https://<your-org>.astronomer.run/
- A subscription to the Astro Status Page. This ensures that you’ll be notified when there are incidents or when maintenance is scheduled.
VPC peering prerequisites (Optional)
The following options are available to connect Astro to AWS resources on a private network:- Allow traffic through the public internet and use allowlists for communication.
- Create a VPC Peering connection between the dedicated Astro data plane VPC and your existing AWS account VPCs.
- A CIDR block (RFC 1918 IP Space) no smaller than a
/20range. You must ensure it doesn’t overlap with the AWS VPC(s) that you will be peering with later. The default CIDR range is172.20.0.0/20. - VPC Name / ID for peering with Astronomer (accessible through the AWS VPC console).
- The IP addresses of your DNS servers.
Access Astro
- Go to https://cloud.astronomer.io/ and create an account, or enter your email address, and then click Continue.
-
Select one of the following options to access the Astro UI:
- Enter your password and click Continue.
- To authenticate with an identity provider (IdP), click Continue with SSO, enter your username and password, and then click Sign In.
- To authenticate with your GitHub account, click Continue with GitHub, enter your username or email address, enter your password, and then click Sign in.
- To authenticate with your Google account, click Continue with Google, choose an account, enter your username and password, and then click Sign In.
Retrieve an external ID from the Astro UI
You must be an Organization Owner to view the external ID. If you aren’t an Organization Owner, the AWS External ID field won’t appear in the Astro UI.- In the Astro UI, click the Settings tab.
- Click Show in the AWS External ID field and then click Copy. This external ID is a unique identifier that Astro uses to connect to your AWS account.
- Save the external ID as a secret or in another secure format. See How to use an external ID when granting access to your AWS resources to a third party.
Create a cross-account role
Use the external ID to create a cross-account IAM role for Astro.- Sign in to your AWS CloudFormation console.
- Open the Astronomer cross-account role CloudFormation template.
- Enter the external ID that you copied in Step 2 in the ExternalId field.
- Select the I acknowledge that AWS CloudFormation might create IAM resources with custom names checkbox.
- Click Create Stack.
Cross-account role modifications
When new features or functionality are added to Astro, Astronomer might need to modify cross-account role permissions. When setting permissions, Astronomer adheres to the least-privilege permissions standard and adds only the permissions necessary for new features or functionality. Astronomer support notifies your Organization when any changes are made to the policies that expand cross-account role access. Notifications will include an explanation of the changes being made and why the change was necessary. Astronomer can reduce the access available to the policies without notification.Monitor the policies for changes (optional)
You can use CloudTrail to monitor changes to Astro policies. Access to CloudTrail has been limited to prevent the accidental modification or deletion of CloudTrail logs by Astronomer support. The following table lists the events that you should monitor.
To monitor changes to the cross-account role policy and permissions boundaries, create an Amazon CloudWatch alarm. See Creating CloudWatch alarms for CloudTrail events. When you create the metric filter in the CloudWatch console, on the Define pattern page, in Create filter pattern, enter the following for Filter pattern:
Provide setup information to Astronomer
After creating the AWS account, provide Astronomer with the following information:- Your AWS Account ID.
- Your preferred Astro cluster name.
- The AWS region that you want to host your cluster in.
- Your preferred node instance type.
- Your preferred maximum node count.
- An instance type for the Airflow metadata database.
m5.xlarge nodes and a maximum node count of 20 in us-east-1 and a default db.m6g.large Amazon RDS instance type. For information on all supported regions, configurations, and defaults, see AWS cluster configurations.
To provision additional clusters after completing your initial installation, see Create a cluster.
Provide VPC peering information (optional)
If you need to VPC peer with Astronomer, provide the following information to your Astronomer representative:- Subnet CIDRs (RFC 1918 IP Space).
- VPC Name/ID and region for peering with Astronomer. This is accessible through the AWS VPC console.
- The IPs of your DNS servers.
Astronomer creates the cluster
After you’ve created the cross-account IAM role for Astro, contact your Astronomer representative. Astronomer creates the cluster in your AWS account. This process can take some time. Wait for confirmation from Astronomer that the cluster has been created before creating a Deployment. If you submitted a VPC peering request, you’ll need to accept the request from Astronomer after Astro is installed. To accept the request, see Create a VPC peering connection. When VPC peering with Astronomer is complete, configure and validate the following items to ensure successful network communications between Astro and your resources:- Egress Routes on Astronomer Route Table
- Network ACLs and/or Security Group rules of your resources