Skip to content

Commit 739ff7b

Browse files
committed
docs: Updated submodules and improved formatting.
1 parent 430c71c commit 739ff7b

File tree

9 files changed

+61
-60
lines changed

9 files changed

+61
-60
lines changed

aws/fargate_service/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,16 @@ existing secret. For example:
103103

104104
```hcl
105105
environment_secrets = {
106-
EXAMPLE_CLIENT_ID = "client:client_id"
106+
EXAMPLE_CLIENT_ID = "client:client_id"
107107
EXAMPLE_CLIENT_KEY = "arn:aws:secretsmanager:us-east-1:123456789012:secret:project/staging/client:key"
108108
}
109109
```
110110

111111
### secrets_manager_secrets
112112

113-
> _**Note:** This feature may be removed in a future version. It is recommended
114-
> to use the [secrets] module to manage secrets instead._
113+
> [!CAUTION]
114+
> This feature may be removed in a future version. It is recommended to use the
115+
> [secrets] module to manage secrets instead.
115116
116117
An optional map of secrets to be created in [AWS Secrets
117118
Manager][secrets-manager]. Once the secret is created, any changes to the value
@@ -121,7 +122,7 @@ will be ignored. For example, to create a secret named `example`:
121122
secrets_manager_secrets = {
122123
example = {
123124
recovery_window = 7
124-
description = "Example credentials for our application."
125+
description = "Example credentials for our application."
125126
}
126127
}
127128
```

aws/logging

aws/secrets/README.md

+24-23
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ This module manages secrets in AWS through [Secrets Manager][secrets-manager].
44
It will create a KMS key for encrypting secrets, and optionally create one or
55
more secrets.
66

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

@@ -19,23 +20,23 @@ to match your desired configuration. For example:
1920
module "secrets" {
2021
source = "github.com/codeforamerica/tofu-modules/aws/secrets"
2122
22-
project = "my-project"
23-
environment = "dev"
24-
25-
secrets = {
26-
example = {
27-
description = "An example secret."
28-
}
29-
"password/test" = {
30-
create_random_password = true
31-
description = "Random password for testing."
32-
}
33-
named = {
34-
description = "A secret with an explicit name."
35-
name = "my-project/named/secret"
36-
}
23+
project = "my-project"
24+
environment = "dev"
25+
26+
secrets = {
27+
example = {
28+
description = "An example secret."
29+
}
30+
"password/test" = {
31+
create_random_password = true
32+
description = "Random password for testing."
33+
}
34+
named = {
35+
description = "A secret with an explicit name."
36+
name = "my-project/named/secret"
3737
}
3838
}
39+
}
3940
```
4041

4142
Make sure you re-run `tofu init` after adding the module to your configuration.
@@ -72,7 +73,7 @@ will be ignored. For example, to create a secret named `example`:
7273
secrets = {
7374
example = {
7475
recovery_window = 7
75-
description = "Example credentials for our application."
76+
description = "Example credentials for our application."
7677
}
7778
}
7879
```
@@ -89,8 +90,8 @@ for the secret:
8990
secrets = {
9091
example = {
9192
recovery_window = 7
92-
description = "Example credentials for our application."
93-
name = "my/example/key"
93+
description = "Example credentials for our application."
94+
name = "my/example/key"
9495
}
9596
}
9697
```

aws/serverless_database/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ to match your desired configuration. For example:
1414
module "database" {
1515
source = "github.com/codeforamerica/tofu-modules/aws/serverless_database"
1616
17+
project = "my-project"
18+
environment = "dev"
19+
service = "web"
20+
1721
logging_key_arn = module.logging.kms_key_arn
1822
secrets_key_arn = module.secrets.kms_key_arn
19-
vpc_id = module.vpc.vpc_id
20-
subnets = module.vpc.private_subnets
21-
ingress_cidrs = module.vpc.private_subnets_cidr_blocks
23+
vpc_id = module.vpc.vpc_id
24+
subnets = module.vpc.private_subnets
25+
ingress_cidrs = module.vpc.private_subnets_cidr_blocks
2226
2327
min_capacity = 2
2428
max_capacity = 32
25-
26-
project = "my-project"
27-
environment = "dev"
28-
service = "web"
2929
}
3030
```
3131

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

66-
6766
## Outputs
6867

6968
| Name | Description | Type |

aws/vpc/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ For example:
4848

4949
```hcl
5050
peers = {
51-
"aptible": {
52-
account_id: "123456789012",
53-
vpc_id: "vpc-012ab34cde5678fa9",
54-
region: "us-east-1",
55-
cidr: "10.123.0.0/16"
51+
aptible = {
52+
account_id = "123456789012",
53+
vpc_id = "vpc-012ab34cde5678fa9",
54+
region = "us-east-1",
55+
cidr = "10.123.0.0/16"
5656
}
5757
}
5858
```

mkdocs.yaml

+16-16
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ markdown_extensions:
3030
theme:
3131
name: material
3232
icon:
33-
logo: material/puzzle
33+
logo: simple/opentofu
3434
palette:
3535
scheme: slate
3636
features:
@@ -63,22 +63,22 @@ extra:
6363
nav:
6464
- Home: index.md
6565
- Architecture:
66-
Overview: architecture/architecture.md
67-
Create a New Module: architecture/create.md
68-
GitHub Actions: architecture/github-actions.md
66+
- Overview: architecture/architecture.md
67+
- Create a New Module: architecture/create.md
68+
- GitHub Actions: architecture/github-actions.md
6969
- Modules:
70-
Aptible:
71-
Managed Endpoint: modules/aptible/managed-endpoint.md
72-
AWS:
73-
Backend: modules/aws/backend.md
74-
CloudFront WAF: modules/aws/cloudfront-waf.md
75-
Fargate Service: modules/aws/fargate-service.md
76-
Logging: modules/aws/logging.md
77-
Secrets: modules/aws/secrets.md
78-
Serverless Database: modules/aws/serverless-database.md
79-
VPC: modules/aws/vpc.md
70+
- Aptible:
71+
- Managed Endpoint: modules/aptible/managed-endpoint.md
72+
- AWS:
73+
- Backend: modules/aws/backend.md
74+
- CloudFront WAF: modules/aws/cloudfront-waf.md
75+
- Fargate Service: modules/aws/fargate-service.md
76+
- Logging: modules/aws/logging.md
77+
- Secrets: modules/aws/secrets.md
78+
- Serverless Database: modules/aws/serverless-database.md
79+
- VPC: modules/aws/vpc.md
8080
- About:
81-
Contributing: contributing.md
82-
License: license.md
81+
- Contributing: contributing.md
82+
- License: license.md
8383

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

0 commit comments

Comments
 (0)