Skip to content

Commit 4e772eb

Browse files
clouddrove-ciclouddrove-ci
committed
update README.md
1 parent fb62667 commit 4e772eb

File tree

2 files changed

+183
-120
lines changed

2 files changed

+183
-120
lines changed

‎README.md

Lines changed: 127 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
11
<!-- 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-
2+
[![Banner](https://github.com/clouddrove/terraform-gcp-vpc/blob/master/docs/CloudDrove.png)][website]
63
<h1 align="center">
74
Terraform AWS kafka
85
</h1>
96

10-
<p align="center" style="font-size: 1.2rem;">
11-
Terraform module to create kafka resource on AWS.
12-
</p>
7+
<p align="center" style="font-size: 1.2rem;">
8+
With our comprehensive DevOps toolkit - streamline operations, automate workflows, enhance collaboration and, most importantly, deploy with confidence.
9+
</p>
10+
1311

1412
<p align="center">
1513

16-
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
14+
<a href="https://github.com/clouddrove/terraform-aws-msk/releases/latest">
15+
<img src="https://img.shields.io/github/release/clouddrove/terraform-aws-msk.svg" alt="Latest Release">
16+
</a>
17+
<a href="https://github.com/clouddrove/terraform-aws-msk/actions/workflows/tfsec.yml">
18+
<img src="https://github.com/clouddrove/terraform-aws-msk/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
1819
</a>
1920
<a href="LICENSE.md">
2021
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
2122
</a>
22-
<a href="https://github.com/clouddrove/terraform-aws-kafka/actions/workflows/tfsec.yml">
23-
<img src="https://github.com/clouddrove/terraform-aws-kafka/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
23+
<a href="CHANGELOG.md">
24+
<img src="https://img.shields.io/badge/Changelog-blue" alt="Changelog">
2425
</a>
2526

27+
2628
</p>
2729
<p align="center">
2830

2931
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-kafka'>
3032
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
3133
</a>
34+
<a href='https://www.instagram.com/cloud_drove?igsh=cHJqaDY3bGtnYmh3' title="Follow On Instagram">
35+
<img src="https://github.com/gauravghongde/social-icons/blob/master/SVG/Color/Instagram.svg" width="23" height="23" />
36+
</a>
3237
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+kafka&url=https://github.com/clouddrove/terraform-aws-kafka'>
3338
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
3439
</a>
@@ -40,143 +45,145 @@
4045
<hr>
4146

4247

43-
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+
We are a group of DevOps engineers & architects, joining hands in this ever evolving digital landscape. With our strong belief in Automation; just like microservices, always on the lookout to split the the infrastructure into smaller connected resources (database, cluster and more) which could be standardized, are manageable, scalable, secure & follow industry best practices.
4449

45-
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.
4650

47-
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.
51+
This module includes Terraform open source, examples, and automation tests (for better understanding), which would help you create and improve your infrastructure with minimalistic coding.
4852

4953

5054

5155

52-
## Prerequisites
56+
## Prerequisites and Providers
5357

54-
This module has a few dependencies:
58+
This table contains both Prerequisites and Providers:
5559

60+
| Description | Name | Version |
61+
|:-------------:|:-------------------------------------------:|:---------:|
62+
| **Prerequisite** | [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html) | >= 1.6.6 |
63+
| **Provider** | [aws](https://aws.amazon.com/) | >= 5.31.0 |
5664

5765

5866

5967

6068

6169
## Examples
6270

71+
**IMPORTANT:** Since the master branch used in source varies based on new modifications, we recommend using the [release versions](https://github.com/clouddrove/terraform-aws-kafka/releases).
72+
73+
📌 For additional usage examples, check the complete list under [`examples/`](./examples) directory.
74+
75+
76+
77+
## Inputs and Outputs
78+
79+
Refer to complete documentation: [here](docs/io.md)
80+
81+
82+
<!--
83+
## Module Dependencies
84+
85+
This module has dependencies on:
86+
87+
- [Labels Module](https://github.com/clouddrove/terraform-aws-labels): Provides resource tagging.
88+
- [Security Groups Module](https://github.com/clouddrove/terraform-aws-security-group): Manage security groups
89+
- [KMS Module](https://github.com/clouddrove/terraform-aws-kms): Manage resource encryption
90+
91+
92+
-->
93+
94+
95+
## Module Dependencies
96+
97+
This module has dependencies on:
98+
- [Labels Module](https://github.com/clouddrove/terraform-aws-labels): Provides resource tagging.
99+
100+
101+
## 📑 Changelog
102+
103+
Refer [here](CHANGELOG.md).
104+
105+
106+
107+
108+
## ✨ Contributors
109+
110+
Big thanks to our contributors for elevating our project with their dedication and expertise! But, we do not wish to stop there, would like to invite contributions from the community in improving these projects and making them more versatile for better reach. Remember, every bit of contribution is immensely valuable, as, together, we are moving in only 1 direction, i.e. forward.
111+
112+
<a href="https://github.com/clouddrove/terraform-aws-kafka/graphs/contributors">
113+
<img src="https://contrib.rocks/image?repo=clouddrove/terraform-aws-kafka&max" />
114+
</a>
115+
<br>
116+
<br>
117+
118+
If you're considering contributing to our project, here are a few quick guidelines that we have been following (Got a suggestion? We are all ears!):
119+
120+
- **Fork the Repository:** Create a new branch for your feature or bug fix.
121+
- **Coding Standards:** You know the drill.
122+
- **Clear Commit Messages:** Write clear and concise commit messages to facilitate understanding.
123+
- **Thorough Testing:** Test your changes thoroughly before submitting a pull request.
124+
- **Documentation Updates:** Include relevant documentation updates if your changes impact it.
125+
126+
127+
128+
129+
130+
131+
132+
133+
63134

64-
**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-aws-kafka/releases).
65-
66-
67-
### Simple Example
68-
Here is an example of how you can use this module in your inventory structure:
69-
```hcl
70-
module "kafka" {
71-
source = "clouddrove/kafka/aws"
72-
73-
name = "kafka"
74-
environment = "test"
75-
label_order = ["name", "environment"]
76-
77-
kafka_version = "2.7.1"
78-
kafka_broker_number = 3
79-
80-
broker_node_client_subnets = module.subnets.private_subnet_id
81-
broker_node_ebs_volume_size = 20
82-
broker_node_instance_type = "kafka.t3.small"
83-
broker_node_security_groups = [module.ssh.security_group_ids]
84-
85-
configuration_server_properties = {
86-
"auto.create.topics.enable" = true
87-
"delete.topic.enable" = true
88-
}
89-
}
90-
```
91-
92-
93-
94-
95-
96-
97-
## Inputs
98-
99-
| Name | Description | Type | Default | Required |
100-
|------|-------------|------|---------|:--------:|
101-
| broker\_node\_client\_subnets | A list of subnets to connect to in client VPC ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-prop-brokernodegroupinfo-clientsubnets)) | `list(string)` | `[]` | no |
102-
| broker\_node\_ebs\_volume\_size | The size in GiB of the EBS volume for the data drive on each broker node | `number` | `null` | no |
103-
| broker\_node\_instance\_type | Specify the instance type to use for the kafka brokers. e.g. kafka.m5.large. ([Pricing info](https://aws.amazon.com/msk/pricing/)) | `string` | `null` | no |
104-
| broker\_node\_security\_groups | A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster | `list(string)` | `[]` | no |
105-
| client\_authentication\_sasl\_iam | Enables IAM client authentication | `bool` | `false` | no |
106-
| client\_authentication\_sasl\_scram | Enables SCRAM client authentication via AWS Secrets Manager | `bool` | `false` | no |
107-
| client\_authentication\_tls\_certificate\_authority\_arns | List of ACM Certificate Authority Amazon Resource Names (ARNs) | `list(string)` | `[]` | no |
108-
| cloudwatch\_log\_group\_kms\_key\_id | The ARN of the KMS Key to use when encrypting log data | `string` | `null` | no |
109-
| cloudwatch\_log\_group\_name | Name of the Cloudwatch Log Group to deliver logs to | `string` | `null` | no |
110-
| cloudwatch\_log\_group\_retention\_in\_days | Specifies the number of days you want to retain log events in the log group | `number` | `0` | no |
111-
| cloudwatch\_logs\_enabled | Indicates whether you want to enable or disable streaming broker logs to Cloudwatch Logs | `bool` | `false` | no |
112-
| configuration\_description | Description of the configuration | `string` | `"Complete example configuration"` | no |
113-
| configuration\_server\_properties | Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html) | `map(string)` | `{}` | no |
114-
| create\_cloudwatch\_log\_group | Determines whether to create a CloudWatch log group | `bool` | `true` | no |
115-
| create\_schema\_registry | Determines whether to create a Glue schema registry for managing Avro schemas for the cluster | `bool` | `true` | no |
116-
| create\_scram\_secret\_association | Determines whether to create SASL/SCRAM secret association | `bool` | `false` | no |
117-
| encryption\_at\_rest\_kms\_key\_arn | You may specify a KMS key short ID or ARN (it will always output an ARN) to use for encrypting your data at rest. If no key is specified, an AWS managed KMS ('aws/msk' managed service) key will be used for encrypting the data at rest | `string` | `null` | no |
118-
| encryption\_in\_transit\_client\_broker | Encryption setting for data in transit between clients and brokers. Valid values: `TLS`, `TLS_PLAINTEXT`, and `PLAINTEXT`. Default value is `TLS` | `string` | `null` | no |
119-
| encryption\_in\_transit\_in\_cluster | Whether data communication among broker nodes is encrypted. Default value: `true` | `bool` | `null` | no |
120-
| enhanced\_monitoring | Specify the desired enhanced MSK CloudWatch monitoring level. See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html) | `string` | `"PER_TOPIC_PER_PARTITION"` | no |
121-
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
122-
| firehose\_delivery\_stream | Name of the Kinesis Data Firehose delivery stream to deliver logs to | `string` | `null` | no |
123-
| firehose\_logs\_enabled | Indicates whether you want to enable or disable streaming broker logs to Kinesis Data Firehose | `bool` | `false` | no |
124-
| jmx\_exporter\_enabled | Indicates whether you want to enable or disable the JMX Exporter | `bool` | `false` | no |
125-
| kafka\_broker\_number | Kafka brokers per zone | `number` | `1` | no |
126-
| kafka\_version | Version of Kafka brokers | `string` | `"2.2.1"` | no |
127-
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
128-
| managedby | ManagedBy, eg 'CloudDrove' | `string` | `"hello@clouddrove.com"` | no |
129-
| msk\_cluster\_enabled | Flag to control the msk-cluster creation. | `bool` | `true` | no |
130-
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
131-
| node\_exporter\_enabled | Indicates whether you want to enable or disable the Node Exporter | `bool` | `false` | no |
132-
| s3\_logs\_bucket | Name of the S3 bucket to deliver logs to | `string` | `null` | no |
133-
| s3\_logs\_enabled | Indicates whether you want to enable or disable streaming broker logs to S3 | `bool` | `false` | no |
134-
| s3\_logs\_prefix | Prefix to append to the folder name | `string` | `null` | no |
135-
| scaling\_max\_capacity | Max storage capacity for Kafka broker autoscaling | `number` | `250` | no |
136-
| scaling\_role\_arn | The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf. This defaults to an IAM Service-Linked Role | `string` | `null` | no |
137-
| scaling\_target\_value | The Kafka broker storage utilization at which scaling is initiated | `number` | `70` | no |
138-
| schema\_registries | A map of schema registries to be created | `map(any)` | `{}` | no |
139-
| schemas | A map schemas to be created within the schema registry | `map(any)` | `{}` | no |
140-
| scram\_secret\_association\_secret\_arn\_list | List of AWS Secrets Manager secret ARNs to associate with SCRAM | `list(string)` | <pre>[<br> ""<br>]</pre> | no |
141-
| timeouts | Create, update, and delete timeout configurations for the cluster | `map(string)` | `{}` | no |
142-
143-
## Outputs
144-
145-
| Name | Description |
146-
|------|-------------|
147-
| arn | Amazon Resource Name (ARN) of the MSK cluster |
148-
| configuration\_arn | Amazon Resource Name (ARN) of the configuration |
149-
| configuration\_latest\_revision | Latest revision of the configuration |
150-
| current\_version | Current version of the MSK Cluster used for updates, e.g. `K13V1IB3VIYZZH` |
151-
| scram\_secret\_association\_id | Amazon Resource Name (ARN) of the MSK cluster |
152-
153-
154-
155-
156-
## Testing
157-
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.
158-
159-
You need to run the following command in the testing folder:
160-
```hcl
161-
go test -run Test
162-
```
163135

164136

165137

166138
## Feedback
167-
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-kafka/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
139+
Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-kafka/issues), feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
140+
141+
Show some love with a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-kafka)! if our work has brightened your day! – your feedback fuels our journey!
142+
143+
144+
## :rocket: Our Accomplishment
145+
146+
We have [*100+ Terraform modules*][terraform_modules] 🙌. You could consider them finished, but, with enthusiasts like yourself, we are able to ever improve them, so we call our status - improvement in progress.
147+
148+
- [Terraform Module Registry:](https://registry.terraform.io/namespaces/clouddrove) Discover our Terraform modules here.
149+
150+
- [Terraform Modules for AWS/Azure Modules:](https://github.com/clouddrove/toc) Explore our comprehensive Table of Contents for easy navigation through our documentation for modules pertaining to AWS, Azure & GCP.
151+
152+
- [Terraform Modules for Digital Ocean:](https://github.com/terraform-do-modules/toc) Check out our specialized Terraform modules for Digital Ocean.
153+
154+
155+
156+
157+
## Join Our Slack Community
158+
159+
Join our vibrant open-source slack community and embark on an ever-evolving journey with CloudDrove; helping you in moving upwards in your career path.
160+
Join our vibrant Open Source Slack Community and embark on a learning journey with CloudDrove. Grow with us in the world of DevOps and set your career on a path of consistency.
161+
162+
🌐💬What you'll get after joining this Slack community:
163+
164+
- 🚀 Encouragement to upgrade your best version.
165+
- 🌈 Learning companionship with our DevOps squad.
166+
- 🌱 Relentless growth with daily updates on new advancements in technologies.
167+
168+
Join our tech elites [Join Now][slack] 🚀
169+
170+
171+
## Explore Our Blogs
168172

169-
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-kafka)!
173+
Click [here][blog] :books: :star2:
170174

171-
## About us
175+
## Tap into our capabilities
176+
We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions.
172177

173-
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.
178+
At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [business@clouddrove.com](mailto:business@clouddrove.com).
174179

175180
<p align="center">We are <b> The Cloud Experts!</b></p>
176181
<hr />
177-
<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>
182+
<p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://registry.terraform.io/namespaces/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
178183

179184
[website]: https://clouddrove.com
185+
[blog]: https://blog.clouddrove.com
186+
[slack]: https://www.launchpass.com/devops-talks
180187
[github]: https://github.com/clouddrove
181188
[linkedin]: https://cpco.io/linkedin
182189
[twitter]: https://twitter.com/clouddrove/

0 commit comments

Comments
 (0)