From b30d2f5ba49fb947062ac8b5b00ba89aa7382517 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 11 Mar 2024 17:39:11 +0000 Subject: [PATCH] docs: update Terraform docs --- infra/terraform/modules/account/README.md | 21 +++++------ infra/terraform/modules/github/README.md | 44 +++++++++++------------ 2 files changed, 32 insertions(+), 33 deletions(-) diff --git a/infra/terraform/modules/account/README.md b/infra/terraform/modules/account/README.md index eda12b7682..20b3a89b3a 100644 --- a/infra/terraform/modules/account/README.md +++ b/infra/terraform/modules/account/README.md @@ -1,5 +1,4 @@ - ## Requirements No requirements. @@ -10,9 +9,10 @@ No providers. ## Modules -| Name | Source | Version | -| ----------------------------------------------------- | -------------------- | ------- | -| [github](#module_github) | ../../modules/github | n/a | +| Name | Source | Version | +|------|--------|---------| +| [ecr](#module\_ecr) | terraform-aws-modules/ecr/aws | ~> 1.6 | +| [github](#module\_github) | ../../modules/github | n/a | ## Resources @@ -20,14 +20,15 @@ No resources. ## Inputs -| Name | Description | Type | Default | Required | -| --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------- | ------- | :------: | -| [create_github_resources](#input_create_github_resources) | Whether to create the GitHub resources. | `bool` | `true` | no | -| [github_oidc_readonly_role_policies](#input_github_oidc_readonly_role_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no | -| [github_oidc_role_policies](#input_github_oidc_role_policies) | A map of policy names to policy ARNs to attach to the OIDC role. | `map(string)` | `{}` | no | +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [create\_github\_resources](#input\_create\_github\_resources) | Whether to create the GitHub resources. | `bool` | `true` | no | +| [ecr\_read\_access\_arns](#input\_ecr\_read\_access\_arns) | The list of ARNs to attach to the ECR read role. | `list(string)` | `[]` | no | +| [ecr\_read\_write\_access\_arns](#input\_ecr\_read\_write\_access\_arns) | The list of ARNs to attach to the ECR read-write role. | `list(string)` | `[]` | no | +| [github\_oidc\_readonly\_role\_policies](#input\_github\_oidc\_readonly\_role\_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no | +| [github\_oidc\_role\_policies](#input\_github\_oidc\_role\_policies) | A map of policy names to policy ARNs to attach to the OIDC role. | `map(string)` | `{}` | no | ## Outputs No outputs. - diff --git a/infra/terraform/modules/github/README.md b/infra/terraform/modules/github/README.md index 16eed40832..e5e47c0ec5 100644 --- a/infra/terraform/modules/github/README.md +++ b/infra/terraform/modules/github/README.md @@ -1,11 +1,10 @@ - ## Requirements -| Name | Version | -| ------------------------------------------------------------------------ | -------- | -| [terraform](#requirement_terraform) | >= 1.0 | -| [aws](#requirement_aws) | >= 5.0.0 | +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.0 | +| [aws](#requirement\_aws) | >= 5.0.0 | ## Providers @@ -13,11 +12,11 @@ No providers. ## Modules -| Name | Source | Version | -| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | -| [iam_github_oidc_provider](#module_iam_github_oidc_provider) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-provider | ~> 5.24 | -| [iam_github_oidc_readonly_role](#module_iam_github_oidc_readonly_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 | -| [iam_github_oidc_role](#module_iam_github_oidc_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 | +| Name | Source | Version | +|------|--------|---------| +| [iam\_github\_oidc\_provider](#module\_iam\_github\_oidc\_provider) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-provider | ~> 5.24 | +| [iam\_github\_oidc\_readonly\_role](#module\_iam\_github\_oidc\_readonly\_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 | +| [iam\_github\_oidc\_role](#module\_iam\_github\_oidc\_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 | ## Resources @@ -25,20 +24,19 @@ No resources. ## Inputs -| Name | Description | Type | Default | Required | -| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -------------- | ------- | :------: | -| [create_oidc_provider](#input_create_oidc_provider) | Whether to create an OIDC provider. | `bool` | `true` | no | -| [create_oidc_readonly_role](#input_create_oidc_readonly_role) | Whether to create a readonly OIDC role. This is useful for pull requests. | `bool` | `true` | no | -| [create_oidc_role](#input_create_oidc_role) | Whether to create an OIDC role. | `bool` | `true` | no | -| [oidc_readonly_role_policies](#input_oidc_readonly_role_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no | -| [oidc_role_permissions_boundary_arn](#input_oidc_role_permissions_boundary_arn) | The ARN of the permissions boundary to use for the role. | `string` | `null` | no | -| [oidc_role_policies](#input_oidc_role_policies) | The map of policies to attach to the OIDC role. | `map(string)` | `{}` | no | -| [repositories](#input_repositories) | The list of repositories to add to the OIDC role. | `list(string)` | n/a | yes | +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [create\_oidc\_provider](#input\_create\_oidc\_provider) | Whether to create an OIDC provider. | `bool` | `true` | no | +| [create\_oidc\_readonly\_role](#input\_create\_oidc\_readonly\_role) | Whether to create a readonly OIDC role. This is useful for pull requests. | `bool` | `true` | no | +| [create\_oidc\_role](#input\_create\_oidc\_role) | Whether to create an OIDC role. | `bool` | `true` | no | +| [oidc\_readonly\_role\_policies](#input\_oidc\_readonly\_role\_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no | +| [oidc\_role\_permissions\_boundary\_arn](#input\_oidc\_role\_permissions\_boundary\_arn) | The ARN of the permissions boundary to use for the role. | `string` | `null` | no | +| [oidc\_role\_policies](#input\_oidc\_role\_policies) | The map of policies to attach to the OIDC role. | `map(string)` | `{}` | no | +| [repositories](#input\_repositories) | The list of repositories to add to the OIDC role. | `list(string)` | n/a | yes | ## Outputs -| Name | Description | -| -------------------------------------------------------------------------- | ------------------------------- | -| [oidc_role_arn](#output_oidc_role_arn) | The ARN of the GitHub OIDC role | - +| Name | Description | +|------|-------------| +| [oidc\_role\_arn](#output\_oidc\_role\_arn) | The ARN of the GitHub OIDC role |