Skip to content

Commit

Permalink
docs: Updated submodules and improved formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesiarmes committed Nov 14, 2024
1 parent 430c71c commit 739ff7b
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 60 deletions.
2 changes: 1 addition & 1 deletion aptible/managed_endpoint
2 changes: 1 addition & 1 deletion aws/backend
2 changes: 1 addition & 1 deletion aws/cloudfront_waf
Submodule cloudfront_waf updated 5 files
+1 −1 .cz.yaml
+35 −29 CHANGELOG.md
+43 −9 README.md
+9 −0 main.tf
+6 −0 variables.tf
9 changes: 5 additions & 4 deletions aws/fargate_service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,16 @@ existing secret. For example:

```hcl
environment_secrets = {
EXAMPLE_CLIENT_ID = "client:client_id"
EXAMPLE_CLIENT_ID = "client:client_id"
EXAMPLE_CLIENT_KEY = "arn:aws:secretsmanager:us-east-1:123456789012:secret:project/staging/client:key"
}
```

### secrets_manager_secrets

> _**Note:** This feature may be removed in a future version. It is recommended
> to use the [secrets] module to manage secrets instead._
> [!CAUTION]
> This feature may be removed in a future version. It is recommended to use the
> [secrets] module to manage secrets instead.
An optional map of secrets to be created in [AWS Secrets
Manager][secrets-manager]. Once the secret is created, any changes to the value
Expand All @@ -121,7 +122,7 @@ will be ignored. For example, to create a secret named `example`:
secrets_manager_secrets = {
example = {
recovery_window = 7
description = "Example credentials for our application."
description = "Example credentials for our application."
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion aws/logging
Submodule logging updated 2 files
+46 −0 CONTRIBUTING.md
+14 −9 README.md
47 changes: 24 additions & 23 deletions aws/secrets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ This module manages secrets in AWS through [Secrets Manager][secrets-manager].
It will create a KMS key for encrypting secrets, and optionally create one or
more secrets.

**Warning: OpenTofu state files are stored as plain text. For this reason it
is not recommended that you pass secret values to this module, unless you
expect them to be rotated _immediately_. It _is_ safe to use the
`create_random_password` option, as this value will be generated by AWS and not
stored in the state file.**
> [!CAUTION]
> OpenTofu state files are stored as plain text. For this reason it is not
> recommended that you pass secret values to this module, unless you expect them
> to be rotated _immediately_. It _is_ safe to use the `create_random_password`
> option, as this value will be generated by AWS and not stored in the state
> file.
## Usage

Expand All @@ -19,23 +20,23 @@ to match your desired configuration. For example:
module "secrets" {
source = "github.com/codeforamerica/tofu-modules/aws/secrets"
project = "my-project"
environment = "dev"
secrets = {
example = {
description = "An example secret."
}
"password/test" = {
create_random_password = true
description = "Random password for testing."
}
named = {
description = "A secret with an explicit name."
name = "my-project/named/secret"
}
project = "my-project"
environment = "dev"
secrets = {
example = {
description = "An example secret."
}
"password/test" = {
create_random_password = true
description = "Random password for testing."
}
named = {
description = "A secret with an explicit name."
name = "my-project/named/secret"
}
}
}
```

Make sure you re-run `tofu init` after adding the module to your configuration.
Expand Down Expand Up @@ -72,7 +73,7 @@ will be ignored. For example, to create a secret named `example`:
secrets = {
example = {
recovery_window = 7
description = "Example credentials for our application."
description = "Example credentials for our application."
}
}
```
Expand All @@ -89,8 +90,8 @@ for the secret:
secrets = {
example = {
recovery_window = 7
description = "Example credentials for our application."
name = "my/example/key"
description = "Example credentials for our application."
name = "my/example/key"
}
}
```
Expand Down
15 changes: 7 additions & 8 deletions aws/serverless_database/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ to match your desired configuration. For example:
module "database" {
source = "github.com/codeforamerica/tofu-modules/aws/serverless_database"
project = "my-project"
environment = "dev"
service = "web"
logging_key_arn = module.logging.kms_key_arn
secrets_key_arn = module.secrets.kms_key_arn
vpc_id = module.vpc.vpc_id
subnets = module.vpc.private_subnets
ingress_cidrs = module.vpc.private_subnets_cidr_blocks
vpc_id = module.vpc.vpc_id
subnets = module.vpc.private_subnets
ingress_cidrs = module.vpc.private_subnets_cidr_blocks
min_capacity = 2
max_capacity = 32
project = "my-project"
environment = "dev"
service = "web"
}
```

Expand Down Expand Up @@ -63,7 +63,6 @@ tofu init -upgrade
| snapshot_identifier | Optional name or ARN of the snapshot to restore the cluster from. Only applicable on create. | `bool` | `false` | no |
| tags | Optional tags to be applied to all resources. | `list` | `[]` | no |


## Outputs

| Name | Description | Type |
Expand Down
10 changes: 5 additions & 5 deletions aws/vpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ For example:

```hcl
peers = {
"aptible": {
account_id: "123456789012",
vpc_id: "vpc-012ab34cde5678fa9",
region: "us-east-1",
cidr: "10.123.0.0/16"
aptible = {
account_id = "123456789012",
vpc_id = "vpc-012ab34cde5678fa9",
region = "us-east-1",
cidr = "10.123.0.0/16"
}
}
```
Expand Down
32 changes: 16 additions & 16 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ markdown_extensions:
theme:
name: material
icon:
logo: material/puzzle
logo: simple/opentofu
palette:
scheme: slate
features:
Expand Down Expand Up @@ -63,22 +63,22 @@ extra:
nav:
- Home: index.md
- Architecture:
Overview: architecture/architecture.md
Create a New Module: architecture/create.md
GitHub Actions: architecture/github-actions.md
- Overview: architecture/architecture.md
- Create a New Module: architecture/create.md
- GitHub Actions: architecture/github-actions.md
- Modules:
Aptible:
Managed Endpoint: modules/aptible/managed-endpoint.md
AWS:
Backend: modules/aws/backend.md
CloudFront WAF: modules/aws/cloudfront-waf.md
Fargate Service: modules/aws/fargate-service.md
Logging: modules/aws/logging.md
Secrets: modules/aws/secrets.md
Serverless Database: modules/aws/serverless-database.md
VPC: modules/aws/vpc.md
- Aptible:
- Managed Endpoint: modules/aptible/managed-endpoint.md
- AWS:
- Backend: modules/aws/backend.md
- CloudFront WAF: modules/aws/cloudfront-waf.md
- Fargate Service: modules/aws/fargate-service.md
- Logging: modules/aws/logging.md
- Secrets: modules/aws/secrets.md
- Serverless Database: modules/aws/serverless-database.md
- VPC: modules/aws/vpc.md
- About:
Contributing: contributing.md
License: license.md
- Contributing: contributing.md
- License: license.md

copyright: Produced by Code for America under the MIT license.

0 comments on commit 739ff7b

Please sign in to comment.