Skip to main content

Component: spacelift/admin-stack

This component is responsible for creating an administrative stack and its corresponding child stacks in the Spacelift organization.

The component uses a series of context_filters to select atmos component instances to manage as child stacks.


Stack Level: Global

The following are example snippets of how to use this component. For more on Spacelift admin stack usage, see the Spacelift README

First define the default configuration for any admin stack:

# stacks/catalog/spacelift/admin-stack.yaml
type: abstract
component: spacelift/admin-stack
administrative: true
autodeploy: true
- spacelift-configure-paths
- spacelift-configure-paths
- spacelift-write-vars
- spacelift-tf-workspace
- spacelift-configure-paths
drift_detection_enabled: true
drift_detection_reconcile: true
- 0 4 * * *
manage_state: false
policies: {}
# Organization specific configuration
branch: main
repository: infrastructure
worker_pool_name: "acme-core-ue1-auto-spacelift-worker-pool"
spacelift_spaces_stage_name: "root"
# These values need to be manually updated as external configuration changes
# This should match the version set in the Dockerfile and be updated when the version changes.
terraform_version: "1.3.6"
# Common configuration
administrative: true # Whether this stack can manage other stacks
component_root: components/terraform

Then define the root-admin stack:

# stacks/orgs/acme/spacelift.yaml
- mixins/region/global-region
- orgs/acme/_defaults
- catalog/terraform/spacelift/admin-stack
- catalog/terraform/spacelift/spaces

# These intentionally overwrite the default values
tenant: root
environment: gbl
stage: spacelift

# This admin stack creates other "admin" stacks
component: spacelift/admin-stack
- admin-stack/default
root_administrative: true
- root-admin
- admin
enabled: true
root_admin_stack: true # This stack will be created in the root space and will create all the other admin stacks as children.
context_filters: # context_filters determine which child stacks to manage with this admin stack
administrative: true # This stack is managing all the other admin stacks
root_administrative: false # We don't want this stack to also find itself in the config and add itself a second time
- admin
# attachments only on the root stack
- TRIGGER Global administrator
# this creates policies for the children (admin) stacks
- TRIGGER Global administrator

Finally, define any tenant-specific stacks:

# stacks/orgs/acme/core/spacelift.yaml
- mixins/region/global-region
- orgs/acme/core/_defaults
- catalog/terraform/spacelift/admin-stack

tenant: core
environment: gbl
stage: spacelift

component: spacelift/admin-stack
- admin-stack/default
labels: # Additional labels for this stack
- admin-stack-name:core
enabled: true
tenants: ["core"]
labels: # Additional labels added to all children
- admin-stack-name:core # will be used to automatically create the `managed-by:stack-name` label
- TRIGGER Dependencies


terraform>= 1.3
aws>= 4.0
null>= 3.0
spacelift>= 0.1.31
utils>= 1.14.0


null>= 3.0
spacelift>= 0.1.31




spacelift_policies.thisdata source
spacelift_stacks.thisdata source
spacelift_worker_pools.thisdata source


