Module: spacelift-stack

Terraform module to provisions a Spacelift space.

Usage

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

provider "spacelift" {}

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

  atmos_stack_name  = "plat-ue1-prod-test-component"
  stack_name        = "plat-ue1-prod-test-component"
  component_name    = "test-component"
  component_root    = "examples/test-component"
  repository        = "spacelift-demo"
  branch            = "main"
  autodeploy        = true
  terraform_version = "1.4.6"

Examples

Here is an example of using this module:

• ../../examples/spacelift-stack - complete example of using this module

Requirements

Name	Version
terraform	>= 0.13.0
spacelift	>= 0.1.31

Providers

Name	Version
spacelift	>= 0.1.31

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
spacelift_aws_role.this	resource
spacelift_context_attachment.this	resource
spacelift_drift_detection.this	resource
spacelift_environment_variable.component_env_vars	resource
spacelift_environment_variable.component_name	resource
spacelift_environment_variable.stack_name	resource
spacelift_mounted_file.stack_config	resource
spacelift_policy_attachment.this	resource
spacelift_run.this	resource
spacelift_stack.this	resource
spacelift_stack_dependency.default	resource
spacelift_stack_destructor.this	resource
spacelift_webhook.this	resource

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
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
atmos_stack_name	The name of the atmos stack	string	n/a	yes
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	Controls the Spacelift 'autodeploy' option for a stack	bool	false	no
autoretry	Controls the Spacelift 'autoretry' option for a stack	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
azure_devops	Azure DevOps VCS settings	map(any)	null	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
bitbucket_cloud	Bitbucket Cloud VCS settings	map(any)	null	no
bitbucket_datacenter	Bitbucket Datacenter VCS settings	map(any)	null	no
branch	Specify which branch to use within your infrastructure repo	string	"main"	no
cloudformation	CloudFormation-specific configuration. Presence means this Stack is a CloudFormation Stack.	map(any)	null	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_env	Map of component ENV variables	any	{}	no
component_name	The name of the concrete component (typically a directory name)	string	n/a	yes
component_root	The path, relative to the root of the repository, where the component can be found	string	n/a	yes
component_vars	All Terraform values to be applied to the stack via a mounted file	any	{}	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 this stack	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
description	Specify description of stack	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
drift_detection_timezone	Timezone in which the schedule is expressed. Defaults to UTC.	string	"UTC"	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
github_enterprise	GitHub Enterprise (self-hosted) VCS settings	map(any)	null	no
gitlab	GitLab VCS settings	map(any)	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	A list of labels for the 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	Flag to enable/disable manage_state setting in stack	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
policy_ids	List of Rego policy IDs to attach to this stack	list(string)	[]	no
protect_from_deletion	Flag to enable/disable deletion protection.	bool	false	no
pulumi	Pulumi-specific configuration. Presence means this Stack is a Pulumi Stack.	map(any)	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
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
showcase	Showcase settings	map(any)	null	no
space_id	Place the stack in the specified space_id.	string	"root"	no
spacelift_run_enabled	Enable/disable creation of the spacelift_run resource	bool	false	no
spacelift_stack_dependency_enabled	If enabled, the spacelift_stack_dependency Spacelift resource will be used to create dependencies between stacks instead of using the depends-on labels. The depends-on labels will be removed from the stacks and the trigger policies for dependencies will be detached	bool	false	no
stack_destructor_enabled	Flag to enable/disable the stack destructor to destroy the resources of the stack before deleting the stack itself	bool	false	no
stack_name	The name of the Spacelift stack	string	n/a	yes
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_smart_sanitization	Whether or not to enable Smart Sanitization which will only sanitize values marked as sensitive.	bool	false	no
terraform_version	Specify the version of Terraform to use for the stack	string	null	no
terraform_workflow_tool	Defines the tool that will be used to execute the workflow. This can be one of OPEN_TOFU, TERRAFORM_FOSS or CUSTOM. Defaults to TERRAFORM_FOSS.	string	"TERRAFORM_FOSS"	no
terraform_workspace	Specify the Terraform workspace to use for the stack	string	null	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 worker pool	string	null	no

Outputs

Name	Description
id	The stack id
stack	The created stack