Skip to content

Commit

Permalink
Revert "removed ECR image links (#348)"
Browse files Browse the repository at this point in the history
This reverts commit 6446b45.
  • Loading branch information
shangabl committed Dec 7, 2022
1 parent 95be3d3 commit 88813db
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
13 changes: 11 additions & 2 deletions .github/docker-images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,19 @@ The AWS IoT Device Client provides several Docker images to simplify testing and
## Base Images

The base images are built from the Docker files located in the [base-images](./base-images) directory. These images contain
the dependencies of the Device Client only and are intended to be used to build & run the Device Client.
the dependencies of the Device Client only and are intended to be used to build & run the Device Client. Pre-built base
images are publicly available through AWS ECR in the [aws-iot-device-client-base-images repository](https://gallery.ecr.aws/aws-iot-device-client/aws-iot-device-client-base-images).

## AWS IoT Device Client Images

Docker images containing Device Client binaries are also available through ECR. These images are built using this [Dockerfile](./Dockerfile)
and are multi-stage builds that are minimum sized. Images are built from both the pre-release and main branches. The pre-release
images are available for testing and experimenting with features which are still in development from the [pre-release repository](https://gallery.ecr.aws/aws-iot-device-client/pre-release).
Images built from the main branch are available from the [aws-iot-device-client repository](https://gallery.ecr.aws/aws-iot-device-client/aws-iot-device-client).

## Integration Test Images

Before releasing new features on the main branch end-to-end tests are performed in the pre-release branch. As part of this
process the Docker files located in the [integration-tests](./integration-tests) directory are used to build and run the
end-to-end tests.
end-to-end tests. In order to make it easy to recreate any test failures locally, these images are pushed to the [integration-tests repository](https://gallery.ecr.aws/aws-iot-device-client/integration-tests).
These images contain both the pre-release version of the Device Client and the integration test binary.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,14 @@ The AWS IoT Device Client is currently compatible with x86_64, aarch64, armv7l,

### Docker

The AWS IoT Device Client currently provides several dockerfiles for various platforms and Linux distributions.
The AWS IoT Device Client currently provides several docker images on various platforms and Linux distributions.

To build a Docker image from the repository locally simply run the [docker-build.sh](docker-build.sh) script with your
preferred OS (ubuntu/amazonlinux/ubi8) (e.g. docker-build.sh ubuntu) if no OS is passed the build will default to ubuntu (18.04).

For a minimum sized fully built AWS IoT Device Client Docker image simply pull your preferred architecture/OS combination
from our repository [here](https://gallery.ecr.aws/aws-iot-device-client/aws-iot-device-client)

#### Docker Files

- [Base Images:](.github/docker-images/base-images) Multi-stage Dockerfiles which will build dependencies only (target=**base**) or build the Device Client from your current directory(target=**deploy**).
Expand Down

0 comments on commit 88813db

Please sign in to comment.