Terraform module to provision Amazon Managed Streaming for Apache Kafka
Note: this module is intended for use with an existing VPC. To create a new VPC, use terraform-aws-vpc module.
NOTE: Release 0.8.0
contains breaking changes that will result in the destruction of your existing MSK cluster.
To preserve the original cluster, follow the instructions in the 0.7.x to 0.8.x+ migration path.
Tip
Cloud Posse uses atmos
to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.
Watch demo of using Atmos with Terraform
![](https://github.com/cloudposse/atmos/raw/master/docs/demo.gif?raw=true)
Example of running
atmos
to manage infrastructure from our Quick Start tutorial.
Here's how to invoke this example module in your projects
module "kafka" {
source = "cloudposse/msk-apache-kafka-cluster/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
kafka_version = "3.3.2"
namespace = "eg"
stage = "prod"
name = "app"
vpc_id = "vpc-XXXXXXXX"
subnet_ids = ["subnet-XXXXXXXXX", "subnet-YYYYYYYY"]
broker_per_zone = 2
broker_instance_type = "kafka.m5.large"
# A list of IDs of Security Groups to associate the created resource with, in addition to the created security group
associated_security_group_ids = ["sg-XXXXXXXXX", "sg-YYYYYYYY"]
# A list of IDs of Security Groups to allow access to the cluster
allowed_security_group_ids = ["sg-XXXXXXXXX", "sg-YYYYYYYY"]
}
Important
In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.
Here is an example of using this module:
examples/complete
- complete example of using this module
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Version |
---|---|
terraform | >= 1.0.0 |
aws | >= 4.0 |
Name | Version |
---|---|
aws | >= 4.0 |
Name | Source | Version |
---|---|---|
hostname | cloudposse/route53-cluster-hostname/aws | 0.13.0 |
security_group | cloudposse/security-group/aws | 2.2.0 |
this | cloudposse/label/null | 0.25.0 |
Name | Type |
---|---|
aws_appautoscaling_policy.default | resource |
aws_appautoscaling_target.default | resource |
aws_msk_cluster.default | resource |
aws_msk_configuration.config | resource |
aws_msk_scram_secret_association.default | resource |
aws_msk_broker_nodes.default | data source |
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_security_group_rules | A list of Security Group rule objects to add to the created security group, in addition to the ones this module normally creates. (To suppress the module's rules, set create_security_group to falseand supply your own security group(s) via associated_security_group_ids .)The keys and values of the objects are fully compatible with the aws_security_group_rule resource, exceptfor security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.For more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule and https://github.com/cloudposse/terraform-aws-security-group. |
list(any) |
[] |
no |
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. |
map(string) |
{} |
no |
allow_all_egress | If true , the created security group will allow egress on all ports and protocols to all IP addresses.If this is false and no egress rules are otherwise specified, then no egress will be allowed. |
bool |
true |
no |
allowed_cidr_blocks | A list of IPv4 CIDRs to allow access to the security group created by this module. The length of this list must be known at "plan" time. |
list(string) |
[] |
no |
allowed_security_group_ids | A list of IDs of Security Groups to allow access to the security group created by this module. The length of this list must be known at "plan" time. |
list(string) |
[] |
no |
associated_security_group_ids | A list of IDs of Security Groups to associate the created resource with, in addition to the created security group. These security groups will not be modified and, if create_security_group is false , must have rules providing the desired access. |
list(string) |
[] |
no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. |
list(string) |
[] |
no |
autoscaling_enabled | To automatically expand your cluster's storage in response to increased usage, you can enable this. More info | bool |
true |
no |
broker_dns_records_count | This variable specifies how many DNS records to create for the broker endpoints in the DNS zone provided in the zone_id variable.This corresponds to the total number of broker endpoints created by the module. Calculate this number by multiplying the broker_per_zone variable by the subnet count.This variable is necessary to prevent the Terraform error: The "count" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many instances will be created. |
number |
0 |
no |
broker_instance_type | The instance type to use for the Kafka brokers | string |
n/a | yes |
broker_per_zone | Number of Kafka brokers per zone | number |
1 |
no |
broker_volume_size | The size in GiB of the EBS volume for the data drive on each broker node | number |
1000 |
no |
certificate_authority_arns | List of ACM Certificate Authority Amazon Resource Names (ARNs) to be used for TLS client authentication | list(string) |
[] |
no |
client_allow_unauthenticated | Enable unauthenticated access | bool |
false |
no |
client_broker | Encryption setting for data in transit between clients and brokers. Valid values: TLS , TLS_PLAINTEXT , and PLAINTEXT |
string |
"TLS" |
no |
client_sasl_iam_enabled | Enable client authentication via IAM policies. Cannot be set to true at the same time as client_tls_auth_enabled |
bool |
false |
no |
client_sasl_scram_enabled | Enable SCRAM client authentication via AWS Secrets Manager. Cannot be set to true at the same time as client_tls_auth_enabled |
bool |
false |
no |
client_sasl_scram_secret_association_arns | List of AWS Secrets Manager secret ARNs for SCRAM authentication | list(string) |
[] |
no |
client_sasl_scram_secret_association_enabled | Enable the list of AWS Secrets Manager secret ARNs for SCRAM authentication | bool |
true |
no |
client_tls_auth_enabled | Set true to enable the Client TLS Authentication |
bool |
false |
no |
cloudwatch_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to Cloudwatch Logs | bool |
false |
no |
cloudwatch_logs_log_group | Name of the Cloudwatch Log Group to deliver logs to | string |
null |
no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. |
any |
{ |
no |
create_security_group | Set true to create and configure a new security group. If false, associated_security_group_ids must be provided. |
bool |
true |
no |
custom_broker_dns_name | Custom Route53 DNS hostname for MSK brokers. Use %%ID%% key to specify brokers index in the hostname. Example: kafka-broker%%ID%%.example.com |
string |
null |
no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br> format = string<br> labels = list(string)<br>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). |
any |
{} |
no |
enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
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 | string |
"" |
no |
encryption_in_cluster | Whether data communication among broker nodes is encrypted | bool |
true |
no |
enhanced_monitoring | Specify the desired enhanced MSK CloudWatch monitoring level. Valid values: DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER |
string |
"DEFAULT" |
no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
firehose_delivery_stream | Name of the Kinesis Data Firehose delivery stream to deliver logs to | string |
"" |
no |
firehose_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to Kinesis Data Firehose | bool |
false |
no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . |
number |
null |
no |
inline_rules_enabled | NOT RECOMMENDED. Create rules "inline" instead of as separate aws_security_group_rule resources.See #20046 for one of several issues with inline rules. See this post for details on the difference between inline rules and rule resources. |
bool |
false |
no |
jmx_exporter_enabled | Set true to enable the JMX Exporter |
bool |
false |
no |
kafka_version | The desired Kafka software version. Refer to https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html for more details |
string |
n/a | yes |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . |
string |
null |
no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |
list(string) |
null |
no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . |
string |
null |
no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. |
string |
null |
no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
node_exporter_enabled | Set true to enable the Node Exporter |
bool |
false |
no |
preserve_security_group_id | When false and security_group_create_before_destroy is true , changes to security group rulescause a new security group to be created with the new rules, and the existing security group is then replaced with the new one, eliminating any service interruption. When true or when changing the value (from false to true or from true to false ),existing security group rules will be deleted before new ones are created, resulting in a service interruption, but preserving the security group itself. NOTE: Setting this to true does not guarantee the security group will never be replaced,it only keeps changes to the security group rules from triggering a replacement. See the terraform-aws-security-group README for further discussion. |
bool |
false |
no |
properties | Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide | map(string) |
{} |
no |
public_access_enabled | Enable public access to MSK cluster (given that all of the requirements are met) | bool |
false |
no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
s3_logs_bucket | Name of the S3 bucket to deliver logs to | string |
"" |
no |
s3_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to S3 | bool |
false |
no |
s3_logs_prefix | Prefix to append to the S3 folder name logs are delivered to | string |
"" |
no |
security_group_create_before_destroy | Set true to enable terraform create_before_destroy behavior on the created security group.We only recommend setting this false if you are importing an existing security groupthat you do not want replaced and therefore need full control over its name. Note that changing this value will always cause the security group to be replaced. |
bool |
true |
no |
security_group_create_timeout | How long to wait for the security group to be created. | string |
"10m" |
no |
security_group_delete_timeout | How long to retry on DependencyViolation errors during security group deletion fromlingering ENIs left by certain AWS services such as Elastic Load Balancing. |
string |
"15m" |
no |
security_group_description | The description to assign to the created Security Group. Warning: Changing the description causes the security group to be replaced. |
string |
"Managed by Terraform" |
no |
security_group_name | The name to assign to the created security group. Must be unique within the VPC. If not provided, will be derived from the null-label.context passed in.If create_before_destroy is true, will be used as a name prefix. |
list(string) |
[] |
no |
security_group_rule_description | The description to place on each security group rule. The %s will be replaced with the protocol name | string |
"Allow inbound %s traffic" |
no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
storage_autoscaling_disable_scale_in | If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource | bool |
false |
no |
storage_autoscaling_max_capacity | Maximum size the autoscaling policy can scale storage. Defaults to broker_volume_size |
number |
null |
no |
storage_autoscaling_target_value | Percentage of storage used to trigger autoscaled storage increase | number |
60 |
no |
subnet_ids | Subnet IDs for Client Broker | list(string) |
n/a | yes |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
vpc_id | The ID of the VPC where the Security Group will be created. | string |
n/a | yes |
zone_id | Route53 DNS Zone ID for MSK broker hostnames | string |
null |
no |
Name | Description |
---|---|
bootstrap_brokers | Comma separated list of one or more hostname:port pairs of Kafka brokers suitable to bootstrap connectivity to the Kafka cluster |
bootstrap_brokers_public_sasl_iam | Comma separated list of one or more DNS names (or IP addresses) and SASL IAM port pairs for public access to the Kafka cluster using SASL/IAM |
bootstrap_brokers_public_sasl_scram | Comma separated list of one or more DNS names (or IP addresses) and SASL SCRAM port pairs for public access to the Kafka cluster using SASL/SCRAM |
bootstrap_brokers_public_tls | Comma separated list of one or more DNS names (or IP addresses) and TLS port pairs for public access to the Kafka cluster using TLS |
bootstrap_brokers_sasl_iam | Comma separated list of one or more DNS names (or IP addresses) and SASL IAM port pairs for access to the Kafka cluster using SASL/IAM |
bootstrap_brokers_sasl_scram | Comma separated list of one or more DNS names (or IP addresses) and SASL SCRAM port pairs for access to the Kafka cluster using SASL/SCRAM |
bootstrap_brokers_tls | Comma separated list of one or more DNS names (or IP addresses) and TLS port pairs for access to the Kafka cluster using TLS |
broker_endpoints | List of broker endpoints |
cluster_arn | Amazon Resource Name (ARN) of the MSK cluster |
cluster_name | MSK Cluster name |
config_arn | Amazon Resource Name (ARN) of the MSK configuration |
current_version | Current version of the MSK Cluster |
hostnames | List of MSK Cluster broker DNS hostnames |
latest_revision | Latest revision of the MSK configuration |
security_group_arn | The ARN of the created security group |
security_group_id | The ID of the created security group |
security_group_name | n/a |
storage_mode | Storage mode for supported storage tiers |
zookeeper_connect_string | Comma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster |
zookeeper_connect_string_tls | Comma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster via TLS |
Check out these related projects.
- terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.
- terraform-aws-route53-cluster-hostname - Terraform module to define a consistent AWS Route53 hostname
- terraform-aws-vpc - Terraform module to provision a VPC with Internet Gateway.
For additional context, refer to some of these links.
- Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
- Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
- Terraform
random_integer
Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource. - Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration
Tip
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
โ
We build it together with your team.
โ
Your team owns everything.
โ
100% Open Source and backed by fanatical support.
๐ Learn More
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your teamโs code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
For ๐ bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Join our Open Source Community 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.
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week โ and usually a 5-minute read.
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canโt find anywhere else. It's FREE for everyone!
Preamble to the Apache License, Version 2.0
Complete license is available in the LICENSE
file.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
Copyright ยฉ 2020-2024 Cloud Posse, LLC