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

Commit

Permalink
Update USER_GUIDE to clarify how ECR users can namespace ecr registries
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Waterdrips authored and alexellis committed Feb 25, 2020
1 parent f3277af commit 795de64
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,12 @@ Find the section of the YAML `registry:` set the value accordingly, replacing `A

The final `/` is required

When using ECR a user can namespace their registries per cluster by adding a suffix to the ecr registry:

`$ACCOUNT_ID.dkr.ecr.$REGION.amazonaws.com/your-cluster-suffix`

This would create registries prefixed with `your-cluster-prefix` for the user's docker images.

* 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)

* 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
Expand Down Expand Up @@ -267,7 +273,9 @@ Your SCM will need to send webhooks to OpenFaaS Cloud's github-event or gitlab-e
* If not using a generated value, set the `github-webhook-secret` literal value with your *Webhook secret* for the GitHub App's
* 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)
* Update the `private-key` `value_from` to the path of the GitHub App's private key

* Make sure the app is "activated" using the checkbox at the bottom of the github page.


* For GitLab create a System Hook
* Leave the `value:` for `gitlab-webhook-secret` blank, or set your own password
* Update the `## User-input` section including your System Hook's API Token and *Webhook secret*
Expand Down

0 comments on commit 795de64

Please sign in to comment.