Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@goruha
goruha committed Nov 14, 2024
1 parent 0e1bcc9 commit 4225316
Show file tree
Hide file tree
Showing 7 changed files with 235 additions and 60 deletions.
8 changes: 2 additions & 6 deletions .github/settings.yml
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# Upstream changes from _extends are only recognized when modifications are made to this file in the default branch.
_extends: .github
repository:
name: template
description: Template for Terraform Components
name: aws-spacelift-spaces
description: This component is responsible for creating and managing the [spaces](https://docs
homepage: https://cloudposse.com/accelerate
topics: terraform, terraform-component




184 changes: 135 additions & 49 deletions README.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,70 +1,156 @@
name: "template"

name: "aws-spacelift-spaces"
# Canonical GitHub repo
github_repo: "cloudposse-terraform-components/template"

github_repo: "cloudposse-terraform-components/aws-spacelift-spaces"
# Short description of this project
description: |-
Description of this component
This component is responsible for creating and managing the [spaces](https://docs.spacelift.io/concepts/spaces/) in the
Spacelift organization.
## Usage
usage: |-
**Stack Level**: Regional or Test47
**Stack Level**: Global
The following are example snippets of how to use this component:
Here's an example snippet for how to use this component.
```yaml
# stacks/catalog/spacelift/spaces.yaml
components:
terraform:
foo:
spaces:
metadata:
component: spacelift/spaces
settings:
spacelift:
administrative: true
space_name: root
vars:
enabled: true
spaces:
# root is a special space that is the parent of all other spaces and cannot be deleted or renamed. Only the
# policies block is actually consumed by the component to create policies for the root space.
root:
parent_space_id: root
description: The root space
inherit_entities: true
policies:
GIT_PUSH Global Administrator:
type: GIT_PUSH
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/git_push.administrative.rego
TRIGGER Global Administrator:
type: TRIGGER
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/trigger.administrative.rego
GIT_PUSH Proposed Run:
type: GIT_PUSH
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/git_push.proposed-run.rego
GIT_PUSH Tracked Run:
type: GIT_PUSH
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/git_push.tracked-run.rego
PLAN Default:
type: PLAN
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/plan.default.rego
TRIGGER Dependencies:
type: TRIGGER
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/trigger.dependencies.rego
PLAN Warn On Resource Changes Except Image ID:
type: PLAN
body_url: https://raw.githubusercontent.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/%s/catalog/policies/plan.warn-on-resource-changes-except-image-id.rego
core:
parent_space_id: root
description: The space for the core tenant
inherit_entities: true
labels:
- core
plat:
parent_space_id: root
description: The space for platform tenant
inherit_entities: true
labels:
- plat
```
include:
- "docs/terraform.md"
<!-- prettier-ignore-start -->
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
tags:
- terraform
- terraform-modules
- aws
- components
- terraform-components
- root
- geodesic
- reference-implementation
- reference-architecture
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0 |
| <a name="requirement_spacelift"></a> [spacelift](#requirement\_spacelift) | >= 0.1.31 |
## Providers
No providers.
## Modules
| Name | Source | Version |
|------|--------|---------|
| <a name="module_policy"></a> [policy](#module\_policy) | cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-policy | 1.7.0 |
| <a name="module_space"></a> [space](#module\_space) | cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-space | 1.6.0 |
| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
## Resources
No resources.
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_additional_tag_map"></a> [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`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no |
| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no |
| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |
| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no |
| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br> "default"<br>]</pre> | no |
| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
| <a name="input_namespace"></a> [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 |
| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
| <a name="input_spaces"></a> [spaces](#input\_spaces) | A map of all Spaces to create in Spacelift | <pre>map(object({<br> parent_space_id = string,<br> description = optional(string),<br> inherit_entities = optional(bool, false),<br> labels = optional(set(string), []),<br> policies = optional(map(object({<br> body = optional(string),<br> body_url = optional(string),<br> body_url_version = optional(string, "master"),<br> body_file_path = optional(string),<br> type = optional(string),<br> labels = optional(set(string), []),<br> })), {}),<br> }))</pre> | n/a | yes |
| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
| <a name="input_tenant"></a> [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
| Name | Description |
|------|-------------|
| <a name="output_policies"></a> [policies](#output\_policies) | The policies created by this component |
| <a name="output_spaces"></a> [spaces](#output\_spaces) | The spaces created by this component |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
<!-- prettier-ignore-end -->
tags:
- component/spacelift/spaces
- layer/spacelift
- provider/aws
- provider/spacelift
# Categories of this project
categories:
- terraform-modules/root
- terraform-components

- component/spacelift/spaces
- layer/spacelift
- provider/aws
- provider/spacelift
# License of this project
license: "APACHE2"

# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse-terraform-components/template.svg?style=for-the-badge"
url: "https://github.com/cloudposse-terraform-components/template/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/for-the-badge.svg"
url: "https://slack.cloudposse.com"

references:
- name: "Cloud Posse Documentation"
description: "Complete documentation for the Cloud Posse solution"
url: "https://docs.cloudposse.com"
- name: "Reference Architectures"
description: "Launch effortlessly with our turnkey reference architectures, built either by your team or ours."
url: "https://cloudposse.com/"

- name: Latest Release
image: https://img.shields.io/github/release/cloudposse-terraform-components/aws-spacelift-spaces.svg?style=for-the-badge
url: https://github.com/cloudposse-terraform-components/aws-spacelift-spaces/releases/latest
- name: Slack Community
image: https://slack.cloudposse.com/for-the-badge.svg
url: https://slack.cloudposse.com
related:
- name: "Cloud Posse Terraform Modules"
description: Our collection of reusable Terraform modules used by our reference architectures.
url: "https://docs.cloudposse.com/modules/"
- name: "Atmos"
description: "Atmos is like docker-compose but for your infrastructure"
url: "https://atmos.tools"

- name: "Cloud Posse Terraform Modules"
description: Our collection of reusable Terraform modules used by our reference architectures.
url: "https://docs.cloudposse.com/modules/"
- name: "Atmos"
description: "Atmos is like docker-compose but for your infrastructure"
url: "https://atmos.tools"
contributors: [] # If included generates contribs
61 changes: 61 additions & 0 deletions src/main.tf
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,69 @@
locals {
enabled = module.this.enabled

spaces = local.enabled ? { for item in values(module.space)[*].space : item.name => {
description = item.description
id = item.id
inherit_entities = item.inherit_entities
labels = toset(item.labels)
parent_space_id = item.parent_space_id
}
} : {}

# Create a map of all the policies {policy_name = policy}
policies = local.enabled ? { for item in distinct(values(module.policy)[*].policy) : item.name => {
id = item.id
type = item.type
labels = toset(item.labels)
space_id = item.space_id
}
} : {}

policy_inputs = local.enabled ? {
for k, v in var.spaces : k => {
for pn, p in v.policies : pn => {
body = p.body
body_url = p.body_url
body_url_version = p.body_url_version
body_file_path = p.body_file_path
labels = setunion(toset(v.labels), toset(p.labels))
name = pn
space_id = k == "root" ? "root" : module.space[k].space_id
type = p.type
}
}
} : {}

all_policies_inputs = merge([for k, v in local.policy_inputs : v if length(keys(v)) > 0]...)
}

module "space" {
source = "cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-space"
version = "1.6.0"

# Create a space for each entry in the `spaces` variable, except for the root space which already exists by default
# and cannot be deleted.
for_each = { for k, v in var.spaces : k => v if k != "root" }

space_name = each.key
parent_space_id = each.value.parent_space_id
description = each.value.description
inherit_entities_from_parent = each.value.inherit_entities
labels = each.value.labels
}

module "policy" {
source = "cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-policy"
version = "1.7.0"

for_each = local.all_policies_inputs

policy_name = each.key
body = each.value.body
body_url = each.value.body_url
body_url_version = each.value.body_url_version
body_file_path = each.value.body_file_path
type = each.value.type
labels = each.value.labels
space_id = each.value.space_id
}
11 changes: 8 additions & 3 deletions src/outputs.tf
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
output "mock" {
description = "Mock output example for the Cloud Posse Terraform component template"
value = local.enabled ? "hello ${basename(abspath(path.module))}" : ""
output "spaces" {
description = "The spaces created by this component"
value = local.enabled ? local.spaces : {}
}

output "policies" {
description = "The policies created by this component"
value = local.enabled ? local.policies : {}
}
1 change: 1 addition & 0 deletions src/providers.tf
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
provider "spacelift" {}
17 changes: 17 additions & 0 deletions src/variables.tf
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
variable "spaces" {
type = map(object({
parent_space_id = string,
description = optional(string),
inherit_entities = optional(bool, false),
labels = optional(set(string), []),
policies = optional(map(object({
body = optional(string),
body_url = optional(string),
body_url_version = optional(string, "master"),
body_file_path = optional(string),
type = optional(string),
labels = optional(set(string), []),
})), {}),
}))
description = "A map of all Spaces to create in Spacelift"
}
13 changes: 11 additions & 2 deletions src/versions.tf
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
terraform {
required_version = ">= 1.0.0"
required_version = ">= 1.3"

required_providers {}
required_providers {
spacelift = {
source = "spacelift-io/spacelift"
version = ">= 0.1.31"
}
aws = {
source = "hashicorp/aws"
version = ">= 4.0"
}
}
}

0 comments on commit 4225316

Please sign in to comment.