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

Variables

Required Variables

component_root (string) required

The path, relative to the root of the repository, where the component can be found

context_filters required

Context filters to select atmos stacks matching specific criteria to create as children.

Type:

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)
})

repository (string) required

The name of your infrastructure repo

Optional Variables

admin_stack_label (string) optional

Label to use to identify the admin stack when creating the child stacks

Default value: "admin-stack-name"

allow_public_workers (bool) optional

Whether to allow public workers to be used for this stack

Default value: false

autodeploy (bool) optional

Controls the Spacelift 'autodeploy' option for a stack

Default value: false

autoretry (bool) optional

Controls the Spacelift 'autoretry' option for a stack

Default value: false

aws_role_arn (string) optional

ARN of the AWS IAM role to assume and put its temporary credentials in the runtime environment

Default value: null

aws_role_enabled (bool) optional

Flag to enable/disable Spacelift to use AWS STS to assume the supplied IAM role and put its temporary credentials in the runtime environment

Default value: false

aws_role_external_id (string) optional

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

Default value: null

aws_role_generate_credentials_in_worker (bool) optional

Flag to enable/disable generating AWS credentials in the private worker after assuming the supplied IAM role

Default value: true

azure_devops (map(any)) optional

Azure DevOps VCS settings

Default value: null

bitbucket_cloud (map(any)) optional

Bitbucket Cloud VCS settings

Default value: null

bitbucket_datacenter (map(any)) optional

Bitbucket Datacenter VCS settings

Default value: null

branch (string) optional

Specify which branch to use within your infrastructure repo

Default value: "main"

child_policy_attachments (set(string)) optional

List of policy attachments to attach to the child stacks created by this module

Default value: [ ]

cloudformation (map(any)) optional

CloudFormation-specific configuration. Presence means this Stack is a CloudFormation Stack.

Default value: null

commit_sha (string) optional

The commit SHA for which to trigger a run. Requires var.spacelift_run_enabled to be set to true

Default value: null

component_env (any) optional

Map of component ENV variables

Default value: { }

component_vars (any) optional

All Terraform values to be applied to the stack via a mounted file

Default value: { }

context_attachments (list(string)) optional

A list of context IDs to attach to this stack

Default value: [ ]

description (string) optional

Specify description of stack

Default value: null

drift_detection_enabled (bool) optional

Flag to enable/disable drift detection on the infrastructure stacks

Default value: false

drift_detection_reconcile (bool) optional

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

Default value: false

drift_detection_schedule (list(string)) optional

List of cron expressions to schedule drift detection for the infrastructure stacks

Default value:

[
  "0 4 * * *"
]

drift_detection_timezone (string) optional

Timezone in which the schedule is expressed. Defaults to UTC.

Default value: null

excluded_context_filters optional

Context filters to exclude from stacks matching specific criteria of var.context_filters.

Type:

object({
namespaces   = optional(list(string), [])
environments = optional(list(string), [])
tenants      = optional(list(string), [])
stages       = optional(list(string), [])
tags         = optional(map(string), {})
})

Default value: { }

github_enterprise (map(any)) optional

GitHub Enterprise (self-hosted) VCS settings

Default value: null

gitlab (map(any)) optional

GitLab VCS settings

Default value: null

labels (list(string)) optional

A list of labels for the stack

Default value: [ ]

local_preview_enabled (bool) optional

Indicates whether local preview runs can be triggered on this Stack

Default value: false

manage_state (bool) optional

Flag to enable/disable manage_state setting in stack

Default value: false

protect_from_deletion (bool) optional

Flag to enable/disable deletion protection.

Default value: false

pulumi (map(any)) optional

Pulumi-specific configuration. Presence means this Stack is a Pulumi Stack.

Default value: null

root_admin_stack (bool) optional

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.

Default value: false

root_stack_policy_attachments (set(string)) optional

List of policy attachments to attach to the root admin stack

Default value: [ ]

runner_image (string) optional

The full image name and tag of the Docker image to use in Spacelift

Default value: null

showcase (map(any)) optional

Showcase settings

Default value: null

space_id (string) optional

Place the stack in the specified space_id

Default value: "root"

spacelift_run_enabled (bool) optional

Enable/disable creation of the spacelift_run resource

Default value: false

spacelift_spaces_component_name (string) optional

The component name of the spacelift spaces component

Default value: "spacelift/spaces"

spacelift_spaces_environment_name (string) optional

The environment name of the spacelift spaces component

Default value: null

spacelift_spaces_stage_name (string) optional

The stage name of the spacelift spaces component

Default value: null

spacelift_spaces_tenant_name (string) optional

The tenant name of the spacelift spaces component

Default value: null

spacelift_stack_dependency_enabled (bool) optional

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

Default value: false

stack_destructor_enabled (bool) optional

Flag to enable/disable the stack destructor to destroy the resources of the stack before deleting the stack itself

Default value: false

stack_name (string) optional

The name of the Spacelift stack

Default value: null

terraform_smart_sanitization (bool) optional

Whether or not to enable Smart Sanitization which will only sanitize values marked as sensitive.

Default value: false

terraform_version (string) optional

Specify the version of Terraform to use for the stack

Default value: null

terraform_version_map (map(string)) optional

A map to determine which Terraform patch version to use for each minor version

Default value: { }

terraform_workflow_tool (string) optional

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.

Default value: "TERRAFORM_FOSS"

terraform_workspace (string) optional

Specify the Terraform workspace to use for the stack

Default value: null

webhook_enabled (bool) optional

Flag to enable/disable the webhook endpoint to which Spacelift sends the POST requests about run state changes

Default value: false

webhook_endpoint (string) optional

Webhook endpoint to which Spacelift sends the POST requests about run state changes

Default value: null

webhook_secret (string) optional

Webhook secret used to sign each POST request so you're able to verify that the requests come from Spacelift

Default value: null

worker_pool_name (string) optional

The atmos stack name of the worker pool. Example: acme-core-ue2-auto-spacelift-default-worker-pool

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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

Dependencies

Requirements

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

Providers

null, version: >= 3.0
spacelift, version: >= 0.1.31

Modules

Name	Version	Source	Description
`all_admin_stacks_config`	1.5.0	`cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config`	This gets the atmos stack config for all of the administrative stacks
`child_stack`	1.6.0	`cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stack`	n/a
`child_stacks_config`	1.5.0	`cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config`	Get all of the stack configurations from the atmos config that matched the context_filters and create a stack for each one.
`root_admin_stack`	1.6.0	`cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stack`	n/a
`root_admin_stack_config`	1.5.0	`cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-stacks-from-atmos-config`	The root admin stack is a special stack that is used to manage all of the other admin stacks in the the Spacelift organization. This stack is denoted by setting the root_administrative property to true in the atmos config. Only one such stack is allowed in the Spacelift organization.
`spaces`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

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)

Data Sources

The following data sources are used by this module:

spacelift_policies.this (data source)
spacelift_stacks.this (data source)
spacelift_worker_pools.this (data source)

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources