Terraform module to provision workspaces & configurations in Terraform Cloud via YAML configuration.
NOTE: Requires Terraform Cloud or Terraform Enterprise.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
Here's how to invoke this example module in your projects:
provider "tfe" {
version = ">= 0.21.0"
}
module "example" {
source = "https://github.com/cloudposse/terraform-tfe-cloud-infrastructure-automation.git?ref=master"
# Directory containing all YAML configurations
config_file_path = "config"
organization = var.organization
vcs_repo = {
branch = "main"
ingress_submodules = true
# We recommend exporting the `FOOBAR` environment variable instead of passing a variable
oauth_token_id = var.oauth_token_id
}
}Here is an example of using this module:
examples/complete- complete example of using this module
We use YAML for the configuration files in order to separate configuration settings from business logic. It's also a portable format that can be used across multiple tools. Our convention is to name files by $env-$stage.yaml (e.g. ue2-testing.yaml), so for example an $env could be ue2 (for us-east-2) and the $stage might be testing. Workspace names are derived from the $env-$stage-$project, which looks like ue2-testing-eks.
# Projects are all the top-level root modules
projects:
# Globals are exported as TF_VAR_... environment variables in every workspace
globals:
# Used to determine the name of the workspace (e.g. the 'testing' in 'ue2-testing')
stage: testing
# Used to determine the name of the workspace (e.g. the 'ue2' in 'ue2-testing')
environment: ue2
# The configuration file format is designed to be used across multiple tools.
# All terraform projects should be listed under this section.
terraform:
# List one or more Terraform projects here
first-project:
# Controls whether or not this workspace should be created
# NOTE: If set to 'false', you cannot reference this workspace via `triggers` in another workspace!
workspace_enabled: true
# Override the version of Terraform for this workspace (defaults to the latest in Terraform Cloud/Enterprise)
terraform_version: 0.13.4
# Controls the `auto_apply` setting within this workspace
auto_apply: true
# Optional filename triggers to match (default is *.tf)
filename_triggers:
- "*.*"
# Add extra 'Run Triggers' to this workspace, beyond the parent workspace, which is created by default
# These triggers mean this project workspace will be automatically planned if any of these workspaces are applied.
triggers:
- uw2-testing-example2
- gbl-root-example1
# Set the Terraform input variable values for this project. Complex types like maps and lists are supported.
vars:
my_input_var: "Hello world! This is a value that needs to be passed to my `first-project` Terraform project."
# Every project should be uniquely named and correspond to a folder in the `projects/` directory
second-project:
workspace_enabled: true
# Specify a custom project folder (defalts to the project name if not specified)
custom_project_folder: my-custom-project-folder
vars:
my_input_var: "Hello world! This is another example!"Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 0.13.0 |
| local | >= 1.4 |
| random | >= 2.2 |
| tfe | >= 0.23.0 |
| Name | Version |
|---|---|
| tfe | >= 0.23.0 |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_tag_map | Additional tags for appending to tags_as_list_of_maps. Not added to tags. |
map(string) |
{} |
no |
| attributes | Additional attributes (e.g. 1) |
list(string) |
[] |
no |
| config_auto_apply | Controls Terraform Cloud workspace auto-apply feature | bool |
true |
no |
| config_file_path | Relative path to YAML config files | string |
null |
no |
| config_file_pattern | File pattern used to locate configuration files | string |
"*.yaml" |
no |
| context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. |
object({ |
{ |
no |
| delimiter | Delimiter to be used between namespace, environment, stage, name and attributes.Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
| enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
| environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| id_length_limit | Limit id to this many characters.Set to 0 for unlimited length.Set to null for default, which is 0.Does not affect id_full. |
number |
null |
no |
| label_order | The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present. |
list(string) |
null |
no |
| name | Solution name, e.g. 'app' or 'jenkins' | string |
null |
no |
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string |
null |
no |
| organization | Name of the organization. | string |
n/a | yes |
| projects_path | Project directory path relative to the repository root | string |
"projects" |
no |
| regex_replace_chars | Regex to replace chars with empty string in namespace, environment, stage and name.If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ') |
map(string) |
{} |
no |
| terraform_version | The version of Terraform to use for this workspace. Defaults to the latest available version. | string |
null |
no |
| tfc_project_path | Name of the working directory where the top-level Terraform Cloud project resides (e.g. within projects_path). |
string |
"tfc" |
no |
| top_level_workspace | Name of the top-level configuration workspace in Terraform Cloud | string |
"tfc-config" |
no |
| vcs_repo | The VCS repository to configure. | map(string) |
{} |
no |
| Name | Description |
|---|---|
| environment_workspaces | A list of environment workspaces & their configurations. |
| global_workspace | Configuration information for the global workspace. |
| project_workspaces | A list of project workspaces & their configurations. |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-kubernetes-tfc-cloud-agent - Installs the Terraform Cloud Agent on an existing Kubernetes cluster.
For additional context, refer to some of these links.
- Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration
- Terraform Cloud - Terraform Cloud is an application that helps teams use Terraform together.
- Terraform Enterprise/Cloud Documentation -
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2020-2021 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Dan Meyers |
|---|