Update README and CHANGELOG ahead of release.

Author: tobyclemson

CHANGELOG.md

@@ -1,12 +1,9 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+## Unreleased
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## 1.0.0 (December 28th, 2022)
 
-## [Unreleased]
+IMPROVEMENTS
 
-### Added
-- 
-
-[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/HEAD
+* Configuration to manage a private integration has been added including an 
+  API Gateway integration, a set of API Gateway routes and optionally, a VPC 
+  link.

README.md

@@ -2,7 +2,7 @@ data "aws_availability_zones" "zones" {}
 
 module "base_networking" {
   source  = "infrablocks/base-networking/aws"
-  version = "4.0.0"
+  version = "5.0.0"
 
   region             = var.region
   availability_zones = data.aws_availability_zones.zones.names
@@ -18,7 +18,7 @@ module "base_networking" {
 
 module "api_gateway" {
   source  = "infrablocks/api-gateway-v2/aws"
-  version = "1.0.0-rc.3"
+  version = "1.0.0"
 
   component             = var.component
   deployment_identifier = var.deployment_identifier
@@ -33,7 +33,7 @@ module "api_gateway" {
 
 module "application_load_balancer" {
   source  = "infrablocks/application-load-balancer/aws"
-  version = "3.1.0-rc.8"
+  version = "4.0.0"
 
   region     = var.region
   vpc_id     = module.base_networking.vpc_id

examples/basic/prerequisites.tf

@@ -1,15 +1,19 @@
 output "integration_id" {
-  value = aws_apigatewayv2_integration.integration.id
+  description = "The ID of the managed private integration."
+  value       = aws_apigatewayv2_integration.integration.id
 }
 
 output "vpc_link_id" {
-  value = try(module.api_gateway_vpc_link[0].vpc_link_id, var.vpc_link_id)
+  description = "Either the ID of the managed VPC link, if included, otherwise the provided VPC link ID."
+  value       = try(module.api_gateway_vpc_link[0].vpc_link_id, var.vpc_link_id)
 }
 
 output "vpc_link_default_security_group_id" {
-  value = try(module.api_gateway_vpc_link[0].vpc_link_default_security_group_id, "")
+  description = "The ID of the default security group created for the managed VPC link.This is an empty string if the security group is not included."
+  value       = try(module.api_gateway_vpc_link[0].vpc_link_default_security_group_id, "")
 }
 
 output "routes" {
-  value = {for route in local.routes: route.route_key => aws_apigatewayv2_route.route[route.route_key].id }
+  description = "A map of the routes added to the private integration."
+  value       = {for route in local.routes : route.route_key => aws_apigatewayv2_route.route[route.route_key].id}
 }

outputs.tf

@@ -8,7 +8,10 @@
   end
 
   after(:context) do
-    destroy(role: :basic)
+    destroy(
+      role: :basic,
+      only_if: -> { !ENV['FORCE_DESTROY'].nil? || ENV['SEED'].nil? }
+    )
   end
 
   describe 'integration' do

spec/integration/basic_spec.rb

@@ -25,7 +25,9 @@
   config.terraform_configuration_provider =
     RSpec::Terraform::Configuration.chain_provider(
       providers: [
-        RSpec::Terraform::Configuration.seed_provider,
+        RSpec::Terraform::Configuration.seed_provider(
+          generator: -> { SecureRandom.hex[0, 8] }
+        ),
         RSpec::Terraform::Configuration.in_memory_provider(
           no_color: true
         ),

spec/integration/spec_helper.rb

@@ -2,7 +2,7 @@ data "aws_availability_zones" "zones" {}
 
 module "base_networking" {
   source  = "infrablocks/base-networking/aws"
-  version = "4.0.0"
+  version = "5.0.0"
 
   region             = var.region
   availability_zones = data.aws_availability_zones.zones.names
@@ -18,7 +18,7 @@ module "base_networking" {
 
 module "api_gateway" {
   source  = "infrablocks/api-gateway-v2/aws"
-  version = "1.0.0-rc.3"
+  version = "1.0.0"
 
   component             = var.component
   deployment_identifier = var.deployment_identifier
@@ -33,7 +33,7 @@ module "api_gateway" {
 
 module "application_load_balancer" {
   source  = "infrablocks/application-load-balancer/aws"
-  version = "3.1.0-rc.8"
+  version = "4.0.0"
 
   region     = var.region
   vpc_id     = module.base_networking.vpc_id

spec/unit/infra/prerequisites/main.tf

@@ -32,7 +32,9 @@
   config.terraform_configuration_provider =
     RSpec::Terraform::Configuration.chain_provider(
       providers: [
-        RSpec::Terraform::Configuration.seed_provider,
+        RSpec::Terraform::Configuration.seed_provider(
+          generator: -> { SecureRandom.hex[0, 8] }
+        ),
         RSpec::Terraform::Configuration.in_memory_provider(
           no_color: true
         ),
@@ -55,7 +57,7 @@
   config.after(:suite) do
     destroy(
       role: :prerequisites,
-      only_if: -> { ENV['SEED'].nil? }
+      only_if: -> { !ENV['FORCE_DESTROY'].nil? || ENV['SEED'].nil? }
     )
   end
 end

spec/unit/spec_helper.rb

@@ -3,35 +3,36 @@ variable "component" {
   type        = string
 }
 variable "deployment_identifier" {
-  type        = string
   description = "An identifier for this instantiation."
+  type        = string
 }
 
 variable "api_id" {
-  type        = string
   description = "The ID of the API gateway API for which to create the integration."
+  type        = string
 }
 variable "integration_uri" {
-  type        = string
   description = "The integration URI to use for the private integration, typically the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service."
+  type        = string
 }
 variable "tls_server_name_to_verify" {
-  type        = string
   description = "The server name of the target to verify for TLS communication. Only required when `use_tls` is `true`."
+  type        = string
   default     = null
 }
 
 variable "routes" {
+  description = "The routes to configure for this private integration. Required when `include_routes` is `true`. Defaults to a single route with key \"ANY /{proxy+}\"."
   type        = list(object({
     route_key: string
   }))
-  description = "The routes to configure for this private integration. Required when `include_routes` is `true`. Defaults to a single route with key \"ANY /{proxy+}\"."
   default     = [{
     route_key: "ANY /{proxy+}"
   }]
 }
 
 variable "request_parameters" {
+  description = "The request parameters to configure for this private integration."
   type = list(object({
     parameter: string,
     type: string,
@@ -42,66 +43,66 @@ variable "request_parameters" {
 
 # Needs tests
 variable "vpc_id" {
-  type        = string
   description = "The ID of the VPC in which to create the VPC link for this private integration. Required when `include_vpc_link` and `include_vpc_link_default_security_group` are both `true`."
+  type        = string
   default     = null
 }
 variable "vpc_link_id" {
-  type        = string
   description = "The ID of a VPC link to use when creating the private integration. Only required if `include_vpc_link` is `false`."
+  type        = string
   default     = null
 }
 variable "vpc_link_subnet_ids" {
-  type        = list(string)
   description = "The subnet IDs in which to create the VPC link for this private integration. Required when `include_vpc_link` is `true`."
+  type        = list(string)
   default     = []
 }
 # Needs tests
 variable "vpc_link_default_ingress_cidrs" {
-  type        = list(string)
   description = "The CIDRs allowed access to the VPC via the VPC link when using the default ingress rule."
+  type        = list(string)
   default     = ["0.0.0.0/0"]
 }
 # Needs tests
 variable "vpc_link_default_egress_cidrs" {
-  type        = list(string)
   description = "The CIDRs accessible within the VPC via the VPC link when using the default egress rule."
+  type        = list(string)
   default     = ["0.0.0.0/0"]
 }
 
 variable "tags" {
-  type        = map(string)
   description = "Additional tags to set on created resources."
+  type        = map(string)
   default     = {}
 }
 
 variable "include_default_tags" {
-  type        = bool
   description = "Whether or not to include default tags on created resources. Defaults to `true`."
+  type        = bool
   default     = true
 }
 variable "include_vpc_link" {
-  type        = bool
   description = "Whether or not to create a VPC link for the private integration. Defaults to `true`."
+  type        = bool
   default     = true
 }
 variable "include_vpc_link_default_security_group" {
-  type        = bool
   description = "Whether or not to create a default security group for the VPC link for the private integration. Defaults to `true`."
+  type        = bool
   default     = true
 }
 variable "include_vpc_link_default_ingress_rule" {
-  type        = bool
   description = "Whether or not to create the default ingress rule on the security group created for the VPC link. Defaults to `true`."
+  type        = bool
   default     = true
 }
 variable "include_vpc_link_default_egress_rule" {
-  type        = bool
   description = "Whether or not to create the default egress rule on the security group created for the VPC link. Defaults to `true`."
+  type        = bool
   default     = true
 }
 variable "use_tls" {
-  type        = bool
   description = "Whether or not to use TLS when communicating with the target of this integration. Defaults to `true`."
+  type        = bool
   default     = true
 }