diff --git a/README.md b/README.md
index 865dbf2..d1aebcf 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,100 @@
-# terraform-module-template
+# terraform-spacelift-aws-integrations
-[](https://github.com/masterpointio/terraform-module-template/releases/latest)
+[](https://github.com/masterpointio/terraform-spacelift-aws-integrations/releases/latest)
-This repository serves as a template for creating Terraform modules, providing a standardized structure and essential files for efficient module development. It's designed to ensure consistency and best practices across Terraform projects.
+This root module is responsible for managing the Spacelift Cloud [AWS Integration](https://docs.spacelift.io/integrations/cloud-providers/aws#amazon-web-services-aws) as code.
+
+It allows to define and manage multiple AWS integrations within Spacelift, facilitating secure interactions between your Spacelift stacks and AWS accounts. Cloud Integration is account-level and needs to be explicitly attached to individual stacks in order to take effect.
+
+This module replaces the deprecated `spacelift_aws_role` resource and [is recommended](https://registry.terraform.io/providers/spacelift-io/spacelift/latest/docs/resources/aws_role) for use instead.
## Usage
-TODO
+Here’s an example of how to use this module in your Terraform configuration:
+
+```hcl
+module "spacelift_aws_integrations" {
+ source = "masterpointio/spacelift/aws-integrations"
+ # Specify a specific version
+ # version = "X.X.X"
+
+ aws_integrations = {
+ # Define your first AWS integration
+ "integration_one" = {
+ aws_account_id = "123456789012"
+ duration_seconds = 1200
+ generate_credentials_in_worker = true
+ labels = ["production", "team:sre"]
+ },
+ # Define your second AWS integration
+ "integration_two" = {
+ aws_account_id = "210987654321"
+ external_id = "my-external-id"
+ space_id = "custom_space"
+ }
+ }
+}
+```
+
+For a complete example, see [examples/complete](./examples/complete/).
## Requirements
-No requirements.
+| Name | Version |
+| ------------------------------------------------------------------------ | ------- |
+| [terraform](#requirement_terraform) | >= 1.0 |
+| [spacelift](#requirement_spacelift) | >= 1.0 |
## Providers
-No provider.
+| Name | Version |
+| ------------------------------------------------------------------ | ------- |
+| [spacelift](#provider_spacelift) | >= 1.0 |
+
+## Modules
+
+| Name | Source | Version |
+| -------------------------------------------------------------------------------------- | --------------------- | ------- |
+| [integration_label](#module_integration_label) | cloudposse/label/null | 0.25.0 |
+| [this](#module_this) | cloudposse/label/null | 0.25.0 |
+
+## Resources
+
+| Name | Type |
+| ----------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| [spacelift_aws_integration.default](https://registry.terraform.io/providers/spacelift-io/spacelift/latest/docs/resources/aws_integration) | resource |
## Inputs
-No input.
+| Name | Description | Type | Default | Required |
+| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
+| [additional_tag_map](#input_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 |
+| [attributes](#input_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 |
+| [aws_integrations](#input_aws_integrations) | Map of AWS integrations with their configurations. | map(object({
aws_account_id = string
role_arn = string
external_id = optional(string, null)
duration_seconds = optional(number, 900)
generate_credentials_in_worker = optional(bool, false)
labels = optional(list(string), [])
space_id = optional(string, "root")
})) | `{}` | no |
+| [context](#input_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](#input_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
+| [descriptor_formats](#input_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
`{
format = string
labels = list(string)
}`
(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 |
+| [enabled](#input_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
+| [environment](#input_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](#input_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](#input_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](#input_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](#input_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](#input_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](#input_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](#input_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 |
+| [regex_replace_chars](#input_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 |
+| [stage](#input_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
+| [tags](#input_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](#input_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
-No output.
+| Name | Description |
+| ----------------------------------------------------------------------------------- | ------------------------------------------ |
+| [aws_integrations](#output_aws_integrations) | Map of AWS integration names to their IDs. |
diff --git a/examples/complete/context.tf b/examples/complete/context.tf
new file mode 100644
index 0000000..5e0ef88
--- /dev/null
+++ b/examples/complete/context.tf
@@ -0,0 +1,279 @@
+#
+# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label
+# All other instances of this file should be a copy of that one
+#
+#
+# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf
+# and then place it in your Terraform module to automatically get
+# Cloud Posse's standard configuration inputs suitable for passing
+# to Cloud Posse modules.
+#
+# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf
+#
+# Modules should access the whole context as `module.this.context`
+# to get the input variables with nulls for defaults,
+# for example `context = module.this.context`,
+# and access individual variables as `module.this.`,
+# with final values filled in.
+#
+# For example, when using defaults, `module.this.context.delimiter`
+# will be null, and `module.this.delimiter` will be `-` (hyphen).
+#
+
+module "this" {
+ source = "cloudposse/label/null"
+ version = "0.25.0" # requires Terraform >= 0.13.0
+
+ enabled = var.enabled
+ namespace = var.namespace
+ tenant = var.tenant
+ environment = var.environment
+ stage = var.stage
+ name = var.name
+ delimiter = var.delimiter
+ attributes = var.attributes
+ tags = var.tags
+ additional_tag_map = var.additional_tag_map
+ label_order = var.label_order
+ regex_replace_chars = var.regex_replace_chars
+ id_length_limit = var.id_length_limit
+ label_key_case = var.label_key_case
+ label_value_case = var.label_value_case
+ descriptor_formats = var.descriptor_formats
+ labels_as_tags = var.labels_as_tags
+
+ context = var.context
+}
+
+# Copy contents of cloudposse/terraform-null-label/variables.tf here
+
+variable "context" {
+ type = any
+ default = {
+ enabled = true
+ namespace = null
+ tenant = null
+ environment = null
+ stage = null
+ name = null
+ delimiter = null
+ attributes = []
+ tags = {}
+ additional_tag_map = {}
+ regex_replace_chars = null
+ label_order = []
+ id_length_limit = null
+ label_key_case = null
+ label_value_case = null
+ descriptor_formats = {}
+ # Note: we have to use [] instead of null for unset lists due to
+ # https://github.com/hashicorp/terraform/issues/28137
+ # which was not fixed until Terraform 1.0.0,
+ # but we want the default to be all the labels in `label_order`
+ # and we want users to be able to prevent all tag generation
+ # by setting `labels_as_tags` to `[]`, so we need
+ # a different sentinel to indicate "default"
+ labels_as_tags = ["unset"]
+ }
+ description = <<-EOT
+ 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.
+ EOT
+
+ validation {
+ condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"])
+ error_message = "Allowed values: `lower`, `title`, `upper`."
+ }
+
+ validation {
+ condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"])
+ error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
+ }
+}
+
+variable "enabled" {
+ type = bool
+ default = null
+ description = "Set to false to prevent the module from creating any resources"
+}
+
+variable "namespace" {
+ type = string
+ default = null
+ description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique"
+}
+
+variable "tenant" {
+ type = string
+ default = null
+ description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for"
+}
+
+variable "environment" {
+ type = string
+ default = null
+ description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'"
+}
+
+variable "stage" {
+ type = string
+ default = null
+ description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'"
+}
+
+variable "name" {
+ type = string
+ default = null
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "delimiter" {
+ type = string
+ default = null
+ description = <<-EOT
+ Delimiter to be used between ID elements.
+ Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
+ EOT
+}
+
+variable "attributes" {
+ type = list(string)
+ default = []
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "labels_as_tags" {
+ type = set(string)
+ default = ["default"]
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "tags" {
+ type = map(string)
+ default = {}
+ description = <<-EOT
+ Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
+ Neither the tag keys nor the tag values will be modified by this module.
+ EOT
+}
+
+variable "additional_tag_map" {
+ type = map(string)
+ default = {}
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "label_order" {
+ type = list(string)
+ default = null
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "regex_replace_chars" {
+ type = string
+ default = null
+ description = <<-EOT
+ 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.
+ EOT
+}
+
+variable "id_length_limit" {
+ type = number
+ default = null
+ description = <<-EOT
+ 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`.
+ EOT
+ validation {
+ condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0
+ error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length."
+ }
+}
+
+variable "label_key_case" {
+ type = string
+ default = null
+ description = <<-EOT
+ 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`.
+ EOT
+
+ validation {
+ condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case)
+ error_message = "Allowed values: `lower`, `title`, `upper`."
+ }
+}
+
+variable "label_value_case" {
+ type = string
+ default = null
+ description = <<-EOT
+ 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`.
+ EOT
+
+ validation {
+ condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case)
+ error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
+ }
+}
+
+variable "descriptor_formats" {
+ type = any
+ default = {}
+ description = <<-EOT
+ 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
+ `{
+ format = string
+ labels = list(string)
+ }`
+ (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).
+ EOT
+}
+
+#### End of copy of cloudposse/terraform-null-label/variables.tf
diff --git a/examples/complete/fixtures.auto.tfvars b/examples/complete/fixtures.auto.tfvars
new file mode 100644
index 0000000..3936fc2
--- /dev/null
+++ b/examples/complete/fixtures.auto.tfvars
@@ -0,0 +1,18 @@
+enabled = true
+
+namespace = "mp"
+
+aws_integrations = {
+ "foo" = {
+ aws_account_id = "123456789012"
+ role_arn = "arn:aws:iam::123456789012:role/Spacelift"
+ duration_seconds = 1200
+ labels = ["example", "foo"]
+ generate_credentials_in_worker = true
+ },
+ "bar" = {
+ aws_account_id = "210987654321"
+ role_arn = "arn:aws:iam::210987654321:role/Spacelift"
+ labels = ["example", "bar"]
+ }
+}
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
index f9d23f1..c6ce3f7 100644
--- a/examples/complete/main.tf
+++ b/examples/complete/main.tf
@@ -1 +1,6 @@
-# complete.tf
+module "aws_integrations" {
+ source = "../../"
+
+ aws_integrations = var.aws_integrations
+ context = module.this.context
+}
diff --git a/examples/complete/outputs.tf b/examples/complete/outputs.tf
deleted file mode 100644
index f9d23f1..0000000
--- a/examples/complete/outputs.tf
+++ /dev/null
@@ -1 +0,0 @@
-# complete.tf
diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf
index f9d23f1..3cdad88 100644
--- a/examples/complete/variables.tf
+++ b/examples/complete/variables.tf
@@ -1 +1,13 @@
-# complete.tf
+variable "aws_integrations" {
+ description = "Map of AWS integrations with their configurations."
+ type = map(object({
+ aws_account_id = string
+ role_arn = string
+ external_id = optional(string, null)
+ duration_seconds = optional(number, 900)
+ generate_credentials_in_worker = optional(bool, false)
+ labels = optional(list(string), [])
+ space_id = optional(string, "root")
+ }))
+ default = {}
+}
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
new file mode 100644
index 0000000..a7d1d5d
--- /dev/null
+++ b/examples/complete/versions.tf
@@ -0,0 +1,10 @@
+terraform {
+ required_version = "~> 1.0"
+
+ required_providers {
+ spacelift = {
+ source = "spacelift-io/spacelift"
+ version = "~> 1.0"
+ }
+ }
+}
diff --git a/main.tf b/main.tf
index 74e76fd..49e604e 100644
--- a/main.tf
+++ b/main.tf
@@ -1,3 +1,21 @@
-resource "random_pet" "template" {
- length = var.length
+
+module "integration_label" {
+ for_each = var.aws_integrations
+ source = "cloudposse/label/null"
+ version = "0.25.0"
+ name = format("%s-%s", each.key, each.value.aws_account_id)
+ context = module.this.context
+}
+
+resource "spacelift_aws_integration" "default" {
+ for_each = var.aws_integrations
+
+ name = module.integration_label[each.key].id
+ role_arn = each.value.role_arn
+ external_id = each.value.external_id
+ duration_seconds = each.value.duration_seconds
+ labels = each.value.labels
+ space_id = each.value.space_id
+
+ generate_credentials_in_worker = each.value.generate_credentials_in_worker
}
diff --git a/outputs.tf b/outputs.tf
index c44df14..ad67c52 100644
--- a/outputs.tf
+++ b/outputs.tf
@@ -1,4 +1,4 @@
-output "random_pet_name" {
- description = "The generated random pet name"
- value = random_pet.template.id
+output "aws_integrations" {
+ description = "Map of AWS integration names to their IDs."
+ value = { for name, integration in spacelift_aws_integration.default : name => integration.id }
}
diff --git a/variables.tf b/variables.tf
index 6348a57..3cdad88 100644
--- a/variables.tf
+++ b/variables.tf
@@ -1,5 +1,13 @@
-variable "length" {
- description = "The length of the random name"
- type = number
- default = 2
+variable "aws_integrations" {
+ description = "Map of AWS integrations with their configurations."
+ type = map(object({
+ aws_account_id = string
+ role_arn = string
+ external_id = optional(string, null)
+ duration_seconds = optional(number, 900)
+ generate_credentials_in_worker = optional(bool, false)
+ labels = optional(list(string), [])
+ space_id = optional(string, "root")
+ }))
+ default = {}
}
diff --git a/versions.tf b/versions.tf
index 0cf661c..9904eab 100644
--- a/versions.tf
+++ b/versions.tf
@@ -2,9 +2,9 @@ terraform {
required_version = ">= 1.0"
required_providers {
- random = {
- source = "hashicorp/random"
- version = ">= 3.0"
+ spacelift = {
+ source = "spacelift-io/spacelift"
+ version = ">= 1.0"
}
}
}