About the integration»
The AWS integration allows either Spacelift or a private worker controlled by you to assume an IAM role in your AWS account and thus generate a set of temporary credentials that are then exposed to your run or task as the following computed environment variables:
This is enough for both the AWS Terraform provider and/or S3 state backend to generate a fully authenticated AWS session without further configuration. However, you will likely need to select one of the available regions with the former.
Setting up the AWS integration»
Setting up the AWS integration is available to organization administrators through the Integrations tab in the stack management view:
By clicking on the Edit Integrations button, you can switch to editing mode and choose AWS from the list of available integrations:
Once selected, the AWS integration setup screen will look like this:
Note how you have 2 options for the integration. One is to have Spacelift assume the role and pass the temporary credentials to the worker. This is mostly designed for users of shared, public workers.
The second option is to have the private worker assume an IAM role based on its own credentials (e.g., from an EC2 instance profile) before passing it to the job container's environment. This is exclusively designed for private, self-hosted workers as the public ones have no identity of their own.
Assume the role on the worker»
When assuming the role on the private workers, the process is straightforward: you provide the IAM role to assume, and, optionally, an external ID.
The latter is not very important when no trust relationship with a third party is involved, but we still pre-populate it for you as a best practice.
Note that we have no way of validating whether your worker has the ability to assume the said role. You will need to trigger a job to verify that.
Ask Spacelift to assume the role»
This feature is mostly designed for clients using the shared public worker pool. When hosting Spacelift workers on your infrastructure you can use your cloud providers' ambient credentials (e.g., from an EC2 instance role or ECS task role on AWS).
If you want credentials to be generated by Spacelift, in most cases, what you just need is to click the highlighted link to create a new role. If you want to use an existing role, please skip to this section. The link takes you to an IAM role creation form, partially filled in with some details, in particular, the external ID unique to your stack:
Make sure you're currently logged into the correct AWS account for the magic link to work.
Fast forward a few steps, and here's what you get at the checkout:
Give your role an informative name (something with Spacelift and stack name, maybe?) and create the role.
By default, Spacelift suggests attaching PowerUserAccess policy, which provides full access to AWS services and resources, but does not allow management of Users and groups. This is a powerful but still reasonably safe option. You can choose a different policy or create a completely custom policy for your role in the second step of the above wizard.
Once the role is created, find it in the IAM console and copy its full ARN to the Spacelift form field. Here's where to find the full role ARN…
…and here's where to paste it:
Once you click the Save button, Spacelift will verify the integration. First, it will try to assume the role with the unique external ID and expect to succeed. If it succeeds, it will try to assume the role without the unique external ID, and this time it expects to fail. If Spacelift fails the latter check, we consider the integration is safely configured.
This somewhat counterintuitive extra check is to prevent against malicious takeover of your account by someone who happens to know your AWS account ID, which isn't all that secret, really. The security vulnerability we're addressing here is known as the confused deputy problem.
Using an existing role»
Instead of creating a new, separate role for each stack which we generally advise for housekeeping and security purposes, you can add a trust relationship to an existing role. The form provides a statement that you can to the IAM role's Trust relationship section:
You can use the Spacelift Terraform provider in order to set up the AWS integration programmatically from an administrative stack, including the trust relationship. Note that in order to do that, your administrative stack will require AWS credentials itself, and ones powerful enough to be able to deal with IAM.
Here's a little example of what that might look like:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
Please always refer to the provider documentation for the most up-to-date documentation.
Is it safe?»
Assuming role and generating credentials on the private worker is perfectly safe. Those credentials are never leaked to us in any shape or form. Hence, the rest of this section discusses the trust relationship established between the Spacelift account and your AWS account for the purpose of dynamically generating short-lived credentials. So, how safe is that?
Probably safer than storing static credentials in your stack environment. Unlike user keys that you'd normally have to use, role credentials are dynamically created and short-lived. We use the default expiration which is 1 hour, and do not store them anywhere. Leaking them accidentally through the logs is not an option either because we mask AWS credentials.
The most tangible safety feature of the AWS integration is the breadcrumb trail it leaves in CloudTrail. Every resource change can be mapped to an individual Terraform run or task whose ID automatically becomes the username as the
sts:AssumeRole API call with that ID as
RoleSessionName. In conjunction with AWS tools like Config, it can be a very powerful compliance tool.
Let's have a look at a CloudTrail event showing an IAM role being created by what seems to be a Spacelift run:
01DSJ63P40BAZY4VW8BXXG7M4K is indeed a run ID we can then trace back even further:
Roles assuming other roles»
OK, we get it. Using everyone's favorite Inception meme:
Indeed, AWS Terraform provider allows you to assume an IAM role during setup, effectively doing the same thing over again. This approach is especially useful if you want to control resources in multiple AWS accounts from a single Spacelift stack. This is totally fine - in IAM, roles can assume other roles, though what you need to do on your end is set up the trust relationship between the role you have Spacelift assume and the role for each provider instance to assume. But let's face it - at this level of sophistication, you sure know what you're doing.
One bit you might not want to miss though, is the guaranteed ability to map the change to a particular run or task that we described in the previous section. One way of fixing that would be to use the
TF_VAR_spacelift_run_id computed environment variable available to each Spacelift workflow. Conveniently, it's already a Terraform variable, so a setup like this should do the trick:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16