Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add breadcrumbs for correct role and permission setup.
  • Loading branch information
sj26 authored Oct 20, 2020
1 parent 62ce0fe commit 300703c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) to login to an ECR repository before running a build step.

This will use standard AWS credentials available [in the environment](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html), or as an [instance role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) or task role as available. These must be granted [appropriate permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/security_iam_id-based-policy-examples.html) for login to succeed and for push and pull to operate.

## Example

This will login docker to ECR prior to running your script.
Expand Down

0 comments on commit 300703c

Please sign in to comment.