Skip to content

Commit 1654e87

Browse files
committed
update README.md
1 parent cc49e0c commit 1654e87

File tree

1 file changed

+93
-6
lines changed

1 file changed

+93
-6
lines changed

README.md

+93-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
23
<p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p>
34

45

@@ -7,29 +8,115 @@
78
</h1>
89

910
<p align="center" style="font-size: 1.2rem;">
10-
Terraform template to create new modules.
11+
Terraform module template to create new modules using this as baseline
1112
</p>
1213

1314
<p align="center">
1415

15-
<a href="https://github.com/clouddrove/terraform-module-template/releases/latest">![Latest Release](https://img.shields.io/github/release/clouddrove/terraform-module-template.svg)</a>
16-
<a href="">![tfsec](https://github.com/clouddrove/terraform-module-template/actions/workflows/tfsec.yml/badge.svg)</a>
16+
<a href="https://github.com/clouddrove/terraform-module-template/releases/latest">
17+
<img src="https://img.shields.io/github/release/clouddrove/terraform-module-template.svg" alt="Latest Release">
18+
</a>
19+
<a href="">
20+
<img src="https://github.com/clouddrove/terraform-module-template/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
21+
</a>
1722
<a href="LICENSE.md">
1823
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
1924
</a>
2025

26+
2127
</p>
2228
<p align="center">
2329

24-
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-azure-aks'>
30+
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-module-template'>
2531
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
2632
</a>
27-
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AZURE+KUBERNETES+SERVICE&url=https://github.com/clouddrove/terraform-azure-aks'>
33+
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+Module+Template&url=https://github.com/clouddrove/terraform-module-template'>
2834
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
2935
</a>
30-
<a href='https://twitter.com/intent/tweet/?text=Terraform+AZURE+KUBERNETES+SERVICE&url=https://github.com/clouddrove/terraform-azure-aks'>
36+
<a href='https://twitter.com/intent/tweet/?text=Terraform+Module+Template&url=https://github.com/clouddrove/terraform-module-template'>
3137
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
3238
</a>
3339

3440
</p>
3541
<hr>
42+
43+
44+
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.
45+
46+
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.
47+
48+
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.
49+
50+
51+
52+
53+
## Prerequisites
54+
55+
This module has a few dependencies:
56+
57+
- [Terraform 1.x.x](https://learn.hashicorp.com/terraform/getting-started/install.html)
58+
- [Go](https://golang.org/doc/install)
59+
- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
60+
- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)
61+
62+
63+
64+
65+
66+
67+
68+
## Examples
69+
70+
71+
**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-module-template/releases).
72+
73+
74+
Here are some examples of how you can use this module in your inventory structure:
75+
```hcl
76+
```
77+
78+
79+
80+
81+
82+
83+
## Inputs
84+
85+
No input.
86+
87+
## Outputs
88+
89+
No output.
90+
91+
92+
93+
94+
## Testing
95+
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.
96+
97+
You need to run the following command in the testing folder:
98+
```hcl
99+
go test -run Test
100+
```
101+
102+
103+
104+
## Feedback
105+
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-module-template/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
106+
107+
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-module-template)!
108+
109+
## About us
110+
111+
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.
112+
113+
<p align="center">We are <b> The Cloud Experts!</b></p>
114+
<hr />
115+
<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>
116+
117+
[website]: https://clouddrove.com
118+
[github]: https://github.com/clouddrove
119+
[linkedin]: https://cpco.io/linkedin
120+
[twitter]: https://twitter.com/clouddrove/
121+
[email]: https://clouddrove.com/contact-us.html
122+
[terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=

0 commit comments

Comments
 (0)