terraform-spacelift-policies

This Terraform module allows you to manage [Spacelift Policies]((https://docs.spacelift.io/concepts/policy/) in a flexible way. It enables you to define multiple policies with various configurations, including providing the policy code directly, via a URL, or from a file.

A Spacelift Policy is a set of rules and conditions defined to manage and control the behavior of infrastructure as code (IaC) workflows within the Spacelift platform. Spacelift policies are written using the Rego language, which is part of the Open Policy Agent (OPA) framework. These policies can enforce security, compliance, and operational best practices, ensuring that infrastructure changes adhere to organizational standards.

Tip

Attaching Policies to Spacelift Stacks

Spacelift Policies can be attached to Spacelift Stacks via labels! See the official Spacelift documentation that shows how policies with the label autoattach:* attaches to all stacks and autoattach:label_here attaches to all stacks with the label_here label.

Usage

Here’s an example of how to use this module in your Terraform configuration:

module "spacelift_policies" {
  source = "masterpointio/spacelift/policies"
  # Set a specific version
  # version = "X.X.X"

  policies = {
    # Policy defined with 'body'
    "access-default" = {
      body        = <<-EOT
        package spacelift
        default allow = true
      EOT
      type        = "ACCESS"
      description = "Policy allowing access to resources"
      labels      = ["team:sre", "env:dev"]
    }

    # Policy defined with 'body_url'
    "plan-review-helper" = {
      body_url    = "https://example.com/policies/plan_policy.rego"
      type        = "PLAN"
      description = "Helps humans understand changes, and make informed decisions"
      labels      = ["team:sre", "env:staging"]
    }

    # Policy defined with 'body_file'
    "approval-role-based" = {
      body_file   = "policies/approval.role-based.rego"
      type        = "APPROVAL"
      description = "Gives certain roles the power to approve prod workloads."
      labels      = ["env:prod", "autoattach:needs-approvers"] # This policy will be auto-attached to stacks with the 'needs-approvers' label.
    }
  }
}

Tip

Testing your Spacelift OPA Rego Policies

Spacelift Policies use the Open Policy Agent (OPA) Rego language. You can test your policies using the Rego Playground.

Masterpoint has an open-source GitHub Action to automate the testing of OPA Rego policies. It is also showcased on OPA Ecosystem's Integrations page.

Requirements

Name	Version
terraform	>= 1.0
http	>= 3.0
spacelift	>= 1.0

Providers

Name	Version
http	>= 3.0
spacelift	>= 1.0

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
spacelift_policy.default	resource
http_http.default	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
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
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
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
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
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
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_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
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	Map of Policies with their configurations.	map(object({ body = optional(string, null) body_url = optional(string, null) body_file = optional(string, null) type = string description = optional(string, null) labels = optional(list(string), []) space_id = optional(string, null) }))	{}	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
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

Outputs

Name	Description
all	A map of Spacelift Policies with their attributes.

Contributing

Contributions are welcome and appreciated!

Found an issue or want to request a feature? Open an issue

Want to fix a bug you found or add some functionality? Fork, clone, commit, push, and PR and we'll check it out.

If you have any issues or are waiting a long time for a PR to get merged then feel free to ping us at [email protected].

Built By