Skip to content
This repository was archived by the owner on Feb 2, 2021. It is now read-only.

Commit 795de64

Browse files
Waterdripsalexellis
authored andcommitted
Update USER_GUIDE to clarify how ECR users can namespace ecr registries
A user can suffix their ECR Registry url with something that will become the prefix of the ECR Registries, This is useful when users want to use 1 aaws account's ECR registry for multiple clusters, where they may be building the same code. Such as staging + prod clusters Signed-off-by: Alistair Hey <alistair@heyal.co.uk>
1 parent f3277af commit 795de64

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

USER_GUIDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,12 @@ Find the section of the YAML `registry:` set the value accordingly, replacing `A
225225

226226
The final `/` is required
227227

228+
When using ECR a user can namespace their registries per cluster by adding a suffix to the ecr registry:
229+
230+
`$ACCOUNT_ID.dkr.ecr.$REGION.amazonaws.com/your-cluster-suffix`
231+
232+
This would create registries prefixed with `your-cluster-prefix` for the user's docker images.
233+
228234
* Create a new user with the role `AmazonEC2ContainerRegistryFullAccess` - see also [AWS permissions for ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/ecr_managed_policies.html)
229235

230236
* The file will be read from `~/.aws/credentials` by default, but you can change this via editing the path in `value_from` under the `ecr-credentials` secret
@@ -267,7 +273,9 @@ Your SCM will need to send webhooks to OpenFaaS Cloud's github-event or gitlab-e
267273
* If not using a generated value, set the `github-webhook-secret` literal value with your *Webhook secret* for the GitHub App's
268274
* Click *Generate a private key*, this will be downloaded to your local computer (if you ever need a new one, generate a new one and delete the old key)
269275
* Update the `private-key` `value_from` to the path of the GitHub App's private key
270-
276+
* Make sure the app is "activated" using the checkbox at the bottom of the github page.
277+
278+
271279
* For GitLab create a System Hook
272280
* Leave the `value:` for `gitlab-webhook-secret` blank, or set your own password
273281
* Update the `## User-input` section including your System Hook's API Token and *Webhook secret*

0 commit comments

Comments
 (0)