Skip to content

Latest commit

 

History

History
127 lines (107 loc) · 15.4 KB

README.md

File metadata and controls

127 lines (107 loc) · 15.4 KB

Component: account-map

This component is responsible for provisioning information only: it simply populates Terraform state with data (account ids, groups, and roles) that other root modules need via outputs.

Usage

Stack Level: Global

Here's an example snippet for how to use this component. Stick this snippet in the management account's stack (E.g. gbl-root.yaml)

components:
  terraform:
    account-map:
      vars:
        enabled: true
        # Since this is false, role_arn must be provided instead of profile in each terraform backend
        # profiles_enabled: false
        root_account_aws_name: "aws-root"
        root_account_account_name: root
        identity_account_account_name: identity
        dns_account_account_name: dns
        audit_account_account_name: audit
        # The template used to render Role ARNs.
        # Note that if the `null-label` variable `label_order` is truncated or extended with additional labels, this template will
        # need to be updated to reflect the new number of labels.
        iam_role_arn_template: "arn:aws:iam::%s:role/%s-%s-%s-%s"
        # The template used to render AWS Profile names.
        # Note that if the `null-label` variable `label_order` is truncated or extended with additional labels, this template will
        # need to be updated to reflect the new number of labels.
        profile_template: "%s-%s-%s-%s"

Requirements

Name Version
terraform >= 1.0.0
aws >= 3.0

Providers

Name Version
aws >= 3.0

Modules

Name Source Version
accounts cloudposse/stack-config/yaml//modules/remote-state 0.22.3
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_organizations_organization.organization data source
aws_partition.current 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
artifacts_account_account_name The stage name for the artifacts account string "artifacts" 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
audit_account_account_name The stage name for the audit account string "audit" 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
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
dns_account_account_name The stage name for the primary DNS account string "dns" 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
global_environment_name Global environment name string "gbl" no
iam_role_arn_template_template The template for the template used to render Role ARNs.
The template is first used to render a template for the account that takes only the role name.
Then that rendered template is used to create the final Role ARN for the account.
Default is appropriate when using tenant and default label order with null-label.
Use "arn:%s:iam::%s:role/%s-%s-%s-%%s" when not using tenant.


Note that if the null-label variable label_order is truncated or extended with additional labels, this template will
need to be updated to reflect the new number of labels.		 string "arn:%s:iam::%s:role/%s-%s-%s-%s-%%s" 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
identity_account_account_name The stage name for the account holding primary IAM roles string "identity" 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
profile_template The template used to render AWS Profile names.
Default is appropriate when using tenant and default label order with null-label.
Use "%s-%s-%s-%s" when not using tenant.

Note that if the null-label variable label_order is truncated or extended with additional labels, this template will
need to be updated to reflect the new number of labels.		 string "%s-%s-%s-%s-%s" no
profiles_enabled Whether or not to enable profiles instead of roles for the backend. If true, profile must be set. If false, role_arn must be set. 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
region AWS Region string n/a yes
root_account_account_name The stage name for the root account string "root" no
root_account_aws_name The name of the root account as reported by AWS 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

Outputs

Name Description
account_info_map A map from account name to various information about the account.
See the account_info_map output of account for more detail.
all_accounts A list of all accounts in the AWS Organization
artifacts_account_account_name The short name for the artifacts account
audit_account_account_name The short name for the audit account
aws_partition The AWS "partition" to use when constructing resource ARNs
cicd_profiles A list of all SSO profiles used by cicd platforms
cicd_roles A list of all IAM roles used by cicd platforms
dns_account_account_name The short name for the primary DNS account
eks_accounts A list of all accounts in the AWS Organization that contain EKS clusters
full_account_map The map of account name to account ID (number).
helm_profiles A list of all SSO profiles used to run helm updates
helm_roles A list of all IAM roles used to run helm updates
iam_role_arn_templates Map of accounts to corresponding IAM Role ARN templates
identity_account_account_name The short name for the account holding primary IAM roles
non_eks_accounts A list of all accounts in the AWS Organization that do not contain EKS clusters
org The name of the AWS Organization
profiles_enabled Whether or not to enable profiles instead of roles for the backend
root_account_account_name The short name for the root account
root_account_aws_name The name of the root account as reported by AWS
terraform_profiles A list of all SSO profiles used to run terraform updates
terraform_roles A list of all IAM roles used to run terraform updates

References