Skip to content

Commit 1318b60

Browse files
vadim-gleifvadim-gleif
authored
Migrate readme yaml (#3)
* Migrate readme yaml
1 parent 3d76a4a commit 1318b60

File tree

7 files changed

+234
-41
lines changed

7 files changed

+234
-41
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@
66
.terraform/
77
.idea
88
*.iml
9+
10+
.build-harness
11+
build-harness

‎Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
SHELL := /bin/bash
22

3+
# List of targets the `readme` target should call before generating the readme
4+
export README_DEPS ?= docs/targets.md docs/terraform.md
5+
36
-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)
47

8+
## Lint terraform code
59
lint:
6-
$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate
10+
$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate

‎README.md

Lines changed: 114 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
# terraform-aws-acm-request-certificate [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate)
1+
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
3+
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
4+
5+
# terraform-aws-acm-request-certificate
6+
7+
[![Build Status](https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-acm-request-certificate.svg)](https://github.com/cloudposse/terraform-aws-acm-request-certificate/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
8+
9+
10+
Terraform module to request an ACM certificate for a domain and add a CNAME record to the DNS zone to complete certificate validation
11+
12+
13+
---
14+
15+
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
16+
17+
18+
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
19+
20+
221

3-
Terraform module to request an ACM certificate for a domain and add a CNAME record to the DNZ zone to complete certificate validation
422

523

624
## Usage
@@ -29,34 +47,77 @@ module "acm_request_certificate" {
2947
```
3048

3149

32-
## Variables
3350

34-
| Name | Default | Description | Required |
35-
|:------------------------------------|:-------------|:-----------------------------------------------------------------------------------|:--------:|
36-
| `domain_name` | `` | A domain name for which the certificate should be issued | Yes |
37-
| `validation_method` | `DNS` | Which method to use for validation, `DNS` or `EMAIL` | No |
38-
| `proces_domain_validation_options` | `true` | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | No |
39-
| `ttl` | `300` | The TTL of the record to add to the DNS zone to complete certificate validation | No |
40-
| `tags` | `{}` | Additional tags (_e.g._ `map("BusinessUnit","XYZ")` | No |
41-
| `subject_alternative_names` | `[]` | A list of domains that should be SANs in the issued certificate | No |
4251

4352

53+
54+
## Makefile Targets
55+
```
56+
Available targets:
57+
58+
help This help screen
59+
help/all Display help for all targets
60+
lint Lint terraform code
61+
62+
```
63+
64+
## Inputs
65+
66+
| Name | Description | Type | Default | Required |
67+
|------|-------------|:----:|:-----:|:-----:|
68+
| domain_name | A domain name for which the certificate should be issued | string | - | yes |
69+
| proces_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
70+
| subject_alternative_names | A list of domains that should be SANs in the issued certificate | list | `<list>` | no |
71+
| tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
72+
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation | string | `300` | no |
73+
| validation_method | Which method to use for validation, DNS or EMAIL | string | `DNS` | no |
74+
4475
## Outputs
4576

46-
| Name | Description |
47-
|:-----------------------------|:---------------------------------------------------------------------------------|
48-
| `id` | The ARN of the certificate |
49-
| `arn` | The ARN of the certificate |
50-
| `domain_validation_options` | CNAME records that are added to the DNS zone to complete certificate validation |
77+
| Name | Description |
78+
|------|-------------|
79+
| arn | The ARN of the certificate |
80+
| domain_validation_options | CNAME records that are added to the DNS zone to complete certificate validation |
81+
| id | The ARN of the certificate |
82+
83+
84+
85+
86+
## Related Projects
87+
88+
Check out these related projects.
89+
90+
- [terraform-tls-ssh-key-pair](https://github.com/cloudposse/terraform-tls-ssh-key-pair) - Terraform module for generating an SSH public/private key file.
91+
- [terraform-aws-alb](https://github.com/cloudposse/terraform-aws-alb) - Terraform module to provision a standard ALB for HTTP/HTTP traffic
5192

5293

5394

5495
## Help
5596

5697
**Got a question?**
5798

58-
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-acm-request-certificate/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
99+
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-acm-request-certificate/issues), send us an [email][email] or join our [Slack Community][slack].
100+
101+
## Commerical Support
102+
103+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
104+
105+
We provide *commercial support* for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer.
106+
107+
[![E-Mail](https://img.shields.io/badge/[email protected])](mailto:[email protected])
108+
109+
- **Questions.** We'll use a Shared Slack channel between your team and ours.
110+
- **Troubleshooting.** We'll help you triage why things aren't working.
111+
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
112+
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
113+
- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
114+
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
115+
- **Implementation.** We'll provide hands on support to implement our reference architectures.
116+
59117

118+
## Community Forum
119+
120+
Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure.
60121

61122
## Contributing
62123

@@ -66,22 +127,28 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-acm-r
66127

67128
### Developing
68129

69-
If you are interested in being a contributor and want to get involved in developing `terraform-aws-acm-request-certificate`, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
130+
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
70131

71132
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
72133

73134
1. **Fork** the repo on GitHub
74135
2. **Clone** the project to your own machine
75136
3. **Commit** changes to your own branch
76137
4. **Push** your work back up to your fork
77-
5. Submit a **Pull request** so that we can review your changes
138+
5. Submit a **Pull Request** so that we can review your changes
139+
140+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
141+
142+
143+
## Copyright
144+
145+
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
78146

79-
**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
80147

81148

82-
## License
149+
## License
83150

84-
[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
151+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
85152

86153
See [LICENSE](LICENSE) for full details.
87154

@@ -93,7 +160,7 @@ See [LICENSE](LICENSE) for full details.
93160
"License"); you may not use this file except in compliance
94161
with the License. You may obtain a copy of the License at
95162

96-
http://www.apache.org/licenses/LICENSE-2.0
163+
https://www.apache.org/licenses/LICENSE-2.0
97164

98165
Unless required by applicable law or agreed to in writing,
99166
software distributed under the License is distributed on an
@@ -103,31 +170,41 @@ See [LICENSE](LICENSE) for full details.
103170
under the License.
104171

105172

106-
## About
173+
## Trademarks
174+
175+
All other trademarks referenced herein are the property of their respective owners.
107176

108-
`terraform-aws-acm-request-certificate` is maintained and funded by [Cloud Posse, LLC][website].
177+
## About
109178

110-
![Cloud Posse](https://cloudposse.com/logo-300x69.png)
179+
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
111180

181+
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
112182

113-
Like it? Please let us know at <hello@cloudposse.com>
183+
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
114184

115-
We love [Open Source Software](https://github.com/cloudposse/)!
185+
We offer paid support on all of our projects.
116186

117-
See [our other projects][community]
118-
or [hire us][hire] to help build your next cloud platform.
187+
Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
119188

189+
[docs]: https://docs.cloudposse.com/
120190
[website]: https://cloudposse.com/
121-
[community]: https://github.com/cloudposse/
191+
[github]: https://github.com/cloudposse/
192+
[jobs]: https://cloudposse.com/jobs/
122193
[hire]: https://cloudposse.com/contact/
194+
[slack]: https://slack.cloudposse.com/
195+
[linkedin]: https://www.linkedin.com/company/cloudposse
196+
[twitter]: https://twitter.com/cloudposse/
197+
[email]: mailto:[email protected]
123198

124199

125200
### Contributors
126201

127-
| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |
128-
|-------------------------------------------------------|------------------------------------------------------------------|
202+
| [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] |
203+
|---|---|
204+
205+
[aknysh_homepage]: https://github.com/aknysh
206+
[aknysh_avatar]: https://github.com/aknysh.png?size=150
207+
[SweetOps_homepage]: https://github.com/SweetOps
208+
[SweetOps_avatar]: https://github.com/SweetOps.png?size=150
209+
129210

130-
[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
131-
[erik_web]: https://github.com/osterman/
132-
[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
133-
[andriy_web]: https://github.com/aknysh/

‎README.yaml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
#
3+
# This is the canonical configuration for the `README.md`
4+
# Run `make readme` to rebuild the `README.md`
5+
#
6+
7+
# Name of this project
8+
name: terraform-aws-acm-request-certificate
9+
10+
# Logo for this project
11+
#logo: docs/logo.png
12+
13+
# License of this project
14+
license: "APACHE2"
15+
16+
# Canonical GitHub repo
17+
github_repo: cloudposse/terraform-aws-acm-request-certificate
18+
19+
# Badges to display
20+
badges:
21+
- name: "Build Status"
22+
image: "https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate.svg?branch=master"
23+
url: "https://travis-ci.org/cloudposse/terraform-aws-acm-request-certificate"
24+
- name: "Latest Release"
25+
image: "https://img.shields.io/github/release/cloudposse/terraform-aws-acm-request-certificate.svg"
26+
url: "https://github.com/cloudposse/terraform-aws-acm-request-certificate/releases/latest"
27+
- name: "Slack Community"
28+
image: "https://slack.cloudposse.com/badge.svg"
29+
url: "https://slack.cloudposse.com"
30+
31+
related:
32+
- name: "terraform-tls-ssh-key-pair"
33+
description: "Terraform module for generating an SSH public/private key file."
34+
url: "https://github.com/cloudposse/terraform-tls-ssh-key-pair"
35+
- name: "terraform-aws-alb"
36+
description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic"
37+
url: "https://github.com/cloudposse/terraform-aws-alb"
38+
39+
# Short description of this project
40+
description: |-
41+
Terraform module to request an ACM certificate for a domain and add a CNAME record to the DNS zone to complete certificate validation
42+
43+
# How to use this project
44+
usage: |-
45+
This example will request an SSL certificate for `example.com` domain
46+
47+
```hcl
48+
module "acm_request_certificate" {
49+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
50+
domain_name = "example.com"
51+
proces_domain_validation_options = "true"
52+
ttl = "300"
53+
}
54+
```
55+
56+
This example will request an SSL certificate for `example.com` domain and all its subdomains `*.example.com`
57+
58+
```hcl
59+
module "acm_request_certificate" {
60+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
61+
domain_name = "example.com"
62+
proces_domain_validation_options = "true"
63+
ttl = "300"
64+
subject_alternative_names = ["*.example.com"]
65+
}
66+
```
67+
68+
include:
69+
- "docs/targets.md"
70+
- "docs/terraform.md"
71+
72+
# Contributors to this project
73+
contributors:
74+
- name: "Andriy Knysh"
75+
github: "aknysh"
76+
- name: "Vladimir"
77+
github: "SweetOps"

‎docs/targets.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Makefile Targets
2+
```
3+
Available targets:
4+
5+
help This help screen
6+
help/all Display help for all targets
7+
lint Lint terraform code
8+
9+
```

‎docs/terraform.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
## Inputs
3+
4+
| Name | Description | Type | Default | Required |
5+
|------|-------------|:----:|:-----:|:-----:|
6+
| domain_name | A domain name for which the certificate should be issued | string | - | yes |
7+
| proces_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
8+
| subject_alternative_names | A list of domains that should be SANs in the issued certificate | list | `<list>` | no |
9+
| tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
10+
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation | string | `300` | no |
11+
| validation_method | Which method to use for validation, DNS or EMAIL | string | `DNS` | no |
12+
13+
## Outputs
14+
15+
| Name | Description |
16+
|------|-------------|
17+
| arn | The ARN of the certificate |
18+
| domain_validation_options | CNAME records that are added to the DNS zone to complete certificate validation |
19+
| id | The ARN of the certificate |
20+

‎outputs.tf

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
output "id" {
2-
value = "${aws_acm_certificate.default.id}"
2+
value = "${aws_acm_certificate.default.id}"
3+
description = "The ARN of the certificate"
34
}
45

56
output "arn" {
6-
value = "${aws_acm_certificate.default.arn}"
7+
value = "${aws_acm_certificate.default.arn}"
8+
description = "The ARN of the certificate"
79
}
810

911
output "domain_validation_options" {
10-
value = "${aws_acm_certificate.default.domain_validation_options}"
12+
value = "${aws_acm_certificate.default.domain_validation_options}"
13+
description = "CNAME records that are added to the DNS zone to complete certificate validation"
1114
}

0 commit comments

Comments
 (0)