Skip to content

Commit 60ba884

Browse files
adamcrewsaknysh
authored andcommitted
Use the latest label module to support the environment attribute (cloudposse#58)
1 parent 5ff3342 commit 60ba884

File tree

4 files changed

+140
-91
lines changed

4 files changed

+140
-91
lines changed

README.md

Lines changed: 91 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,43 @@
1-
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
1+
<!--
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
** DO NOT EDIT THIS FILE
17+
**
18+
** This file was automatically generated by the `build-harness`.
19+
** 1) Make all changes to `README.yaml`
20+
** 2) Run `make init` (you only need to do this once)
21+
** 3) Run`make readme` to rebuild this file.
22+
**
23+
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
24+
**
25+
26+
27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
39+
40+
-->
241
[![README Header][readme_header_img]][readme_header_link]
342

443
[![Cloud Posse][logo]](https://cpco.io/homepage)
@@ -268,12 +307,13 @@ Available targets:
268307
| db_name | Database name | string | - | yes |
269308
| db_port | Database port | number | `3306` | no |
270309
| deletion_protection | If the DB instance should have deletion protection enabled | bool | `false` | no |
271-
| delimiter | Delimiter to be used between `name`, `namespace`, `stage` and `attributes` | string | `-` | no |
310+
| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
272311
| enabled | Set to false to prevent the module from creating any resources | bool | `true` | no |
273312
| enabled_cloudwatch_logs_exports | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery | list(string) | `<list>` | no |
274313
| engine | The name of the database engine to be used for this DB cluster. Valid values: `aurora`, `aurora-mysql`, `aurora-postgresql` | string | `aurora` | no |
275314
| engine_mode | The database engine mode. Valid values: `parallelquery`, `provisioned`, `serverless` | string | `provisioned` | no |
276315
| engine_version | The version number of the database engine to use | string | `` | no |
316+
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
277317
| global_cluster_identifier | ID of the Aurora global cluster | string | `` | no |
278318
| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no |
279319
| iam_roles | Iam roles for the Aurora cluster | list(string) | `<list>` | no |
@@ -282,8 +322,8 @@ Available targets:
282322
| instance_type | Instance type to use | string | `db.t2.small` | no |
283323
| kms_key_arn | The ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to `true` | string | `` | no |
284324
| maintenance_window | Weekly time range during which system maintenance can occur, in UTC | string | `wed:03:00-wed:04:00` | no |
285-
| name | Name of the application | string | - | yes |
286-
| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no |
325+
| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
326+
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
287327
| performance_insights_enabled | Whether to enable Performance Insights | bool | `false` | no |
288328
| performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. When specifying `performance_insights_kms_key_id`, `performance_insights_enabled` needs to be set to true | string | `` | no |
289329
| publicly_accessible | Set to true if you want your cluster to be publicly accessible (such as via QuickSight) | bool | `false` | no |
@@ -297,10 +337,10 @@ Available targets:
297337
| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB cluster is deleted | bool | `true` | no |
298338
| snapshot_identifier | Specifies whether or not to create this cluster from a snapshot | string | `` | no |
299339
| source_region | Source Region of primary cluster, needed when using encrypted storage and region replicas | string | `` | no |
300-
| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | `` | no |
340+
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
301341
| storage_encrypted | Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode` | bool | `false` | no |
302342
| subnets | List of VPC subnet IDs | list(string) | - | yes |
303-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map(string) | `<map>` | no |
343+
| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
304344
| vpc_id | VPC ID to create the cluster in (e.g. `vpc-a22222ee`) | string | - | yes |
305345
| zone_id | Route53 parent zone ID. If provided (not empty), the module will create sub-domain DNS records for the DB master and replicas | string | `` | no |
306346

@@ -341,42 +381,47 @@ Check out these related projects.
341381

342382
## Help
343383

344-
**Got a question?**
384+
**Got a question?** We got answers.
345385

346386
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-rds-cluster/issues), send us an [email][email] or join our [Slack Community][slack].
347387

348388
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
349389

350-
## Commercial Support
351-
352-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
353-
354-
We provide [*commercial support*][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 full-time engineer.
390+
## DevOps Accelerator for Startups
355391

356-
[![E-Mail](https://img.shields.io/badge/[email protected])][email]
357392

358-
- **Questions.** We'll use a Shared Slack channel between your team and ours.
359-
- **Troubleshooting.** We'll help you triage why things aren't working.
360-
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
361-
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
362-
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
363-
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
364-
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
393+
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
365394

395+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
366396

397+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
367398

368-
## Terraform Module Development
369-
370-
Are you interested in custom Terraform module development? Submit your inquiry using [our form][module_development] today and we'll get back to you ASAP.
399+
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
371400

401+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
402+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
403+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
404+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
405+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
406+
- **Training.** You'll receive hands-on training so your team can operate what we build.
407+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
408+
- **Troubleshooting.** You'll get help to triage when things aren't working.
409+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
410+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
372411

373412
## Slack Community
374413

375414
Join our [Open Source Community][slack] on Slack. It's **FREE** 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 totally *sweet* infrastructure.
376415

377416
## Newsletter
378417

379-
Signup for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
418+
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
419+
420+
## Office Hours
421+
422+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
423+
424+
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
380425

381426
## Contributing
382427

@@ -401,7 +446,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
401446

402447
## Copyright
403448

404-
Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
449+
Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)
405450

406451

407452

@@ -476,33 +521,31 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
476521
[leehuffman_homepage]: https://github.com/leehuffman
477522
[leehuffman_avatar]: https://img.cloudposse.com/150x150/https://github.com/leehuffman.png
478523

479-
480-
481524
[![README Footer][readme_footer_img]][readme_footer_link]
482525
[![Beacon][beacon]][website]
483526

484527
[logo]: https://cloudposse.com/logo-300x69.svg
485-
[docs]: https://cpco.io/docs
486-
[website]: https://cpco.io/homepage
487-
[github]: https://cpco.io/github
488-
[jobs]: https://cpco.io/jobs
489-
[hire]: https://cpco.io/hire
490-
[slack]: https://cpco.io/slack
491-
[linkedin]: https://cpco.io/linkedin
492-
[twitter]: https://cpco.io/twitter
493-
[testimonial]: https://cpco.io/leave-testimonial
494-
[newsletter]: https://cpco.io/newsletter
495-
[email]: https://cpco.io/email
496-
[commercial_support]: https://cpco.io/commercial-support
497-
[we_love_open_source]: https://cpco.io/we-love-open-source
498-
[module_development]: https://cpco.io/module-development
499-
[terraform_modules]: https://cpco.io/terraform-modules
500-
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/terraform-aws-rds-cluster
501-
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/terraform-aws-rds-cluster
502-
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/terraform-aws-rds-cluster
503-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/terraform-aws-rds-cluster
504-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/terraform-aws-rds-cluster
505-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/terraform-aws-rds-cluster
528+
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=docs
529+
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=website
530+
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=github
531+
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=jobs
532+
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=hire
533+
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=slack
534+
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=linkedin
535+
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=twitter
536+
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=testimonial
537+
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=office_hours
538+
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=newsletter
539+
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=email
540+
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support
541+
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=we_love_open_source
542+
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=terraform_modules
543+
[readme_header_img]: https://cloudposse.com/readme/header/img
544+
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=readme_header_link
545+
[readme_footer_img]: https://cloudposse.com/readme/footer/img
546+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=readme_footer_link
547+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
548+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=readme_commercial_support_link
506549
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-aws-rds-cluster&url=https://github.com/cloudposse/terraform-aws-rds-cluster
507550
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-aws-rds-cluster&url=https://github.com/cloudposse/terraform-aws-rds-cluster
508551
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-aws-rds-cluster

docs/terraform.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,13 @@
2424
| db_name | Database name | string | - | yes |
2525
| db_port | Database port | number | `3306` | no |
2626
| deletion_protection | If the DB instance should have deletion protection enabled | bool | `false` | no |
27-
| delimiter | Delimiter to be used between `name`, `namespace`, `stage` and `attributes` | string | `-` | no |
27+
| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
2828
| enabled | Set to false to prevent the module from creating any resources | bool | `true` | no |
2929
| enabled_cloudwatch_logs_exports | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery | list(string) | `<list>` | no |
3030
| engine | The name of the database engine to be used for this DB cluster. Valid values: `aurora`, `aurora-mysql`, `aurora-postgresql` | string | `aurora` | no |
3131
| engine_mode | The database engine mode. Valid values: `parallelquery`, `provisioned`, `serverless` | string | `provisioned` | no |
3232
| engine_version | The version number of the database engine to use | string | `` | no |
33+
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
3334
| global_cluster_identifier | ID of the Aurora global cluster | string | `` | no |
3435
| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no |
3536
| iam_roles | Iam roles for the Aurora cluster | list(string) | `<list>` | no |
@@ -38,8 +39,8 @@
3839
| instance_type | Instance type to use | string | `db.t2.small` | no |
3940
| kms_key_arn | The ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to `true` | string | `` | no |
4041
| maintenance_window | Weekly time range during which system maintenance can occur, in UTC | string | `wed:03:00-wed:04:00` | no |
41-
| name | Name of the application | string | - | yes |
42-
| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no |
42+
| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
43+
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
4344
| performance_insights_enabled | Whether to enable Performance Insights | bool | `false` | no |
4445
| performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. When specifying `performance_insights_kms_key_id`, `performance_insights_enabled` needs to be set to true | string | `` | no |
4546
| publicly_accessible | Set to true if you want your cluster to be publicly accessible (such as via QuickSight) | bool | `false` | no |
@@ -53,10 +54,10 @@
5354
| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB cluster is deleted | bool | `true` | no |
5455
| snapshot_identifier | Specifies whether or not to create this cluster from a snapshot | string | `` | no |
5556
| source_region | Source Region of primary cluster, needed when using encrypted storage and region replicas | string | `` | no |
56-
| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | `` | no |
57+
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
5758
| storage_encrypted | Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode` | bool | `false` | no |
5859
| subnets | List of VPC subnet IDs | list(string) | - | yes |
59-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map(string) | `<map>` | no |
60+
| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
6061
| vpc_id | VPC ID to create the cluster in (e.g. `vpc-a22222ee`) | string | - | yes |
6162
| zone_id | Route53 parent zone ID. If provided (not empty), the module will create sub-domain DNS records for the DB master and replicas | string | `` | no |
6263

main.tf

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
module "label" {
2-
source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.14.1"
3-
namespace = var.namespace
4-
name = var.name
5-
stage = var.stage
6-
delimiter = var.delimiter
7-
attributes = var.attributes
8-
tags = var.tags
9-
enabled = var.enabled
2+
source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.16.0"
3+
namespace = var.namespace
4+
name = var.name
5+
stage = var.stage
6+
environment = var.environment
7+
delimiter = var.delimiter
8+
attributes = var.attributes
9+
tags = var.tags
10+
enabled = var.enabled
1011
}
1112

1213
resource "aws_security_group" "default" {

0 commit comments

Comments
 (0)