generated from cloudposse/terraform-example-module
-
Notifications
You must be signed in to change notification settings - Fork 20
/
README.yaml
109 lines (93 loc) · 3.99 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: spacelift-space
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Copyrights
copyrights:
- name: "Cloud Posse, LLC"
url: "https://cloudposse.com"
year: "2023"
# Canonical GitHub repo
github_repo: cloudposse/terraform-spacelift-cloud-infrastructure-automation
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse/terraform-spacelift-cloud-infrastructure-automation.svg"
url: "https://github.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/badge.svg"
url: "https://slack.cloudposse.com"
- name: "Discourse Forum"
image: "https://img.shields.io/discourse/https/ask.sweetops.com/posts.svg"
url: "https://ask.sweetops.com/"
# List any related terraform modules that this module may be used with or that this module depends on.
# related:
# - name:
# description:
# url:
# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
- name: "Terraform Version Pinning"
description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
url: "https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version"
- name: "Spacelift"
description: "The most flexible CI/CD for Terraform"
url: "https://spacelift.io/"
- name: "Spacelift Documentation"
description: "Official documentation site for Spacelift"
url: "https://docs.spacelift.io/"
- name: "Open Policy Agent"
description: "Policy-based control for cloud native environments"
url: "https://www.openpolicyagent.org/"
- name: "OPA Documentation"
description: "Open Policy Agent Documentation"
url: "https://www.openpolicyagent.org/docs/latest/"
- name: "Rego - OPA’s query and policy language"
description: "Rego focuses on providing powerful support for referencing nested documents and ensuring that queries are correct and unambiguous"
url: "https://www.openpolicyagent.org/docs/latest/policy-language/"
- name: "Example of using Rego policy language"
description: "Mutating Admissions Controllers with Open Policy Agent and Rego"
url: "https://blog.gripdev.xyz/2020/01/13/mutating-admissions-controllers-with-open-policy-agent-and-rego/"
# Short description of this project
description: |-
Terraform module to provisions a [Spacelift](https://docs.spacelift.io/concepts/spaces/index.html) space.
# Introduction to the project
#introduction: |-
# This is an introduction.
# How to use this module. Should be an easy example to copy and paste.
usage: |-
Here's how to invoke this module in your project:
```hcl
provider "spacelift" {}
module "space" {
source = "cloudposse/cloud-infrastructure-automation/spacelift//modules/spacelift-space"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
space_name = "test"
description = "A space for our test infrasturcture"
parent_space_id = "root"
inherit_entities_from_parent = false
labels = ["test", "space"]
```
# Example usage
examples: |-
Here is an example of using this module:
- [`../../examples/spacelift-space`](https://github.com/cloudposse/terraform-spacelift-cloud-infrastructure-automation/tree/master/examples/spacelift-space) - complete example of using this module
# How to get started quickly
#quickstart: |-
# Here's how to get started...
# Other files to include in this README from the project folder
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors:
- name: "Matt Calhoun"
github: "mcalhoun"