From 3372a96d07add316841e2dae68258ac1f15c23e7 Mon Sep 17 00:00:00 2001 From: Rohith Jayawardene Date: Mon, 1 Apr 2024 20:45:50 +0100 Subject: [PATCH] chore: adding the correct readme --- Makefile | 10 +++++++++ README.md | 45 +++++++++++++++++++++++++++++++++----- examples/trusted/README.md | 2 +- 3 files changed, 50 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index d51fdc5..4cf0cbf 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,8 @@ AUTHOR_EMAIL=info@appvia.io default: all all: + $(MAKE) init + $(MAKE) validate $(MAKE) security $(MAKE) lint $(MAKE) format @@ -39,6 +41,14 @@ documentation-examples: @echo "--> Generating documentation examples" @find examples -type d -mindepth 1 -maxdepth 1 -exec terraform-docs markdown table --output-file README.md --output-mode inject {} \; +init: + @echo "--> Running terraform init" + @terraform init -backend=false + +validate: + @echo "--> Running terraform validate" + @terraform validate + lint: @echo "--> Running tflint" @tflint --init diff --git a/README.md b/README.md index 37bf231..f556b26 100644 --- a/README.md +++ b/README.md @@ -34,25 +34,58 @@ The `terraform-docs` utility is used to generate this README. Follow the below s |------|---------| | [terraform](#requirement\_terraform) | >= 1.0.7 | | [aws](#requirement\_aws) | >= 5.0.0 | -| [awscc](#requirement\_awscc) | >= 0.24.0 | ## Providers -No providers. +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | >= 5.0.0 | ## Modules -No modules. +| Name | Source | Version | +|------|--------|---------| +| [egress\_vpc](#module\_egress\_vpc) | appvia/network/aws | 0.1.3 | +| [ingress\_vpc](#module\_ingress\_vpc) | appvia/network/aws | 0.1.3 | +| [inspection](#module\_inspection) | ./modules/tgw_inspection | n/a | +| [share\_prefixes](#module\_share\_prefixes) | ./modules/prefix_share | n/a | +| [tgw](#module\_tgw) | terraform-aws-modules/transit-gateway/aws | 2.12.2 | +| [trusted](#module\_trusted) | ./modules/tgw_trusted | n/a | ## Resources -No resources. +| Name | Type | +|------|------| +| [aws_ec2_managed_prefix_list.prefixes](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_managed_prefix_list) | resource | +| [aws_ec2_transit_gateway_route.inspection_egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_transit_gateway_route) | resource | +| [aws_ec2_transit_gateway_route.trusted_default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_transit_gateway_route) | resource | +| [aws_ec2_transit_gateway_route.trusted_route_table](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_transit_gateway_route) | resource | +| [aws_ram_principal_association.associations](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ram_principal_association) | resource | +| [aws_ram_resource_association.prefixes](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ram_resource_association) | resource | +| [aws_ram_resource_share.prefixes](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ram_resource_share) | resource | ## Inputs -No inputs. +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [amazon\_side\_asn](#input\_amazon\_side\_asn) | The ASN for the transit gateway. | `number` | n/a | yes | +| [connectivity\_config](#input\_connectivity\_config) | The type of connectivity options for the transit gateway. | 
object({
    egress = optional(object({
      attachment_id = optional(string, "")
      network = optional(object({
        availability_zones = number
        ipam_pool_id       = optional(string, null)
        name               = optional(string, "egress")
        vpc_cidr           = optional(string, null)
        vpc_netmask        = optional(string, null)
      }), null)
    }), null)
    ingress = optional(object({
      attachment_id = optional(string, "")
      network = optional(object({
        availability_zones = number
        ipam_pool_id       = optional(string, null)
        name               = optional(string, "ingress")
        private_netmask    = optional(number, null)
        public_netmask     = optional(number, null)
        vpc_cidr           = optional(string, null)
        vpc_netmask        = optional(string, null)
      }), null)
    }), null)
    inspection = optional(object({
      attachment_id            = optional(string, "")
      inbound_route_table_name = optional(string, "inbound")
      spokes_route_table_name  = optional(string, "spokes")
    }), null)
    trusted = optional(object({
      trusted_attachments      = optional(list(string), [])
      trusted_route_table_name = optional(string, "trusted")
    }), null)
  })
| n/a | yes | +| [description](#input\_description) | The description of the transit gateway to provision. | `string` | n/a | yes | +| [tags](#input\_tags) | A map of tags to add to all resources. | `map(string)` | n/a | yes | +| [enable\_dns\_support](#input\_enable\_dns\_support) | Whether DNS support is enabled. | `bool` | `true` | no | +| [enable\_external\_principals](#input\_enable\_external\_principals) | Whether to enable external principals in the RAM share. | `bool` | `true` | no | +| [enable\_multicast\_support](#input\_enable\_multicast\_support) | Whether multicast support is enabled. | `bool` | `false` | no | +| [enable\_vpn\_ecmp\_support](#input\_enable\_vpn\_ecmp\_support) | Whether VPN Equal Cost Multipath Protocol support is enabled. | `bool` | `false` | no | +| [name](#input\_name) | The name of the transit gateway to provision. | `string` | `"tgw-hub"` | no | +| [prefix\_lists](#input\_prefix\_lists) | Provides the ability to provision prefix lists, and share them with other accounts. | 
list(object({
    name = string
    entry = list(object({
      address_family = optional(string, "IPv4")
      cidr           = string
      description    = string
      max_entries    = number
    }))
  }))
| `[]` | no | +| [prefix\_ram\_principals](#input\_prefix\_ram\_principals) | The list of organizational units or accounts to share the prefix lists with. | `list(string)` | `[]` | no | +| [ram\_share\_name](#input\_ram\_share\_name) | The name of the RAM share to create for the transit gateway. | `string` | `"tgw-hub-ram-share"` | no | +| [ram\_share\_principals](#input\_ram\_share\_principals) | The list of organizational units or accounts to share the transit gateway with. | `list(string)` | `[]` | no | ## Outputs -No outputs. +| Name | Description | +|------|-------------| +| [connectivity\_type](#output\_connectivity\_type) | The type of connectivity for the transit gateway. | +| [transit\_gateway\_id](#output\_transit\_gateway\_id) | The ID of the transit gateway. | diff --git a/examples/trusted/README.md b/examples/trusted/README.md index 3045937..87653cb 100644 --- a/examples/trusted/README.md +++ b/examples/trusted/README.md @@ -15,7 +15,7 @@ No providers. | Name | Source | Version | |------|--------|---------| -| [hub](#module\_hub) | ../../ | n/a | +| [hub\_trusted](#module\_hub\_trusted) | ../../ | n/a | ## Resources