https://github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2
https://github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2
aws collection terraform
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2
- Owner: launchbynttdata
- License: apache-2.0
- Created: 2024-04-19T16:31:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T17:15:52.000Z (almost 2 years ago)
- Last Synced: 2025-01-03T10:46:08.995Z (over 1 year ago)
- Topics: aws, collection, terraform
- Language: HCL
- Size: 151 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# tf-aws-module_collection-api_gateway_v2
[](https://opensource.org/licenses/Apache-2.0)
[](https://creativecommons.org/licenses/by-nc-nd/4.0/)
## Overview
Provides a full API Gateway collection, comprised of:
- An API Gateway
- One or more Stages
- One or more Routes
- One or more Integrations
Routes and Integrations use a common identifier (referred to internally as an `alias`) to allow for routes to be tied to an integration dynamically.
Passing a Route without a `target` attribute will pull the `api_gateway_integration_id` out of the Integration with a matching `alias` and apply it to the route. Consider the following inputs:
```hcl
routes = {
one = {
route_key = "GET /route_one"
},
two = {
route_key = "GET /route_two"
}
...
}
integrations = {
one = {
integration_type = "HTTP_PROXY"
integration_uri = "https://some-other-service.example.com/v1/proxied_route_one"
},
two = {
integration_type = "AWS_PROXY"
integration_uri = "
}
...
}
```
This module will create `route[one].target` and `route[two].target` values that will be fed into the Route after the matching Integration is created. The expected outcome is that accessing /route_one on the API Gateway results in your traffic being proxied to some-other-service.example.com, and accessing /route_two will call a Lambda function.
## Pre-Commit hooks
[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.
`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:
- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- **chore**: a commit of the type `chore` adds changes that don't modify src or test files
- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- **docs**: a commit of the type `docs` adds documentation only changes
- **perf**: a commit of the type `perf` adds code change that improves performance
- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature
- **revert**: a commit of the type `revert` reverts a previous commit
- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **test**: a commit of the type `test` adds missing tests or correcting existing tests
Base configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)
If you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.
`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS
In order for `pre-commit` hooks to work properly
- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.
- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below
```
pre-commit install --hook-type commit-msg
```
## To test the resource group module locally
1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.
```
make configure
```
This adds in several files and directories that are ignored by `git`. They expose many new Make targets.
2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.
`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.
These environment variables are used by `terratest` integration suit.
Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.
```
"Microsoft.Resources/subscriptions/resourceGroups/write"
"Microsoft.Resources/subscriptions/resourceGroups/read"
"Microsoft.Resources/subscriptions/resourceGroups/delete"
```
Then run this make target to set the environment variables on developer workstation.
```
make env
```
3. The first target you care about is `check`.
**Pre-requisites**
Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.
- A file named `provider.tf` with contents below
```
provider "azurerm" {
features {}
}
```
- A file named `terraform.tfvars` which contains key value pair of variables used.
Note that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.
After creating these files, for running tests associated with the primitive/segment, run
```
make check
```
If `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.
`make check` target
- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.
- runs `conftests`. `conftests` make sure `policy` checks are successful.
- runs `terratest`. This is integration test suit.
- runs `opa` tests
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | ~> 1.5 |
| [aws](#requirement\_aws) | ~> 5.0 |
## Providers
No providers.
## Modules
| Name | Source | Version |
|------|--------|---------|
| [api\_gateway](#module\_api\_gateway) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2/aws | ~> 1.0 |
| [api\_gateway\_route](#module\_api\_gateway\_route) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2_route/aws | ~> 1.0 |
| [api\_gateway\_integration](#module\_api\_gateway\_integration) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2_integration/aws | ~> 1.0 |
| [api\_gateway\_stage](#module\_api\_gateway\_stage) | terraform.registry.launch.nttdata.com/module_collection/api_gateway_v2_stage/aws | ~> 1.0 |
## Resources
No resources.
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [name](#input\_name) | Name of the API Gateway | `string` | n/a | yes |
| [routes](#input\_routes) | Map of routes to create in the API Gateway. |
map(object({
route_key = string
target = string
})) | n/a | yes |
| [integrations](#input\_integrations) | Map of integrations to create in the API Gateway. | map(object({
integration_type = string
connection_id = optional(string, null)
connection_type = optional(string, null)
content_handling_strategy = optional(string, null)
credentials_arn = optional(string, null)
description = optional(string, null)
integration_method = optional(string, null)
integration_subtype = optional(string, null)
integration_uri = optional(string, null)
passthrough_behavior = optional(string, "WHEN_NO_MATCH")
payload_format_version = optional(string, "2.0")
request_parameters = optional(map(string), {})
request_templates = optional(map(string), {})
response_parameters = optional(list(object({
status_code = number
mappings = map(string)
})), [])
template_selection_expression = optional(string, null)
timeout_milliseconds = optional(number, null)
server_name_to_verify = optional(string, null)
})) | n/a | yes |
| [stages](#input\_stages) | Map of stages to create in the API Gateway | map(object({
name = optional(string, null)
description = optional(string, null)
deployment_id = optional(string, null)
auto_deploy = optional(bool, null)
log_group_arn = optional(string, null)
log_group_retention_days = optional(number, 30)
log_group_skip_destroy = optional(bool, false)
access_log_format = optional(string, null)
})) | n/a | yes |
| [tags](#input\_tags) | Map of tags to assign to the API. | `map(string)` | `null` | no |
## Outputs
| Name | Description |
|------|-------------|
| [api\_gateway\_id](#output\_api\_gateway\_id) | n/a |
| [api\_gateway\_endpoint](#output\_api\_gateway\_endpoint) | n/a |
| [api\_gateway\_routes](#output\_api\_gateway\_routes) | n/a |
| [api\_gateway\_integrations](#output\_api\_gateway\_integrations) | n/a |
| [api\_gateway\_stages](#output\_api\_gateway\_stages) | n/a |