Skip to content

Commit

Permalink
docs: update Terraform docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 11, 2024
1 parent ee4fe43 commit b30d2f5
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 33 deletions.
21 changes: 11 additions & 10 deletions infra/terraform/modules/account/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<!-- BEGIN_TF_DOCS -->

## Requirements

No requirements.
Expand All @@ -10,24 +9,26 @@ No providers.

## Modules

| Name | Source | Version |
| ----------------------------------------------------- | -------------------- | ------- |
| <a name="module_github"></a> [github](#module_github) | ../../modules/github | n/a |
| Name | Source | Version |
|------|--------|---------|
| <a name="module_ecr"></a> [ecr](#module\_ecr) | terraform-aws-modules/ecr/aws | ~> 1.6 |
| <a name="module_github"></a> [github](#module\_github) | ../../modules/github | n/a |

## Resources

No resources.

## Inputs

| Name | Description | Type | Default | Required |
| --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------- | ------- | :------: |
| <a name="input_create_github_resources"></a> [create_github_resources](#input_create_github_resources) | Whether to create the GitHub resources. | `bool` | `true` | no |
| <a name="input_github_oidc_readonly_role_policies"></a> [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 |
| <a name="input_github_oidc_role_policies"></a> [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 |
|------|-------------|------|---------|:--------:|
| <a name="input_create_github_resources"></a> [create\_github\_resources](#input\_create\_github\_resources) | Whether to create the GitHub resources. | `bool` | `true` | no |
| <a name="input_ecr_read_access_arns"></a> [ecr\_read\_access\_arns](#input\_ecr\_read\_access\_arns) | The list of ARNs to attach to the ECR read role. | `list(string)` | `[]` | no |
| <a name="input_ecr_read_write_access_arns"></a> [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 |
| <a name="input_github_oidc_readonly_role_policies"></a> [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 |
| <a name="input_github_oidc_role_policies"></a> [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.

<!-- END_TF_DOCS -->
44 changes: 21 additions & 23 deletions infra/terraform/modules/github/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,42 @@
<!-- BEGIN_TF_DOCS -->

## Requirements

| Name | Version |
| ------------------------------------------------------------------------ | -------- |
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 1.0 |
| <a name="requirement_aws"></a> [aws](#requirement_aws) | >= 5.0.0 |
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0.0 |

## Providers

No providers.

## Modules

| Name | Source | Version |
| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- |
| <a name="module_iam_github_oidc_provider"></a> [iam_github_oidc_provider](#module_iam_github_oidc_provider) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-provider | ~> 5.24 |
| <a name="module_iam_github_oidc_readonly_role"></a> [iam_github_oidc_readonly_role](#module_iam_github_oidc_readonly_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 |
| <a name="module_iam_github_oidc_role"></a> [iam_github_oidc_role](#module_iam_github_oidc_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 |
| Name | Source | Version |
|------|--------|---------|
| <a name="module_iam_github_oidc_provider"></a> [iam\_github\_oidc\_provider](#module\_iam\_github\_oidc\_provider) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-provider | ~> 5.24 |
| <a name="module_iam_github_oidc_readonly_role"></a> [iam\_github\_oidc\_readonly\_role](#module\_iam\_github\_oidc\_readonly\_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 |
| <a name="module_iam_github_oidc_role"></a> [iam\_github\_oidc\_role](#module\_iam\_github\_oidc\_role) | terraform-aws-modules/iam/aws//modules/iam-github-oidc-role | ~> 5.24 |

## Resources

No resources.

## Inputs

| Name | Description | Type | Default | Required |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -------------- | ------- | :------: |
| <a name="input_create_oidc_provider"></a> [create_oidc_provider](#input_create_oidc_provider) | Whether to create an OIDC provider. | `bool` | `true` | no |
| <a name="input_create_oidc_readonly_role"></a> [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 |
| <a name="input_create_oidc_role"></a> [create_oidc_role](#input_create_oidc_role) | Whether to create an OIDC role. | `bool` | `true` | no |
| <a name="input_oidc_readonly_role_policies"></a> [oidc_readonly_role_policies](#input_oidc_readonly_role_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no |
| <a name="input_oidc_role_permissions_boundary_arn"></a> [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 |
| <a name="input_oidc_role_policies"></a> [oidc_role_policies](#input_oidc_role_policies) | The map of policies to attach to the OIDC role. | `map(string)` | `{}` | no |
| <a name="input_repositories"></a> [repositories](#input_repositories) | The list of repositories to add to the OIDC role. | `list(string)` | n/a | yes |
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_create_oidc_provider"></a> [create\_oidc\_provider](#input\_create\_oidc\_provider) | Whether to create an OIDC provider. | `bool` | `true` | no |
| <a name="input_create_oidc_readonly_role"></a> [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 |
| <a name="input_create_oidc_role"></a> [create\_oidc\_role](#input\_create\_oidc\_role) | Whether to create an OIDC role. | `bool` | `true` | no |
| <a name="input_oidc_readonly_role_policies"></a> [oidc\_readonly\_role\_policies](#input\_oidc\_readonly\_role\_policies) | The map of policies to attach to the OIDC readonly role. | `map(string)` | `{}` | no |
| <a name="input_oidc_role_permissions_boundary_arn"></a> [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 |
| <a name="input_oidc_role_policies"></a> [oidc\_role\_policies](#input\_oidc\_role\_policies) | The map of policies to attach to the OIDC role. | `map(string)` | `{}` | no |
| <a name="input_repositories"></a> [repositories](#input\_repositories) | The list of repositories to add to the OIDC role. | `list(string)` | n/a | yes |

## Outputs

| Name | Description |
| -------------------------------------------------------------------------- | ------------------------------- |
| <a name="output_oidc_role_arn"></a> [oidc_role_arn](#output_oidc_role_arn) | The ARN of the GitHub OIDC role |

| Name | Description |
|------|-------------|
| <a name="output_oidc_role_arn"></a> [oidc\_role\_arn](#output\_oidc\_role\_arn) | The ARN of the GitHub OIDC role |
<!-- END_TF_DOCS -->

0 comments on commit b30d2f5

Please sign in to comment.