Skip to content

Commit f1267ce

Browse files
committed
Add an example with "st2_packs" to quick start
1 parent 2fbedb6 commit f1267ce

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ jobs:
4545
aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
4646
st2_auth_username: ${{ secrets.ST2_AUTH_USERNAME}}
4747
st2_auth_password: ${{ secrets.ST2_AUTH_PASSWORD}}
48+
st2_packs: "st2,aws,github"
4849
```
4950
5051
This will create the following resources in AWS:
@@ -87,7 +88,7 @@ The following inputs can be used as `steps.with` keys:
8788
| `tf_state_bucket_destroy` | bool | `false` | Force purge and deletion of `tf_state_bucket` defined. Any file contained there will be destroyed. `tf_stack_destroy` must also be `true` |
8889

8990

90-
## Note about AWS resource identifiers
91+
### Note about AWS resource identifiers
9192
Most resources will contain the tag `GITHUB_ORG-GITHUB_REPO-GITHUB_BRANCH` to make them unique. Because some AWS resources have a length limit, we shorten identifiers to a `60` characters max string.
9293

9394
We use the Kubernetes style for this. For example, `Kubernetes` -> `k(# of characters)s` -> `k8s`. And so you might see how compressions are made.

0 commit comments

Comments
 (0)