Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesse0Michael committed Nov 22, 2022
1 parent bcde981 commit 1285ca0
Showing 1 changed file with 2 additions and 24 deletions.
26 changes: 2 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,4 @@
# aws-cli-docker
Docker image for the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/) that runs a web server on port `9000` after running any scripts in the `init` directory to be used by a [wait-for-it](https://github.com/vishnubob/wait-for-it) script.
Docker image for the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/) will ensure that the credentials are available on the container before continuing with the aws-cli command.

The wait-for-it script is available inside the docker image as well at `/scripts/wait-for-it.sh` to be used in your script.
## Usage

Docker:
``` bash
docker run -it ghcr.io/leakytap/aws-cli-docker:latest
```

Docker compose:
``` yaml
version: "3.5"
services:
aws:
image: ghcr.io/leakytap/aws-cli-docker:latest
environment:
AWS_REGION: "us-west-2"
AWS_ACCESS_KEY_ID: key
AWS_SECRET_ACCESS_KEY: secret=value
volumes:
- ./init:/init
ports:
- 9000:9000
```
It is intended to be ran in kubernetes on EC2 instances and uses the [ec2 meta-data endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html) to function.

0 comments on commit 1285ca0

Please sign in to comment.