Awesome
<!-- markdownlint-disable --><a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-msk/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-msk.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->This component is responsible for provisioning Amazon Managed Streaming clusters for Apache Kafka.
Usage
Stack Level: Regional
Here's an example snippet for how to use this component.
components:
terraform:
msk:
metadata:
component: "msk"
vars:
enabled: true
name: "msk"
vpc_component_name: "vpc"
dns_delegated_component_name: "dns-delegated"
dns_delegated_environment_name: "gbl"
# https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html
kafka_version: "3.4.0"
public_access_enabled: false
# https://aws.amazon.com/msk/pricing/
broker_instance_type: "kafka.m5.large"
# Number of brokers per AZ
broker_per_zone: 1
# `broker_dns_records_count` 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.
broker_dns_records_count: 3
broker_volume_size: 500
client_broker: "TLS_PLAINTEXT"
encryption_in_cluster: true
encryption_at_rest_kms_key_arn: ""
enhanced_monitoring: "DEFAULT"
certificate_authority_arns: []
# Authentication methods
client_allow_unauthenticated: true
client_sasl_scram_enabled: false
client_sasl_scram_secret_association_enabled: false
client_sasl_scram_secret_association_arns: []
client_sasl_iam_enabled: false
client_tls_auth_enabled: false
jmx_exporter_enabled: false
node_exporter_enabled: false
cloudwatch_logs_enabled: false
firehose_logs_enabled: false
firehose_delivery_stream: ""
s3_logs_enabled: false
s3_logs_bucket: ""
s3_logs_prefix: ""
properties: {}
autoscaling_enabled: true
storage_autoscaling_target_value: 60
storage_autoscaling_max_capacity: null
storage_autoscaling_disable_scale_in: false
create_security_group: true
security_group_rule_description: "Allow inbound %s traffic"
# A list of IDs of Security Groups to allow access to the cluster security group
allowed_security_group_ids: []
# A list of IPv4 CIDRs to allow access to the cluster security group
allowed_cidr_blocks: []
<!-- prettier-ignore-start -->
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Requirements
Name | Version |
---|---|
<a name="requirement_terraform"></a> terraform | >= 1.0.0 |
<a name="requirement_aws"></a> aws | >= 4.9.0 |
Providers
No providers.
Modules
Name | Source | Version |
---|---|---|
<a name="module_dns_delegated"></a> dns_delegated | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_iam_roles"></a> iam_roles | ../account-map/modules/iam-roles | n/a |
<a name="module_kafka"></a> kafka | cloudposse/msk-apache-kafka-cluster/aws | 2.3.0 |
<a name="module_this"></a> this | cloudposse/label/null | 0.25.0 |
<a name="module_vpc"></a> vpc | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
Resources
No resources.
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
<a name="input_additional_security_group_rules"></a> additional_security_group_rules | A list of Security Group rule objects to add to the created security group, in addition to the ones<br>this module normally creates. (To suppress the module's rules, set create_security_group to false<br>and supply your own security group(s) via associated_security_group_ids .)<br>The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except<br>for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.<br>For more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule<br>and https://github.com/cloudposse/terraform-aws-security-group. | list(any) | [] | no |
<a name="input_additional_tag_map"></a> additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
<a name="input_allow_all_egress"></a> allow_all_egress | If true , the created security group will allow egress on all ports and protocols to all IP addresses.<br>If this is false and no egress rules are otherwise specified, then no egress will be allowed. | bool | true | no |
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocks | A list of IPv4 CIDRs to allow access to the security group created by this module.<br>The length of this list must be known at "plan" time. | list(string) | [] | no |
<a name="input_allowed_security_group_ids"></a> allowed_security_group_ids | A list of IDs of Security Groups to allow access to the security group created by this module.<br>The length of this list must be known at "plan" time. | list(string) | [] | no |
<a name="input_associated_security_group_ids"></a> associated_security_group_ids | A list of IDs of Security Groups to associate the created resource with, in addition to the created security group.<br>These security groups will not be modified and, if create_security_group is false , must have rules providing the desired access. | list(string) | [] | no |
<a name="input_attributes"></a> attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the delimiter <br>and treated as a single ID element. | list(string) | [] | no |
<a name="input_autoscaling_enabled"></a> autoscaling_enabled | To automatically expand your cluster's storage in response to increased usage, you can enable this. More info | bool | true | no |
<a name="input_broker_dns_records_count"></a> 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.<br>This corresponds to the total number of broker endpoints created by the module.<br>Calculate this number by multiplying the broker_per_zone variable by the subnet count.<br>This variable is necessary to prevent the Terraform error:<br>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 |
<a name="input_broker_instance_type"></a> broker_instance_type | The instance type to use for the Kafka brokers | string | n/a | yes |
<a name="input_broker_per_zone"></a> broker_per_zone | Number of Kafka brokers per zone | number | 1 | no |
<a name="input_broker_volume_size"></a> broker_volume_size | The size in GiB of the EBS volume for the data drive on each broker node | number | 1000 | no |
<a name="input_certificate_authority_arns"></a> certificate_authority_arns | List of ACM Certificate Authority Amazon Resource Names (ARNs) to be used for TLS client authentication | list(string) | [] | no |
<a name="input_client_allow_unauthenticated"></a> client_allow_unauthenticated | Enable unauthenticated access | bool | false | no |
<a name="input_client_broker"></a> client_broker | Encryption setting for data in transit between clients and brokers. Valid values: TLS , TLS_PLAINTEXT , and PLAINTEXT | string | "TLS" | no |
<a name="input_client_sasl_iam_enabled"></a> 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 |
<a name="input_client_sasl_scram_enabled"></a> 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 |
<a name="input_client_sasl_scram_secret_association_arns"></a> client_sasl_scram_secret_association_arns | List of AWS Secrets Manager secret ARNs for SCRAM authentication | list(string) | [] | no |
<a name="input_client_sasl_scram_secret_association_enabled"></a> client_sasl_scram_secret_association_enabled | Enable the list of AWS Secrets Manager secret ARNs for SCRAM authentication | bool | true | no |
<a name="input_client_tls_auth_enabled"></a> client_tls_auth_enabled | Set true to enable the Client TLS Authentication | bool | false | no |
<a name="input_cloudwatch_logs_enabled"></a> cloudwatch_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to Cloudwatch Logs | bool | false | no |
<a name="input_cloudwatch_logs_log_group"></a> cloudwatch_logs_log_group | Name of the Cloudwatch Log Group to deliver logs to | string | null | no |
<a name="input_context"></a> context | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as null to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged. | any | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
<a name="input_create_security_group"></a> 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 |
<a name="input_custom_broker_dns_name"></a> 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 |
<a name="input_delimiter"></a> delimiter | Delimiter to be used between ID elements.<br>Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
<a name="input_descriptor_formats"></a> descriptor_formats | Describe additional descriptors to be output in the descriptors output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>{<br> format = string<br> labels = list(string)<br>} <br>(Type is any so the map values can later be enhanced to provide additional options.)<br>format is a Terraform format string to be passed to the format() function.<br>labels is a list of labels, in order, to pass to format() function.<br>Label values will be normalized before being passed to format() so they will be<br>identical to how they appear in id .<br>Default is {} (descriptors output will be empty). | any | {} | no |
<a name="input_dns_delegated_component_name"></a> dns_delegated_component_name | The component name of dns-delegated | string | "dns-delegated" | no |
<a name="input_dns_delegated_environment_name"></a> dns_delegated_environment_name | The environment name of dns-delegated | string | "gbl" | no |
<a name="input_enabled"></a> enabled | Set to false to prevent the module from creating any resources | bool | null | no |
<a name="input_encryption_at_rest_kms_key_arn"></a> 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 |
<a name="input_encryption_in_cluster"></a> encryption_in_cluster | Whether data communication among broker nodes is encrypted | bool | true | no |
<a name="input_enhanced_monitoring"></a> enhanced_monitoring | Specify the desired enhanced MSK CloudWatch monitoring level. Valid values: DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER | string | "DEFAULT" | no |
<a name="input_environment"></a> environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
<a name="input_firehose_delivery_stream"></a> firehose_delivery_stream | Name of the Kinesis Data Firehose delivery stream to deliver logs to | string | "" | no |
<a name="input_firehose_logs_enabled"></a> firehose_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to Kinesis Data Firehose | bool | false | no |
<a name="input_id_length_limit"></a> id_length_limit | Limit id to this many characters (minimum 6).<br>Set to 0 for unlimited length.<br>Set to null for keep the existing setting, which defaults to 0 .<br>Does not affect id_full . | number | null | no |
<a name="input_inline_rules_enabled"></a> inline_rules_enabled | NOT RECOMMENDED. Create rules "inline" instead of as separate aws_security_group_rule resources.<br>See #20046 for one of several issues with inline rules.<br>See this post for details on the difference between inline rules and rule resources. | bool | false | no |
<a name="input_jmx_exporter_enabled"></a> jmx_exporter_enabled | Set true to enable the JMX Exporter | bool | false | no |
<a name="input_kafka_version"></a> kafka_version | The desired Kafka software version.<br>Refer to https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html for more details | string | n/a | yes |
<a name="input_label_key_case"></a> label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the tags input.<br>Possible values: lower , title , upper .<br>Default value: title . | string | null | no |
<a name="input_label_order"></a> label_order | The order in which the labels (ID elements) appear in the id .<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
<a name="input_label_value_case"></a> label_value_case | Controls the letter case of ID elements (labels) as included in id ,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the tags input.<br>Possible values: lower , title , upper and none (no transformation).<br>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br>Default value: lower . | string | null | no |
<a name="input_labels_as_tags"></a> labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the tags output.<br>Set to [] to suppress all generated tags.<br>Notes:<br> The value of the name tag, if included, will be the id , not the name .<br> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | set(string) | <pre>[<br> "default"<br>]</pre> | no |
<a name="input_name"></a> name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a tag .<br>The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
<a name="input_namespace"></a> 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 |
<a name="input_node_exporter_enabled"></a> node_exporter_enabled | Set true to enable the Node Exporter | bool | false | no |
<a name="input_preserve_security_group_id"></a> preserve_security_group_id | When false and security_group_create_before_destroy is true , changes to security group rules<br>cause a new security group to be created with the new rules, and the existing security group is then<br>replaced with the new one, eliminating any service interruption.<br>When true or when changing the value (from false to true or from true to false ),<br>existing security group rules will be deleted before new ones are created, resulting in a service interruption,<br>but preserving the security group itself.<br>NOTE: Setting this to true does not guarantee the security group will never be replaced,<br>it only keeps changes to the security group rules from triggering a replacement.<br>See the terraform-aws-security-group README for further discussion. | bool | false | no |
<a name="input_properties"></a> properties | Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide | map(string) | {} | no |
<a name="input_public_access_enabled"></a> public_access_enabled | Enable public access to MSK cluster (given that all of the requirements are met) | bool | false | no |
<a name="input_regex_replace_chars"></a> regex_replace_chars | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
<a name="input_region"></a> region | AWS region | string | n/a | yes |
<a name="input_s3_logs_bucket"></a> s3_logs_bucket | Name of the S3 bucket to deliver logs to | string | "" | no |
<a name="input_s3_logs_enabled"></a> s3_logs_enabled | Indicates whether you want to enable or disable streaming broker logs to S3 | bool | false | no |
<a name="input_s3_logs_prefix"></a> s3_logs_prefix | Prefix to append to the S3 folder name logs are delivered to | string | "" | no |
<a name="input_security_group_create_before_destroy"></a> security_group_create_before_destroy | Set true to enable terraform create_before_destroy behavior on the created security group.<br>We only recommend setting this false if you are importing an existing security group<br>that you do not want replaced and therefore need full control over its name.<br>Note that changing this value will always cause the security group to be replaced. | bool | true | no |
<a name="input_security_group_create_timeout"></a> security_group_create_timeout | How long to wait for the security group to be created. | string | "10m" | no |
<a name="input_security_group_delete_timeout"></a> security_group_delete_timeout | How long to retry on DependencyViolation errors during security group deletion from<br>lingering ENIs left by certain AWS services such as Elastic Load Balancing. | string | "15m" | no |
<a name="input_security_group_description"></a> security_group_description | The description to assign to the created Security Group.<br>Warning: Changing the description causes the security group to be replaced. | string | "Managed by Terraform" | no |
<a name="input_security_group_name"></a> security_group_name | The name to assign to the created security group. Must be unique within the VPC.<br>If not provided, will be derived from the null-label.context passed in.<br>If create_before_destroy is true, will be used as a name prefix. | list(string) | [] | no |
<a name="input_security_group_rule_description"></a> 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 |
<a name="input_stage"></a> stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
<a name="input_storage_autoscaling_disable_scale_in"></a> 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 |
<a name="input_storage_autoscaling_max_capacity"></a> storage_autoscaling_max_capacity | Maximum size the autoscaling policy can scale storage. Defaults to broker_volume_size | number | null | no |
<a name="input_storage_autoscaling_target_value"></a> storage_autoscaling_target_value | Percentage of storage used to trigger autoscaled storage increase | number | 60 | no |
<a name="input_tags"></a> tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).<br>Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
<a name="input_tenant"></a> tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
<a name="input_vpc_component_name"></a> vpc_component_name | The name of the Atmos VPC component | string | n/a | yes |
Outputs
Name | Description |
---|---|
<a name="output_bootstrap_brokers"></a> bootstrap_brokers | Comma separated list of one or more hostname:port pairs of Kafka brokers suitable to bootstrap connectivity to the Kafka cluster |
<a name="output_bootstrap_brokers_public_sasl_iam"></a> 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 |
<a name="output_bootstrap_brokers_public_sasl_scram"></a> 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 |
<a name="output_bootstrap_brokers_public_tls"></a> 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 |
<a name="output_bootstrap_brokers_sasl_iam"></a> 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 |
<a name="output_bootstrap_brokers_sasl_scram"></a> 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 |
<a name="output_bootstrap_brokers_tls"></a> 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 |
<a name="output_broker_endpoints"></a> broker_endpoints | List of broker endpoints |
<a name="output_cluster_arn"></a> cluster_arn | Amazon Resource Name (ARN) of the MSK cluster |
<a name="output_cluster_name"></a> cluster_name | The cluster name of the MSK cluster |
<a name="output_config_arn"></a> config_arn | Amazon Resource Name (ARN) of the MSK configuration |
<a name="output_current_version"></a> current_version | Current version of the MSK Cluster |
<a name="output_hostnames"></a> hostnames | List of MSK Cluster broker DNS hostnames |
<a name="output_latest_revision"></a> latest_revision | Latest revision of the MSK configuration |
<a name="output_security_group_arn"></a> security_group_arn | The ARN of the created security group |
<a name="output_security_group_id"></a> security_group_id | The ID of the created security group |
<a name="output_security_group_name"></a> security_group_name | The name of the created security group |
<a name="output_storage_mode"></a> storage_mode | Storage mode for supported storage tiers |
<a name="output_zookeeper_connect_string"></a> zookeeper_connect_string | Comma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster |
<a name="output_zookeeper_connect_string_tls"></a> zookeeper_connect_string_tls | Comma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster via TLS |
References
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/msk_cluster
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/msk_serverless_cluster
- https://aws.amazon.com/blogs/big-data/securing-apache-kafka-is-easy-and-familiar-with-iam-access-control-for-amazon-msk/
- https://docs.aws.amazon.com/msk/latest/developerguide/security-iam.html
- https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html
- https://docs.aws.amazon.com/msk/latest/developerguide/kafka_apis_iam.html
- https://github.com/aws/aws-msk-iam-auth
- https://www.cloudthat.com/resources/blog/a-guide-to-create-aws-msk-cluster-with-iam-based-authentication
- https://blog.devops.dev/how-to-use-iam-auth-with-aws-msk-a-step-by-step-guide-2023-eb8291781fcb
- https://www.kai-waehner.de/blog/2022/08/30/when-not-to-choose-amazon-msk-serverless-for-apache-kafka/
- https://stackoverflow.com/questions/72508438/connect-python-to-msk-with-iam-role-based-authentication
- https://github.com/aws/aws-msk-iam-auth/issues/10
- https://aws.amazon.com/msk/faqs/
- https://aws.amazon.com/blogs/big-data/secure-connectivity-patterns-to-access-amazon-msk-across-aws-regions/
- https://docs.aws.amazon.com/msk/latest/developerguide/client-access.html
- https://repost.aws/knowledge-center/msk-broker-custom-ports
[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary><strong>Learn More</strong></summary>It's 100% Open Source and licensed under the APACHE2.
</details>
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
Related Projects
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
β¨ Contributing
This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:
<a href="https://github.com/cloudposse-terraform-components/aws-msk/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-msk&max=24" /> </a>π Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
π» Developing
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
Hit us up in Slack, in the #cloudposse
channel.
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!
π Slack Community
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.
π° Newsletter
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.
π Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
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!
About
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
Your team can operate like a pro today.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
<details> <summary>π <strong>See What's Included</strong></summary>- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
License
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>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.
</details>
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright Β© 2017-2024 Cloud Posse, LLC
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-msk&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-msk?pixel&cs=github&cm=readme&an=aws-msk"/>