Skip to content

Commit f2bea0a

Browse files
Merge branch 'master' of github.com:clouddrove/terraform-gcp-labels
2 parents 4e8f4d7 + dac28dc commit f2bea0a

File tree

1 file changed

+155
-0
lines changed

1 file changed

+155
-0
lines changed

README.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
3+
<p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p>
4+
5+
6+
<h1 align="center">
7+
Terraform google labels
8+
</h1>
9+
10+
<p align="center" style="font-size: 1.2rem;">
11+
This terraform module is used for requesting or importing SSL/TLS certificate with validation.
12+
</p>
13+
14+
<p align="center">
15+
16+
<a href="https://www.terraform.io">
17+
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
18+
</a>
19+
<a href="LICENSE.md">
20+
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
21+
</a>
22+
<a href="https://github.com/clouddrove/terraform-gcp-labels/actions/workflows/tfsec.yml">
23+
<img src="https://github.com/clouddrove/terraform-gcp-labels/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
24+
</a>
25+
<a href="https://github.com/clouddrove/terraform-gcp-labels/actions/workflows/terraform.yml">
26+
<img src="https://github.com/clouddrove/terraform-gcp-labels/actions/workflows/terraform.yml/badge.svg" alt="static-checks">
27+
</a>
28+
29+
30+
</p>
31+
<p align="center">
32+
33+
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-google-labels'>
34+
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
35+
</a>
36+
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+google+labels&url=https://github.com/clouddrove/terraform-google-labels'>
37+
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
38+
</a>
39+
<a href='https://twitter.com/intent/tweet/?text=Terraform+google+labels&url=https://github.com/clouddrove/terraform-google-labels'>
40+
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
41+
</a>
42+
43+
</p>
44+
<hr>
45+
46+
47+
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
48+
49+
This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
50+
51+
We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress.
52+
53+
54+
55+
56+
## Prerequisites
57+
58+
This module has a few dependencies:
59+
60+
- [Terraform 1.x.x](https://learn.hashicorp.com/terraform/getting-started/install.html)
61+
- [Go](https://golang.org/doc/install)
62+
- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
63+
- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)
64+
65+
66+
67+
68+
69+
70+
71+
## Examples
72+
73+
74+
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-google-labels/releases).
75+
76+
77+
Here are some examples of how you can use this module in your inventory structure:
78+
### labels module
79+
```hcl
80+
module "labels" {
81+
source = "./../"
82+
83+
name = "labels"
84+
environment = "test"
85+
label_order = ["name", "environment"]
86+
attributes = ["private"]
87+
extra_tags = {
88+
Application = "CloudDrove"
89+
}
90+
}
91+
```
92+
93+
94+
95+
96+
97+
98+
## Inputs
99+
100+
| Name | Description | Type | Default | Required |
101+
|------|-------------|------|---------|:--------:|
102+
| attributes | Additional attributes (e.g. `1`). | `list(string)` | `[]` | no |
103+
| delimiter | Delimiter to be used between `organization`, `name`, `environment` and `attributes`. | `string` | `"-"` | no |
104+
| enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
105+
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
106+
| extra\_tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(string)` | `{}` | no |
107+
| label\_order | Label order, e.g. sequence of application name and environment `name`,`environment`,'attribute' [`webserver`,`qa`,`devops`,`public`,] . | `list(any)` | `[]` | no |
108+
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"[email protected]"` | no |
109+
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
110+
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-google-labels"` | no |
111+
112+
## Outputs
113+
114+
| Name | Description |
115+
|------|-------------|
116+
| attributes | Normalized attributes. |
117+
| environment | Normalized environment |
118+
| id | Disambiguated ID. |
119+
| label\_order | Normalized Tag map. |
120+
| name | Normalized name. |
121+
| repository | Terraform current module repo |
122+
| tags | Normalized Tag map. |
123+
124+
125+
126+
127+
## Testing
128+
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
129+
130+
You need to run the following command in the testing folder:
131+
```hcl
132+
go test -run Test
133+
```
134+
135+
136+
137+
## Feedback
138+
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-google-labels/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
139+
140+
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-google-labels)!
141+
142+
## About us
143+
144+
At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.
145+
146+
<p align="center">We are <b> The Cloud Experts!</b></p>
147+
<hr />
148+
<p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
149+
150+
[website]: https://clouddrove.com
151+
[github]: https://github.com/clouddrove
152+
[linkedin]: https://cpco.io/linkedin
153+
[twitter]: https://twitter.com/clouddrove/
154+
[email]: https://clouddrove.com/contact-us.html
155+
[terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=

0 commit comments

Comments
 (0)