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.

Usage

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
components:
  terraform:
    admin-stack/default:
      metadata:
        type: abstract
        component: spacelift/admin-stack
      settings:
        spacelift:
          administrative: true
          autodeploy: true
          before_apply:
            - spacelift-configure-paths
          before_init:
            - spacelift-configure-paths
            - spacelift-write-vars
            - spacelift-tf-workspace
          before_plan:
            - spacelift-configure-paths
          drift_detection_enabled: true
          drift_detection_reconcile: true
          drift_detection_schedule:
            - 0 4 * * *
          manage_state: false
          policies: {}
      vars:
        # Organization specific configuration
        branch: main
        repository: infrastructure
        worker_pool_name: "acme-core-ue1-auto-spacelift-worker-pool"
        runner_image: 111111111111.dkr.ecr.us-east-1.amazonaws.com/infrastructure:latest
        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
import:
  - mixins/region/global-region
  - orgs/acme/_defaults
  - catalog/terraform/spacelift/admin-stack
  - catalog/terraform/spacelift/spaces

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

components:
  terraform:
    # This admin stack creates other "admin" stacks
    admin-stack:
      metadata:
        component: spacelift/admin-stack
        inherits:
          - admin-stack/default
      settings:
        spacelift:
          root_administrative: true
          labels:
            - root-admin
            - admin
      vars:
        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
        labels:
          - admin
        # attachments only on the root stack
        root_stack_policy_attachments:
          - TRIGGER Global administrator
        # this creates policies for the children (admin) stacks
        child_policy_attachments:
          - TRIGGER Global administrator

Finally, define any tenant-specific stacks:

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

vars:
  tenant: core
  environment: gbl
  stage: spacelift

components:
  terraform:
    admin-stack:
      metadata:
        component: spacelift/admin-stack
        inherits:
          - admin-stack/default
      settings:
        spacelift:
          labels: # Additional labels for this stack
            - admin-stack-name:core
      vars:
        enabled: true
        context_filters:
          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
        child_policy_attachments:
          - TRIGGER Dependencies

Requirements

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

Providers

Name	Version
null	>= 3.0
spacelift	>= 0.1.31

Modules

Name	Source	Version
all_admin_stacks_config	cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config	1.5.0
child_stack	cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stack	1.6.0
child_stacks_config	cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config	1.5.0
root_admin_stack	cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stack	1.6.0
root_admin_stack_config	cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config	1.5.0
spaces	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
null_resource.child_stack_parent_precondition	resource
null_resource.public_workers_precondition	resource
null_resource.spaces_precondition	resource
null_resource.workers_precondition	resource
spacelift_policy_attachment.root	resource
spacelift_policies.this	data source
spacelift_stacks.this	data source
spacelift_worker_pools.this	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
admin_stack_label	Label to use to identify the admin stack when creating the child stacks	`string`	`"admin-stack-name"`	no
allow_public_workers	Whether to allow public workers to be used for this stack	`bool`	`false`	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	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
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
child_policy_attachments	List of policy attachments to attach to the child stacks created by this module	`set(string)`	`[]`	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_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
context_filters	Context filters to select atmos stacks matching specific criteria to create as children.	`object({ 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) })`	n/a	yes
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`	`null`	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
excluded_context_filters	Context filters to exclude from stacks matching specific criteria of `var.context_filters`.	`object({ namespaces = optional(list(string), []) environments = optional(list(string), []) tenants = optional(list(string), []) stages = optional(list(string), []) tags = optional(map(string), {}) })`	`{}`	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`	`false`	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
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
root_admin_stack	Flag 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.	`bool`	`false`	no
root_stack_policy_attachments	List of policy attachments to attach to the root admin stack	`set(string)`	`[]`	no
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_spaces_component_name	The component name of the spacelift spaces component	`string`	`"spacelift/spaces"`	no
spacelift_spaces_environment_name	The environment name of the spacelift spaces component	`string`	`null`	no
spacelift_spaces_stage_name	The stage name of the spacelift spaces component	`string`	`null`	no
spacelift_spaces_tenant_name	The tenant name of the spacelift spaces component	`string`	`null`	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`	`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
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_version_map	A map to determine which Terraform patch version to use for each minor version	`map(string)`	`{}`	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_name	The atmos stack name of the worker pool. Example: `acme-core-ue2-auto-spacelift-default-worker-pool`	`string`	`null`	no

Outputs

Name	Description
child_stacks	All children stacks managed by this component
root_stack	The root stack, if enabled and created by this component
root_stack_id	The stack id

Component: spacelift/admin-stack

Usage​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​