terraform-spacelift-cloud-infrastructure-automation

Terraform module to provision Spacelift resources for cloud infrastructure automation.

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!

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

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.

The first step is to create a new infrastructure repository in GitHub and link it in Spacelift. You will want the Project root of the infrastructure repository to point to the top-level project that contains the reference to this module. Beyond that, you will also want to enable the Administrative and Autodeploy options in the configuration.

The Administrative option allows the top-level project and this module to create all other required configurations, such as stacks, policies, and contexts.

Once you have the top-level project configured and ready, simply trigger it manually, or by pushing an update to the infrastructure to Git.

Here's how to invoke this module in your project:

provider "spacelift" {}

module "spacelift" {
  source  = "cloudposse/cloud-infrastructure-automation/spacelift"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  stack_config_path_template = var.stack_config_path_template
  components_path            = var.spacelift_component_path

  branch                = "main"
  repository            = var.git_repository
  commit_sha            = var.git_commit_sha
  spacelift_run_enabled = false
  runner_image          = var.runner_image
  worker_pool_id        = var.worker_pool_id
  autodeploy            = var.autodeploy
  manage_state          = false

  terraform_version     = var.terraform_version
  terraform_version_map = var.terraform_version_map

  imports_processing_enabled        = false
  stack_deps_processing_enabled     = false
  component_deps_processing_enabled = true

  policies_available     = var.policies_available
  policies_enabled       = var.policies_enabled
  policies_by_id_enabled = []
  policies_by_name_path  = format("%s/rego-policies", path.module)

  administrative_stack_drift_detection_enabled   = true
  administrative_stack_drift_detection_reconcile = true
  administrative_stack_drift_detection_schedule  = ["0 4 * * *"]

  drift_detection_enabled   = true
  drift_detection_reconcile = true
  drift_detection_schedule  = ["0 4 * * *"]

  aws_role_enabled                        = false
  aws_role_arn                            = null
  aws_role_external_id                    = null
  aws_role_generate_credentials_in_worker = false

  stack_destructor_enabled = false
}

IMPORTANT: Be sure to set the manage_state value from the start, otherwise changing this value after deploying a stack may cause resources to be orphaned!

Examples

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-$component, which looks like ue2-testing-eks.

# Components are all the top-level root modules
components:
  # 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 components should be listed under this section.
  terraform:
    # List one or more Terraform components here
    first-component:
      # 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 Spacelift)
      terraform_version: 0.13.4
      # Controls the `auto_apply` setting within this workspace
      auto_apply: true
      # Add extra 'Run Triggers' to this workspace, beyond the parent workspace, which is created by default
      # These triggers mean this component 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 component. 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-component` Terraform component."
    # Every component should be uniquely named and correspond to a folder in the `components/` directory
    second-component:
      workspace_enabled: true
      # Specify a custom component folder (defalts to the component name if not specified)
      custom_component_folder: my-custom-component-folder
      vars:
        my_input_var: "Hello world! This is another example!"

Additionally, you must have a globals.yaml present in the config folder, which contains environment variables that will be applied to all stacks.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.13.0
spacelift	>= 0.1.7

Providers

Name	Version
spacelift	>= 0.1.7

Modules