additional_tag_mapAdditional 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.
admin_stack_labelLabel to use to identify the admin stack when creating the child stacksstring"admin-stack-name"no
allow_public_workersWhether to allow public workers to be used for this stackboolfalseno
attributesID 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.
autodeployControls the Spacelift 'autodeploy' option for a stackboolfalseno
autoretryControls the Spacelift 'autoretry' option for a stackboolfalseno
aws_role_arnARN of the AWS IAM role to assume and put its temporary credentials in the runtime environmentstringnullno
aws_role_enabledFlag to enable/disable Spacelift to use AWS STS to assume the supplied IAM role and put its temporary credentials in the runtime environmentboolfalseno
aws_role_external_idCustom external ID (works only for private workers). See for more detailsstringnullno
aws_role_generate_credentials_in_workerFlag to enable/disable generating AWS credentials in the private worker after assuming the supplied IAM rolebooltrueno
azure_devopsAzure DevOps VCS settingsmap(any)nullno
bitbucket_cloudBitbucket Cloud VCS settingsmap(any)nullno
bitbucket_datacenterBitbucket Datacenter VCS settingsmap(any)nullno
branchSpecify which branch to use within your infrastructure repostring"main"no
child_policy_attachmentsList of policy attachments to attach to the child stacks created by this moduleset(string)[]no
cloudformationCloudFormation-specific configuration. Presence means this Stack is a CloudFormation
commit_shaThe commit SHA for which to trigger a run. Requires var.spacelift_run_enabled to be set to truestringnullno
component_envMap of component ENV variablesany{}no
component_rootThe path, relative to the root of the repository, where the component can be foundstringn/ayes
component_varsAll Terraform values to be applied to the stack via a mounted fileany{}no
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
context_attachmentsA list of context IDs to attach to this stacklist(string)[]no
context_filtersContext filters to select atmos stacks matching specific criteria to create as children.
namespaces = optional(list(string), [])
environments = optional(list(string), [])
tenants = optional(list(string), [])
stages = optional(list(string), [])
tags = optional(map(string), {})
administrative = optional(bool)
root_administrative = optional(bool)
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptionSpecify description of stackstringnullno
descriptor_formatsDescribe 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).
drift_detection_enabledFlag to enable/disable drift detection on the infrastructure stacksboolfalseno
drift_detection_reconcileFlag 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 driftboolfalseno
drift_detection_scheduleList of cron expressions to schedule drift detection for the infrastructure stackslist(string)
"0 4 * * *"
drift_detection_timezoneTimezone in which the schedule is expressed. Defaults to UTC.stringnullno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
excluded_context_filtersContext filters to exclude from stacks matching specific criteria of var.context_filters.
namespaces = optional(list(string), [])
environments = optional(list(string), [])
tenants = optional(list(string), [])
stages = optional(list(string), [])
tags = optional(map(string), {})
github_enterpriseGitHub Enterprise (self-hosted) VCS settingsmap(any)nullno
gitlabGitLab VCS settingsmap(any)nullno
id_length_limitLimit 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labelsA list of labels for the stacklist(string)[]no
labels_as_tagsSet 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.
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.
local_preview_enabledIndicates whether local preview runs can be triggered on this Stackboolfalseno
manage_stateFlag to enable/disable manage_state setting in stackboolfalseno
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
protect_from_deletionFlag to enable/disable deletion protection.boolfalseno
pulumiPulumi-specific configuration. Presence means this Stack is a Pulumi
regex_replace_charsTerraform 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.
repositoryThe name of your infrastructure repostringn/ayes
root_admin_stackFlag to indicate if this stack is the root admin stack. In this case, the stack will be created in the root space and will create all the other admin stacks as children.boolfalseno
root_stack_policy_attachmentsList of policy attachments to attach to the root admin stackset(string)[]no
runner_imageThe full image name and tag of the Docker image to use in Spaceliftstringnullno
showcaseShowcase settingsmap(any)nullno
space_idPlace the stack in the specified space_idstring"root"no
spacelift_run_enabledEnable/disable creation of the spacelift_run resourceboolfalseno
spacelift_spaces_component_nameThe component name of the spacelift spaces componentstring"spacelift/spaces"no
spacelift_spaces_environment_nameThe environment name of the spacelift spaces componentstringnullno
spacelift_spaces_stage_nameThe stage name of the spacelift spaces componentstringnullno
spacelift_spaces_tenant_nameThe tenant name of the spacelift spaces componentstringnullno
spacelift_stack_dependency_enabledIf 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 detachedboolfalseno
stack_destructor_enabledFlag to enable/disable the stack destructor to destroy the resources of the stack before deleting the stack itselfboolfalseno
stack_nameThe name of the Spacelift stackstringnullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
terraform_smart_sanitizationWhether or not to enable Smart Sanitization which will only sanitize values marked as sensitive.boolfalseno
terraform_versionSpecify the version of Terraform to use for the stackstringnullno
terraform_version_mapA map to determine which Terraform patch version to use for each minor versionmap(string){}no
terraform_workflow_toolDefines 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_workspaceSpecify the Terraform workspace to use for the stackstringnullno
webhook_enabledFlag to enable/disable the webhook endpoint to which Spacelift sends the POST requests about run state changesboolfalseno
webhook_endpointWebhook endpoint to which Spacelift sends the POST requests about run state changesstringnullno
webhook_secretWebhook secret used to sign each POST request so you're able to verify that the requests come from Spaceliftstringnullno
worker_pool_nameThe atmos stack name of the worker pool. Example: acme-core-ue2-auto-spacelift-default-worker-poolstringnullno


child_stacksAll children stacks managed by this component
root_stackThe root stack, if enabled and created by this component
root_stack_idThe stack id