remote-state

Terraform module that accepts a component and a stack name and returns remote state outputs for the component.

The module supports all backends supported by Terraform and OpenTofu, plus the Atmos-specific static backend.

Errors

note

If you experience an error from the terraform_remote_state data source, this is most likely not an error in this module, but rather an error in the remote_state configuration in the referenced stack. This module performs no validation on the remote state configuration, and only modifies the configuration for the remote backend (to set the workspace name) and, only when var.privileged is set to true, the s3 configuration (to remove settings for assuming a role). If var.privileged is left at the default value of false and you are not using the remote backend, then this module will not modify the backend configuration in any way.

"Local" Backend

important

If the local backend has a relative path, it will be resolved relative to the current working directory, which is usually a root module referencing the remote state. However, when the local backend is created, the current working directory is the directory where the target root module is defined. This can cause the lookup to fail if the source is not reachable from the client directory as ../source.

For example, if your directory structure looks like this:

project
├── components
│   ├── client
│   │   └── main.tf
│   └── complex
│       └── source
│           └── main.tf
└── local-state
    └── complex
        └── source
            └── terraform.tfstate

Terraform code in project/components/complex/source can create its local state file (terraform.tfstate) in the local-state/complex/source directory using path = "../../../local-state/complex/source/terraform.tfstate". However, Terraform code in project/components/client that references the same local state using the same backend configuration will fail because the current working directory is project/components/client and the relative path will not resolve correctly.

Usage

The following example accepts a stack config my-stack (which in turn imports other YAML config dependencies) and returns remote state outputs from the s3 backend for my-vpc and eks Terraform components.

NOTE: The backend type (s3) and backend configuration for the components are defined in the stack YAML config files.

  module "remote_state_my_vpc" {
    source = "cloudposse/stack-config/yaml//modules/remote-state"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
  
    stack                   = "my-stack"
    component               = "my-vpc"
  }
  
  module "remote_state_eks" {
    source = "cloudposse/stack-config/yaml//modules/remote-state"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
  
    stack                   = "my-stack"
    component               = "eks"
  }

See examples/remote-state for more details.

Requirements

Name	Version
terraform	>= 1.1.0
external	>= 2.0
local	>= 1.3
utils	>= 1.7.1, < 2.0.0

Providers

Name	Version
terraform	n/a
utils	>= 1.7.1, < 2.0.0

Modules

Name	Source	Version
always	cloudposse/label/null	0.25.0

Resources

Name	Type
terraform_remote_state.data_source	data source
utils_component_config.config	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
atmos_base_path	atmos base path to components and stacks	string	null	no
atmos_cli_config_path	atmos CLI config path	string	null	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
bypass	Set to true to skip looking up the remote state and just return the defaults	bool	false	no
component	Component	string	n/a	yes
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
defaults	Default values if the data source is empty	any	null	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	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
env	Map of ENV vars in the format key=value. These ENV vars will be set in the utils provider before executing the data source	map(string)	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	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
ignore_errors	Set to true to ignore errors from the 'utils' provider (if the component is not found in the stack)	bool	false	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_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
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
privileged	True if the caller already has access to the backend without assuming roles	bool	false	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
stack	Stack name	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
workspace	Workspace (this overrides the workspace calculated from the context)	string	null	no

Outputs

Name	Description
backend	Backend configuration for the component
backend_type	Backend type
outputs	Remote state
remote_workspace_name	(DEPRECATED: use workspace_name instead): Terraform workspace name for the component remote backend
s3_workspace_name	(DEPRECATED: use workspace_name instead): Terraform workspace name for the component s3 backend
workspace_name	Terraform workspace name from which to retrieve the Terraform state