Skip to content

Commit d625b90

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

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

src/README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Component: `snowflake-account`
22

3-
This component sets up the requirements for all other Snowflake components, including creating the Terraform service user. Before running this component, follow the manual, Click-Ops steps below to create a Snowflake subscription.
3+
This component sets up the requirements for all other Snowflake components, including creating the Terraform service
4+
user. Before running this component, follow the manual, Click-Ops steps below to create a Snowflake subscription.
45

56
## Deployment Steps
67

@@ -10,28 +11,39 @@ This component sets up the requirements for all other Snowflake components, incl
1011
4. Select "Snowflake Data Cloud"
1112
5. Click "Continue to Subscribe"
1213

13-
6. Fill out the information steps using the following as an example. Note, the provided email cannot use labels such as `[email protected]`.
14+
6. Fill out the information steps using the following as an example. Note, the provided email cannot use labels such as
15+
16+
1417
```
1518
First Name: John
1619
Last Name: Smith
1720
1821
Company: Example
1922
Country: United States
2023
```
21-
7. Select "Standard" and the current region. In this example, we chose "US East (Ohio)" which is the same as `us-east-1`.
22-
7. Continue and wait for Sign Up to complete. Note the Snowflake account ID; you can find this in the newly accessible Snowflake console in the top right of the window.
23-
8. Check for the Account Activation email. Note, this may be collected in a Slack notifications channel for easy access.
24-
9. Follow the given link to create the Admin user with username `admin` and a strong password. Be sure to save that password somewhere secure.
25-
10. Upload that password to AWS Parameter Store under `/snowflake/$ACCOUNT/users/admin/password`, where `ACCOUNT` is the value given during the subscription process. This password will only be used to create a private key, and all other authentication will be done with said key. Below is an example of how to do that with a [chamber](https://github.com/segmentio/chamber) command:
24+
25+
7. Select "Standard" and the current region. In this example, we chose "US East (Ohio)" which is the same as
26+
`us-east-1`.
27+
8. Continue and wait for Sign Up to complete. Note the Snowflake account ID; you can find this in the newly accessible
28+
Snowflake console in the top right of the window.
29+
9. Check for the Account Activation email. Note, this may be collected in a Slack notifications channel for easy access.
30+
10. Follow the given link to create the Admin user with username `admin` and a strong password. Be sure to save that
31+
password somewhere secure.
32+
11. Upload that password to AWS Parameter Store under `/snowflake/$ACCOUNT/users/admin/password`, where `ACCOUNT` is the
33+
value given during the subscription process. This password will only be used to create a private key, and all other
34+
authentication will be done with said key. Below is an example of how to do that with a
35+
[chamber](https://github.com/segmentio/chamber) command:
36+
2637
```
2738
AWS_PROFILE=$NAMESPACE-$TENANT-gbl-sbx01-admin chamber write /snowflake/$ACCOUNT/users/admin/ admin $PASSWORD
2839
```
40+
2941
11. Finally, use atmos to deploy this component:
42+
3043
```
3144
atmos terraform deploy snowflake/account --stack $TENANT-use2-sbx01
3245
```
3346

34-
3547
## Usage
3648

3749
**Stack Level**: Regional
@@ -55,6 +67,7 @@ components:
5567
Service: snowflake
5668
```
5769
70+
<!-- prettier-ignore-start -->
5871
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
5972
## Requirements
6073
@@ -150,6 +163,6 @@ components:
150163
| <a name="output_ssm_path_terraform_user_name"></a> [ssm\_path\_terraform\_user\_name](#output\_ssm\_path\_terraform\_user\_name) | The path to the SSM parameter for the Terraform user name. |
151164
| <a name="output_ssm_path_terraform_user_private_key"></a> [ssm\_path\_terraform\_user\_private\_key](#output\_ssm\_path\_terraform\_user\_private\_key) | The path to the SSM parameter for the Terraform user private key. |
152165
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
153-
166+
<!-- prettier-ignore-end -->
154167

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

0 commit comments

Comments
 (0)