README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AWS kafka

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-kafka

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-msk.svg"
    url: "https://github.com/clouddrove/terraform-aws-msk/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-msk/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-msk/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.
    
#  description of this project
description: |-
  Terraform module to create kafka resource on AWS.

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
    module "kafka" {
       source      = "clouddrove/kafka/aws"

       name        = "kafka"
       environment = "test"
       label_order = ["name", "environment"]

       kafka_version          = "2.7.1"
       kafka_broker_number    = 3

       broker_node_client_subnets  = module.subnets.private_subnet_id
       broker_node_ebs_volume_size = 20
       broker_node_instance_type   = "kafka.t3.small"
       broker_node_security_groups = [module.ssh.security_group_ids]

       configuration_server_properties = {
       "auto.create.topics.enable" = true
       "delete.topic.enable"       = true
      }
    }
  ```