Part 3.3: How to Move from Infrastructure as Code to Collaborative Infrastructure as Code
Using version-controlled Terraform configurations to manage key infrastructure eliminates a great deal of technical complexity and inconsistency. Now that you have the basics under control, you’re ready to focus on other problems.
Your next goals are to:
- Adopt consistent workflows for Terraform usage across teams
- Expand the benefits of Terraform beyond the core of engineers who directly edit Terraform code.
- Manage infrastructure provisioning permissions for users and teams.
Terraform Cloud is the product we’ve built to help you address these next-level problems. The following section describes how to start using it most effectively.
Note: If you aren’t already using mature Terraform code to manage a significant portion of your infrastructure, make sure you follow the steps in the previous section first.
1. Install or Sign Up for Terraform Cloud
You have two options for using Terraform Cloud: the SaaS hosted by HashiCorp, or a private instance you manage with Terraform Enterprise. If you have chosen the SaaS version then you can skip this step; otherwise visit the Terraform Enterprise documentation to get started.
2. Learn Terraform Cloud's Run Environment
Get familiar with how Terraform runs work in Terraform Cloud. With Terraform OSS, you generally use external VCS tools to get code onto the filesystem, then execute runs from the command line or from a general purpose CI system.
Terraform Cloud does things differently: a workspace is associated directly with a VCS repo, and you use Terraform Cloud’s UI or API to start and monitor runs. To get familiar with this operating model:
- Read the documentation on how to perform and configure Terraform runs in Terraform Cloud.
- Create a proof-of-concept workspace, associate it with Terraform code in a VCS repo, set variables as needed, and use Terraform Cloud to perform some Terraform runs with that code.
3. Design Your Organization’s Workspace Structure
In Terraform Cloud, each Terraform configuration should manage a specific infrastructure component, and each environment of a given configuration should be a separate workspace — in other words, Terraform configurations * environments = workspaces. A workspace name should be something like “networking-dev,” so you can tell at a glance which infrastructure and environment it manages.
The definition of an “infrastructure component” depends on your organization’s structure. A given workspace might manage an application, a service, or a group of related services; it might provision infrastructure used by a single engineering team, or it might provision shared, foundational infrastructure used by the entire business.
You should structure your workspaces to match the divisions of responsibility in your infrastructure. You will probably end up with a mixture: some components, like networking, are foundational infrastructure controlled by central IT staff; others are application-specific and should be controlled by the engineering teams that rely on them.
Also, keep in mind:
- Some workspaces publish output data to be used by other workspaces.
- The workspaces that make up a configuration’s environments (app1-dev, app1-stage, app1-prod) should be run in order, to ensure code is properly verified.
The first relationship, a relationship between workspaces for different components but the same environment, creates a graph of dependencies between workspaces, and you should stay aware of it. The second relationship, a relationship between workspaces for the same component but different environments, creates a pipeline between workspaces. Terraform Cloud doesn’t currently have the ability to act on these dependencies, but features like cascading updates and promotion are coming soon, and you’ll be able to use them more easily if you already understand how your workspaces relate.
4. Create Workspaces
Create workspaces in Terraform Cloud, and map VCS repositories to them. Each workspace reads its Terraform code from your version control system. You’ll need to assign a repository and branch to each workspace.
We recommend using the same repository and branch for every environment of a given app or service — write your Terraform code such that you can differentiate the environments via variables, and set those variables appropriately per workspace. This might not be practical for your existing code yet, in which case you can use different branches per workspace and handle promotion through your merge strategy, but we believe a model of one canonical branch works best.
5. Plan and Create Teams
Terraform Cloud manages workspace access with teams, which are groups of user accounts.
Your Terraform Cloud teams should match your understanding of who's responsible for which infrastructure. That isn't always an exact match for your org chart, so make sure you spend some time thinking about this and talking to people across the organization. Keep in mind:
- Some teams need to administer many workspaces, and others only need permissions on one or two.
- A team might not have the same permissions on every workspace they use; for example, application developers might have read/write access to their app’s dev and stage environments, but read-only access to prod.
Managing an accurate and complete map of how responsibilities are delegated is one of the most difficult parts of practicing collaborative infrastructure as code.
When managing team membership, you have two options:
Manage user accounts with SAML single sign-on. SAML support is exclusive to Terraform Enterprise, and lets users log into Terraform Cloud via your organization's existing identity provider. If your organization is at a scale where you use a SAML-compatible identity provider, we recommend this option.
If your identity provider already has information about your colleagues' teams or groups, you can manage team membership via your identity provider. Otherwise, you can add users to teams with the UI or with the team membership API.
Manage user accounts in Terraform Cloud. Your colleagues must create their own Terraform Cloud user accounts, and you can add them to your organization by adding their username to at least one team. You can manage team membership with the UI or with the team membership API.
6. Assign Permissions
Assign workspace ownership and permissions to teams.
Terraform Cloud supports granular team permissions for each workspace. For complete information about the available permissions, see the Terraform Cloud permissions documentation.
Most workspaces will give access to multiple teams with different permissions.
|app1-dev||Team-eng-app1: Apply runs, read and write variables |
|app1-prod||Team-eng-app1: Queue plans, read variables |
Team-owners-app1: Apply runs, read and write variables
|networking-dev||Team-eng-networking: Apply runs, read and write variables |
|networking-prod||Team-eng-networking: Queue plans, read variables |
Team-owners-networking: Apply runs, read and write variables
7. Restrict Non-Terraform Access
Restrict access to cloud provider UIs and APIs. Since Terraform Cloud is now your organization’s primary interface for infrastructure provisioning, you should restrict access to any alternate interface that bypasses Terraform Cloud. For almost all users, it should be impossible to manually modify infrastructure without using the organization’s agreed-upon Terraform workflow.
As long as no one can bypass Terraform, your code review processes and your Terraform Cloud workspace permissions are the definitive record of who can modify which infrastructure. This makes everything about your infrastructure more knowable and controllable. Terraform Cloud is one workflow to learn, one workflow to secure, and one workflow to audit for provisioning any infrastructure in your organization.
At this point, you have successfully adopted a collaborative infrastructure as code workflow with Terraform Cloud. You can provision infrastructure across multiple providers using a single workflow, and you have a shared interface that helps manage your organization’s standards around access control and code promotion.
Next, you can make additional improvements to your workflows and practices. Continue on to Part 3.4: Advanced Improvements to Collaborative Infrastructure as Code.