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 Subnet

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-subnet.svg"
    url: "https://github.com/clouddrove/terraform-aws-subnet/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-subnet/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-subnet/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: |-
  Terraform module to create public, private and public-private subnet with network acl, route table, Elastic IP, nat gateway, flow log.


# How to use this project
usage: |-
  Here are some examples of how you can use this module in your inventory structure:
  ### PRIVATE SUBNET
  ```hcl
    module "private-subnets" {
      source                = "clouddrove/terraform-aws-subnet/aws"
      name                  = "subnets"
      environment           = "test"
      nat_gateway_enabled   = true
      availability_zones    = ["eu-west-1a", "eu-west-1b", "eu-west-1c"]
      vpc_id                = module.vpc.vpc_id
      type                  = "private"
      cidr_block            = module.vpc.vpc_cidr_block
      ipv6_cidr_block       = module.vpc.ipv6_cidr_block
      public_subnet_ids     = ["subnet-xxxxxxxxxxxx", "subnet-xxxxxxxxxxxx"]
  }
  ```

  ### PUBLIC-PRIVATE SUBNET
  ```hcl
    module "subnets" {
      source                                         = "clouddrove/terraform-aws-subnet/aws"
      name                                           = "subnets"
      environment                                    = "test"
      label_order                                    = ["name", "environment"]
      nat_gateway_enabled                            = true
      availability_zones                             = ["eu-west-1a", "eu-west-1b", "eu-west-1c"]
      vpc_id                                         = module.vpc.vpc_id
      type                                           = "public-private"
      igw_id                                         = module.vpc.igw_id
      cidr_block                                     = module.vpc.vpc_cidr_block
      ipv6_cidr_block                                = module.vpc.ipv6_cidr_block
      enable_ipv6                                    = true
    }
  ```

  ### PUBLIC SUBNET
  ```hcl
    module "subnets" {
      source             = "clouddrove/terraform-aws-subnet/aws"
      name               = "subnets"
      environment        = "test"
      label_order        = ["name", "environment"]
      availability_zones = ["us-east-1a", "us-east-1b", "us-east-1c"]
      vpc_id             = module.vpc.vpc_id
      type               = "public"
      igw_id             = module.vpc.igw_id
      ipv4_public_cidrs  = ["10.0.1.0/24", "10.0.13.0/24", "10.0.18.0/24"]
      enable_ipv6        = false
    }
  ```