The Role-Profiles Pattern Across Infrastructure as Code
A blog covering the role-profile pattern across IaC and the why's of Terragrunt
See more articles
Lead Platform Engineer at CTS
Back in the midst of time the Role-Profiles pattern that PuppetLabs promoted saved many a complex deployment. It was a way of using the configuration tool Puppet, that:
- provided sensible abstractions
- decoupled business logic, implementation and resource modelling
- separated data and code
And it’s great to bring some of this to the world of Terraform and Kubernetes provisioning.
If you’ve worked on Terraform in more than one company you’ll likely have seen very different approaches to folder structure, module usage, and environment promotion. At CTS we’ve attempted to formalise our approach to infrastructure-as-code (IaC) somewhat based on the Role-Profile pattern. We’ve found that the Role-Profile pattern is a useful conceptual model that works across not only configuration (Puppet), but also resource provisioning (Terraform + Terragrunt), and application layer deployments in Kubernetes (Kustomize).
There’s an excellent slide-deck by Craig Dunn of Puppet Labs detailing the design of the Role-Profile pattern here:
In the stack diagram below, Roles, Profiles and Components are all written in the Puppet DSL.
- Roles represent business logic, not a technology and are named as such e.g. uat_server, archive.
- Roles define a set of logical technology stacks or profiles.
- Importantly a node(VM) can only ever have one role
- Profiles define a set of components and are named after the logical tech stacks they implement e.g database, email
- Components are named after what they manage e.g Apache, SSH, MySQL
If you don’t know Puppet, then it’s enough to know that there’s a system (node classifier) that maps Nodes (aka machines or VMs) to Roles.
For example, a machine may be assigned a UAT Server role by the Node Classifier and have the following profiles:
- base: OS, patches, security
- webapp: application stack
- test_tools: custom test suite for the monolith
- Here, UAT Server is the business logic and thus role and three profiles build up exactly what the role is composed of.
Picking the webapp profile it may have the following components:
Finally Puppet used another tool called Hiera to separate out the customisation of each of the layers.
Puppet also made some strong recommendations about how Hiera should be used in the Roles-Profiles method. See the rules section here:
The rules are of interest as they encapsulate best-practice that helps ensure that profiles and components are composable and reusable.
The rules distil down to:
- component level configuration for things that don’t change across multiple projects (set in the component)
- profile level configuration for things that don’t change across environments (parameterise the component, set config in the profile itself or also parameterise the profile and use a common config)
- profile level configuration for things that do change across environments (parameterise the profile and set per env)
These rules will guide us how and where Terraform with the Role-Profile pattern should be configured. Let’s take a look at how we can apply the pattern to Terraform.
Terraform & Terragrunt
A Brief Aside into the Why’s of Terragrunt
If you have not used Terragrunt before it solves some Terraform issues (and introduces some of its own). At CTS, with hundreds of Terraform deploys a day across multiple customers, we are very interested in reducing the blast-radius of failed Terraform runs.
Typically, as soon as this becomes a problem for a company with a sufficiently complex infrastructure the easiest thing to do is separate the code base into multiple Terraform runs. Perhaps organised like so:
- VPCs (Networking Layer)
- VMs/Clusters (Application Layer)
- DBs/Object stores (Persistence Layer)
Now the decoupling means that when you update say your application you can in no way risk your network layer — however it does come with problems:
- how do you pass data between the layers?
- how do you maintain the ordering (all the nice graph dependencies Terraform is able to calculate are gone as soon as the graph is split into the number of layers)
Perhaps you’ll write bespoke scripts to maintain the ordering? But there’s still no real dependency management. Over the course of time what’s stopping you from introducing cyclic dependencies between layers? Perhaps you’ll use TF state or data sources in order to discover data between the layers, but this is ad hoc and adds lots of code that was not needed before.
Luckily, Terragrunt solves a lot of these problems in a consistent manner. The Terragrunt docs themselves do a great job in explaining the motivations and features.
And for an example of how Terragrunt is to be used
Terragrunt and the Role-Profile Pattern
Here is typical Terraform/Terragrunt setup within CTS.
The following table shows how the 3 layers of repo map to the Role-Profiles pattern and how they should ideally be used.
Starting at the left of the example above, in the Terragrunt Infra Repo we have the cloudm directory in the staging environment of the europe-west-2 region.
This cloudm directory can be thought of as a Puppet role: it's the infrastructure required to host one of CTS' products. It requires a GCP Project and a GKE cluster. This is defined by the sub-directories gke and service-project and the configuration terragrunt.hcl within each.
Unlike Puppet and Hiera, the role configuration is not decoupled. Nor is it a formally defined entity i.e, to copy the cloudm role to prod you effectively copy the directory and configure the hcl with appropriate values. However, it is still a significant improvement - there's no explicit Terraform resources in this layer.
note: it would be great to extend Terragrunt to support these notions properly.
Next we have the Terragrunt Modules layer — if we take the gke-private-cluster module as an example, it wraps the terraform-google-kubernetes module and in this particular case adds some routing and DNS. In more complicated modules, multiple vendor modules may be called. It is here we ensure solid common settings and capture how CTS thinks one should best call the various vendor-supplied modules across all environments.
Finally there’s the Vendor Modules — these are from the likes of Google who provide best practice modules as part of the Foundation programme. They can be taken from GitHub or the Terraform Registry. They compare almost directly with Puppet components — which are typically modules taken from Puppet Forge.
One can’t write about Terragrunt and not espouse the virtues of immutable versioned deploys. At the Terragrunt module repo layer we are able to make changes across multiple modules and use a git tag at the repo level to fix that code base in time. We specify that tag in the env_version file in each of the environments specified in the infra-live layer (see it in stage hierarchy above). Every terragrunt.hcl file uses that tag when it links to the profile to use. Now we can make changes to multiple modules and roll out in one step to dev. If it all goes well we can then bump the stage env_version file to the same tag for a very easy promotion that we know has been tested to work.
One final thing to mention is that we use Atlantis to monitor the Terragrunt Infra repo and plan automatically on pull-request. It’s configured to run Terragrunt at the profile level only. It sort of takes on the role of Puppet Master (or even ArgoCD in the K8s world — another abstraction to perhaps explore)
The Role-Profile + Component pattern fits well with Terragrunt and Terraform. The Terragrunt-Infra to Role is the weakest of the mappings in the pattern at present. However in its combined role of configuration, role definition and classifier it works well enough. The profile and component mappings are clear and obvious.
CTS has used this very successfully to:
- build a library of profile and component modules.
- allow very rapid deploys of new customers (all we need do is build out the infra-live repo — cherry picking from our profile library).
- promote a lot of re-use.
- easily transition to Terraform 12 — much of the hard work was done by others in the Vendor(component) modules.
- provide a common conceptual model to DevOps engineers. This is somewhat related to our ability to rapidly deploy and may be the most valuable outcome in the long-term. Knowing how to structure a new project, where each part of the configuration and code should live removes a lot of mental burden when confronted with a blank slate.
We’ve also extended this pattern to our Kubernetes deploys with Kustomize and ArgoCD — but that’s for another blog post!
I’ve recently been made aware of the following patterns post by OpenCredo
The final pattern named TerraServices looks, at first glance, to map onto profiles (Infra-Module layer). OpenCredo refers to them as isolated logical components.
OpenCredo goes on to further talk about Orchestrating Terraform as all the isolated states require significant coordination. Hopefully I’ve shown that Terragrunt is a great solution to this — it’s open-source, it solves dependencies and it provides a common way of sharing data between the isolated runs.
Kubernetes Part 3: Secrets
In the two previous posts in this series, I have discussed security in GKE - starting your...
Kubernetes Part 2: Continuous Deployment and GitOps
The first post in this series discussed securing your cluster and the workloads running inside of...