Skip to content

Commit

Permalink
feat: prettier in READMEs (cloudposse/terraform-aws-components#998)
Browse files Browse the repository at this point in the history
  • Loading branch information
milldr authored Mar 11, 2024
1 parent 247c535 commit e69b78b
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Component: `aurora-mysql-resources`

This component is responsible for provisioning Aurora MySQL resources: additional databases, users, permissions, grants, etc.
This component is responsible for provisioning Aurora MySQL resources: additional databases, users, permissions, grants,
etc.

NOTE: Creating additional users (including read-only users) and databases requires Spacelift, since that action to be done via the mysql provider, and by default only the automation account is whitelisted by the Aurora cluster.
NOTE: Creating additional users (including read-only users) and databases requires Spacelift, since that action to be
done via the mysql provider, and by default only the automation account is whitelisted by the Aurora cluster.

## Usage

**Stack Level**: Regional

Here's an example snippet for how to use this component.

`stacks/catalog/aurora-mysql/resources/defaults.yaml` file (base component for Aurora MySQL Resources with default settings):
`stacks/catalog/aurora-mysql/resources/defaults.yaml` file (base component for Aurora MySQL Resources with default
settings):

```yaml
components:
Expand All @@ -22,8 +25,10 @@ components:
enabled: true
```
Example (not actual)
`stacks/uw2-dev.yaml` file (override the default settings for the cluster resources in the `dev` account, create an additional database and user):
Example (not actual):
`stacks/uw2-dev.yaml` file (override the default settings for the cluster resources in the `dev` account, create an
additional database and user):

```yaml
import:
Expand All @@ -43,12 +48,13 @@ components:
db_user: example
db_password: ""
grants:
- grant: [ "ALL" ]
- grant: ["ALL"]
db: example
object_type: database
schema: null
```

<!-- prettier-ignore-start -->
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

Expand Down Expand Up @@ -124,10 +130,11 @@ components:
| <a name="output_additional_grants"></a> [additional\_grants](#output\_additional\_grants) | Additional DB users created |
| <a name="output_additional_users"></a> [additional\_users](#output\_additional\_users) | Additional DB users created |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

<!-- prettier-ignore-end -->

## References
* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/aurora-mysql-resources) - Cloud Posse's upstream component

- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/aurora-mysql-resources) -
Cloud Posse's upstream component

[<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)

0 comments on commit e69b78b

Please sign in to comment.