Home

Awesome

terraform-spacelift-policies

Release

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.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.0
<a name="requirement_http"></a> http>= 3.0
<a name="requirement_spacelift"></a> spacelift>= 1.0

Providers

NameVersion
<a name="provider_http"></a> http>= 3.0
<a name="provider_spacelift"></a> spacelift>= 1.0

Modules

NameSourceVersion
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
spacelift_policy.defaultresource
http_http.defaultdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the delimiter<br>and treated as a single ID element.list(string)[]no
<a name="input_context"></a> contextSingle object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as null to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre>no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>{<br> format = string<br> labels = list(string)<br>}<br>(Type is any so the map values can later be enhanced to provide additional options.)<br>format is a Terraform format string to be passed to the format() function.<br>labels is a list of labels, in order, to pass to format() function.<br>Label values will be normalized before being passed to format() so they will be<br>identical to how they appear in id.<br>Default is {} (descriptors output will be empty).any{}no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br>Set to 0 for unlimited length.<br>Set to null for keep the existing setting, which defaults to 0.<br>Does not affect id_full.numbernullno
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the tags input.<br>Possible values: lower, title, upper.<br>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the tags input.<br>Possible values: lower, title, upper and none (no transformation).<br>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the tags output.<br>Set to [] to suppress all generated tags.<br>Notes:<br> The value of the name tag, if included, will be the id, not the name.<br> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br> "default"<br>]</pre>no
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a tag.<br>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_policies"></a> policiesMap of Policies with their configurations.<pre>map(object({<br> body = optional(string, null)<br> body_url = optional(string, null)<br> body_file = optional(string, null)<br> type = string<br> description = optional(string, null)<br> labels = optional(list(string), [])<br> space_id = optional(string, null)<br> }))</pre>{}no
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
<a name="output_all"></a> allA map of Spacelift Policies with their attributes.
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

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 hello@masterpoint.io.

Built By

Masterpoint Logo