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 VPN

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove//terraform-aws-vpn.svg"
    url: "https://github.com/clouddrove//terraform-aws-vpn/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove//terraform-aws-vpn/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove//terraform-aws-vpn/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.5.5"

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

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.


#  description of this project
description: |-
  Terraform module is used to create VPN resource on AWS for network connectivity..

# How to use this project
# How to use this project
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
    module "vpn" {
        source                   = "clouddrove/vpn/aws"
        version                  = "2.0.0"

        name                                      = local.name
        environment                               = local.environment
        vpc_id                                    = module.vpc.vpc_id
        customer_ip_address                       = "115.160.246.74"
        local_ipv4_network_cidr                   = "0.0.0.0/0"
        remote_ipv4_network_cidr                  = module.vpc.vpc_cidr_block
        vpn_connection_static_routes_destinations = ["10.80.1.0/24"]
    }
  ```