Skip to content

Commit df20951

Browse files
authored
feat: prettier in READMEs (cloudposse/terraform-aws-components#998)
1 parent 2dc35b2 commit df20951

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

src/CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Components PR [[eks/external-secrets-operator] Set default chart](https://github.com/cloudposse/terraform-aws-components/pull/856)
22

3-
This is a bug fix and feature enhancement update.
4-
No actions necessary to upgrade.
3+
This is a bug fix and feature enhancement update. No actions necessary to upgrade.
54

65
## Fixes
7-
* Set default chart
6+
7+
- Set default chart

src/README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Component: `external-secrets-operator`
22

3-
This component (ESO) is used to create an external `SecretStore` configured to synchronize secrets from AWS SSM Parameter store as Kubernetes Secrets within the cluster. Per the operator pattern, the `external-secret-operator` pods will watch for any `ExternalSecret` resources which reference the `SecretStore` to pull secrets from.
3+
This component (ESO) is used to create an external `SecretStore` configured to synchronize secrets from AWS SSM
4+
Parameter store as Kubernetes Secrets within the cluster. Per the operator pattern, the `external-secret-operator` pods
5+
will watch for any `ExternalSecret` resources which reference the `SecretStore` to pull secrets from.
46

5-
In practice, this means apps will define an `ExternalSecret` that pulls all env into a single secret as part of a helm chart; e.g.:
7+
In practice, this means apps will define an `ExternalSecret` that pulls all env into a single secret as part of a helm
8+
chart; e.g.:
69

710
```
811
# Part of the charts in `/releases
@@ -29,15 +32,15 @@ spec:
2932
target: "$1"
3033
```
3134

32-
This component assumes secrets are prefixed by "service" in parameter store (e.g. `/app/my_secret`). The `SecretStore`. The component is designed to pull secrets from a `path` prefix (defaulting to `"app"`). This should work nicely along `chamber` which uses this same path (called a "service" in Chamber). For example, developers should store keys like so.
33-
35+
This component assumes secrets are prefixed by "service" in parameter store (e.g. `/app/my_secret`). The `SecretStore`.
36+
The component is designed to pull secrets from a `path` prefix (defaulting to `"app"`). This should work nicely along
37+
`chamber` which uses this same path (called a "service" in Chamber). For example, developers should store keys like so.
3438

3539
```bash
3640
assume-role acme-platform-gbl-sandbox-admin
3741
chamber write app MY_KEY my-value
3842
```
3943

40-
4144
See `docs/recipies.md` for more information on managing secrets.
4245

4346
## Usage
@@ -88,6 +91,7 @@ components:
8891
chart_values: {}
8992
```
9093
94+
<!-- prettier-ignore-start -->
9195
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
9296
## Requirements
9397
@@ -181,8 +185,10 @@ components:
181185
|------|-------------|
182186
| <a name="output_metadata"></a> [metadata](#output\_metadata) | Block status of the deployed release |
183187
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
188+
<!-- prettier-ignore-end -->
184189

185190
## References
186-
* [Secrets Management Strategy](https://docs.cloudposse.com/reference-architecture/design-decisions/cold-start/decide-on-secrets-management-strategy-for-terraform/)
187-
* https://external-secrets.io/v0.5.9/
188-
* https://external-secrets.io/v0.5.9/provider-aws-parameter-store/
191+
192+
- [Secrets Management Strategy](https://docs.cloudposse.com/reference-architecture/design-decisions/cold-start/decide-on-secrets-management-strategy-for-terraform/)
193+
- https://external-secrets.io/v0.5.9/
194+
- https://external-secrets.io/v0.5.9/provider-aws-parameter-store/

0 commit comments

Comments
 (0)