Name	Source	Version
spacelift_config	cloudposse/stack-config/yaml//modules/spacelift	0.22.0
stacks	./modules/stack	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
spacelift_context.default	resource
spacelift_drift_detection.drift_detection_administrative	resource
spacelift_environment_variable.default	resource
spacelift_policy.custom	resource
spacelift_policy.default	resource
spacelift_policy.trigger_administrative	resource
spacelift_policy_attachment.trigger_administrative	resource
spacelift_current_stack.administrative	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
administrative	Whether this stack can manage other stacks	`bool`	`false`	no
administrative_stack_drift_detection_enabled	Flag to enable/disable administrative stack drift detection	`bool`	`true`	no
administrative_stack_drift_detection_reconcile	Flag to enable/disable administrative stack drift automatic reconciliation. If drift is detected and `reconcile` is turned on, Spacelift will create a tracked run to correct the drift	`bool`	`true`	no
administrative_stack_drift_detection_schedule	List of cron expressions to schedule drift detection for the administrative stack	`list(string)`	[ "0 4 * * *" ]	no
administrative_trigger_policy_enabled	Flag to enable/disable the global administrative trigger policy	`bool`	`true`	no
after_apply	List of after-apply scripts	`list(string)`	`[]`	no
after_destroy	List of after-destroy scripts	`list(string)`	`[]`	no
after_init	List of after-init scripts	`list(string)`	`[]`	no
after_perform	List of after-perform scripts	`list(string)`	`[]`	no
after_plan	List of after-plan scripts	`list(string)`	`[]`	no
attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the `delimiter` and treated as a single ID element.	`list(string)`	`[]`	no
autodeploy	Autodeploy global setting for Spacelift stacks. This setting can be overidden in stack-level configuration)	`bool`	`false`	no
aws_role_arn	ARN of the AWS IAM role to assume and put its temporary credentials in the runtime environment	`string`	`null`	no
aws_role_enabled	Flag to enable/disable Spacelift to use AWS STS to assume the supplied IAM role and put its temporary credentials in the runtime environment	`bool`	`false`	no
aws_role_external_id	Custom external ID (works only for private workers). See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html for more details	`string`	`null`	no
aws_role_generate_credentials_in_worker	Flag to enable/disable generating AWS credentials in the private worker after assuming the supplied IAM role	`bool`	`true`	no
before_apply	List of before-apply scripts	`list(string)`	`[]`	no
before_destroy	List of before-destroy scripts	`list(string)`	`[]`	no
before_init	List of before-init scripts	`list(string)`	`[]`	no
before_perform	List of before-perform scripts	`list(string)`	`[]`	no
before_plan	List of before-plan scripts	`list(string)`	`[]`	no
branch	Specify which branch to use within your infrastructure repo	`string`	`"main"`	no
commit_sha	The commit SHA for which to trigger a run. Requires `var.spacelift_run_enabled` to be set to `true`	`string`	`null`	no
component_deps_processing_enabled	Boolean flag to enable/disable processing stack config dependencies for the components in the provided stack	`bool`	`true`	no
components_path	The relative pathname for where all components reside	`string`	`"components"`	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.	`any`	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
context_attachments	A list of context IDs to attach to all stacks administered by this module	`list(string)`	`[]`	no
context_filters	Context filters to create stacks for specific context information. Valid lists are `namespaces`, `environments`, `tenants`, `stages`.	`map(list(string))`	`{}`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{<br> format = string<br> labels = list(string)<br>}` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. `labels` is a list of labels, in order, to pass to `format()` function. Label values will be normalized before being passed to `format()` so they will be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
drift_detection_enabled	Flag to enable/disable drift detection on the infrastructure stacks	`bool`	`false`	no
drift_detection_reconcile	Flag to enable/disable infrastructure stacks drift automatic reconciliation. If drift is detected and `reconcile` is turned on, Spacelift will create a tracked run to correct the drift	`bool`	`false`	no
drift_detection_schedule	List of cron expressions to schedule drift detection for the infrastructure stacks	`list(string)`	[ "0 4 * * *" ]	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
external_execution	Set this to true if you're calling this module from outside of a Spacelift stack (e.g. the `complete` example)	`bool`	`false`	no
id_length_limit	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for keep the existing setting, which defaults to `0`. Does not affect `id_full`.	`number`	`null`	no
imports_processing_enabled	Enable/disable processing stack imports	`bool`	`false`	no
infracost_enabled	Flag to enable/disable infracost. If this is enabled, it will add infracost label to each stack. See spacelift infracost docs for more details.	`bool`	`false`	no
label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper`. Default value: `title`.	`string`	`null`	no
label_order	The order in which the labels (ID elements) appear in the `id`. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
label_value_case	Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. Does not affect values of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper` and `none` (no transformation). Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. Default value: `lower`.	`string`	`null`	no
labels	Set of labels to attach to each stack	`list(string)`	`[]`	no
labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output. Default is to include all labels. Tags with empty values will not be included in the `tags` output. Set to `[]` to suppress all generated tags. Notes: The value of the `name` tag, if included, will be the `id`, not the `name`. Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	no
local_preview_enabled	Indicates whether local preview runs can be triggered on this Stack	`bool`	`false`	no
manage_state	Global flag to enable/disable manage_state settings for all project stacks	`bool`	`true`	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a `tag`. The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
policies_available	List of available default policies to create in Spacelift (these policies will not be attached to Spacelift stacks by default, use `var.policies_enabled`)	`list(string)`	[ "access.default", "git_push.proposed-run", "git_push.tracked-run", "plan.default", "trigger.dependencies", "trigger.retries" ]	no
policies_by_id_enabled	List of existing policy IDs to attach to all Spacelift stacks. These policies must be created outside of this module	`list(string)`	`[]`	no
policies_by_name_enabled	List of existing policy names to attach to all Spacelift stacks. These policies must be created outside of this module	`list(string)`	`[]`	no
policies_by_name_path	Path to the catalog of external Rego policies. The Rego files must exist in the caller's code at the path. The module will create Spacelift policies from the external Rego definitions	`string`	`""`	no
policies_enabled	List of default policies to attach to all Spacelift stacks	`list(string)`	[ "git_push.proposed-run", "git_push.tracked-run", "plan.default", "trigger.dependencies" ]	no
policies_path	Path to the catalog of default policies	`string`	`"catalog/policies"`	no
protect_from_deletion	Flag to enable/disable deletion protection.	`bool`	`false`	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
repository	The name of your infrastructure repo	`string`	n/a	yes
runner_image	The full image name and tag of the Docker image to use in Spacelift	`string`	`null`	no
spacelift_run_enabled	Enable/disable creation of the `spacelift_run` resource	`bool`	`false`	no
stack_config_path_template	Stack config path template	`string`	`"stacks/%s.yaml"`	no
stack_context_description	Description of global stack context	`string`	`"Stack context description"`	no
stack_context_name	Name of global stack context	`string`	`"Stack context"`	no
stack_context_variables	Map of variables to create a global context attached to each stack	`map(string)`	`{}`	no
stack_deps_processing_enabled	Boolean flag to enable/disable processing all stack dependencies in the provided stack	`bool`	`false`	no
stack_destructor_enabled	Flag to enable/disable the stack destructor to destroy the resources of a stack before deleting the stack itself	`bool`	`false`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
terraform_version	Specify the version of Terraform to use for the stack	`string`	`null`	no
terraform_version_map	A map to determine which Terraform patch version to use for each minor version	`map(string)`	`{}`	no
webhook_enabled	Flag to enable/disable the webhook endpoint to which Spacelift sends the POST requests about run state changes	`bool`	`false`	no
webhook_endpoint	Webhook endpoint to which Spacelift sends the POST requests about run state changes	`string`	`null`	no
webhook_secret	Webhook secret used to sign each POST request so you're able to verify that the requests come from Spacelift	`string`	`null`	no
worker_pool_id	The immutable ID (slug) of the default worker pool	`string`	`null`	no
worker_pool_name_id_map	Map of worker pool names to worker pool IDs. If this map is not provided or a worker pool name is not specified for a stack in YAML config, `var.worker_pool_id` will be used to assign a worker pool to the stack	`map(string)`	`{}`	no

Outputs

Name	Description
stacks	Generated stacks

Share the Love

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. =)

Related Projects

Check out these related projects.

terraform-provider-utils - The Cloud Posse Terraform Provider for various utilities.
terraform-yaml-stack-config - Terraform module that loads an opinionated stack configuration from local or remote YAML sources. It supports deep-merged variables, settings, ENV variables, backend config, and remote state outputs for Terraform and helmfile components.
terraform-yaml-config - Terraform module to convert local and remote YAML configuration templates into Terraform lists and maps.

References

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
Spacelift - The most flexible CI/CD for Terraform
Spacelift Documentation - Official documentation site for Spacelift
Open Policy Agent - Policy-based control for cloud native environments
OPA Documentation - Open Policy Agent Documentation
Rego - OPA’s query and policy language - Rego focuses on providing powerful support for referencing nested documents and ensuring that queries are correct and unambiguous
Example of using Rego policy language - Mutating Admissions Controllers with Open Policy Agent and Rego

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

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.

Slack Community

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.

Discourse Forums

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.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

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!

Copyrights

License

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

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.

Contributors

Erik Osterman	Dan Meyers	Andriy Knysh	RB	Yonatan Koren

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

cloudposse / terraform-spacelift-cloud-infrastructure-automation

Programming Languages