Skip to content

Commit ea5ba57

Browse files
authored
Missing details in README
Added resource identifier note and S3 bucket
1 parent 875f071 commit ea5ba57

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -266,9 +266,21 @@ The following inputs can be used as `step.with` keys
266266
| `aurora_proxy_endpoint` | Database proxy endpoint. |
267267
| `aurora_proxy_secret_name` | AWS Secret name containing proxy credentials. |
268268
| `aurora_proxy_sg_id` | SG ID for the Aurora Proxy instance. |
269-
270269
<br/>
271270

271+
## Note about resource identifiers
272+
273+
Most resources will contain the tag `${GITHUB_ORG_NAME}-${GITHUB_REPO_NAME}-${GITHUB_BRANCH_NAME}`, some of them, even the resource name after.
274+
We limit this to a 60 characters string because some AWS resources have a length limit and short it if needed.
275+
276+
We use the kubernetes style for this. For example, kubernetes -> k(# of characters)s -> k8s. And so you might see some compressions are made.
277+
278+
For some specific resources, we have a 32 characters limit. If the identifier length exceeds this number after compression, we remove the middle part and replace it for a hash made up from the string itself.
279+
280+
### S3 buckets naming
281+
282+
Buckets names can be made of up to 63 characters. If the length allows us to add -tf-state, we will do so. If not, a simple -tf will be added.
283+
272284
## Contributing
273285
We would love for you to contribute to [`bitovi/github-actions-deploy-aurora`](hhttps://github.com/bitovi/github-actions-deploy-aurora). [Issues](https://github.com/bitovi/github-actions-deploy-aurora/issues) and [Pull Requests](https://github.com/bitovi/github-actions-deploy-aurora/pulls) are welcome!
274286

0 commit comments

Comments
 (0)