Skip to content

Commit

Permalink
Tweak grammar and writing of the docker ci README.md and move it to c…
Browse files Browse the repository at this point in the history
…i directory

Signed-off-by: Peter Zhu <[email protected]>
  • Loading branch information
peterzhuamazon committed May 16, 2023
1 parent b22fc9e commit cd82719
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docker/README.md → docker/ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,16 @@ We build, assemble, and test our artifacts on docker containers. All of our pipe
To build the docker image for either x64 or arm64, run the below command on a x64 or arm64 host respectively within the `opensearch-build/docker/ci` folder:

```bash
./build-image-single-arch.sh -r <Repo name> -v <Tag name> -f <Docker File Path>
./build-image-single-arch.sh -r <Repo Name> -v <Tag Name> -f <Docker File Path>
```
After the build, you can locate an image in your host using the `docker images` command with the following format: `opensearchstaging/<Repo Name>:<Tag Name>`.


If you want to build multi-arch docker image for both x64 and arm64, you can use the below command.\
Make sure you are running it within the `opensearch-build/docker/ci` folder.

```bash
./build-image-multi-arch.sh -r <Repo name> -v <Tag name> -f <Docker File Path>
./build-image-multi-arch.sh -r <Repo Name> -v <Tag Name> -f <Docker File Path>
```
Docker buildx is a tool utilized for building multi-arch images. It leverages a `moby/buildkit` container to construct these images, combining all the CPU architecture layers into a single entity. Consequently, you can only upload the resulting image to Docker Hub or store it locally as cache. Due to the limitation that your host cannot support multiple CPU architectures, the image will not be visible when running the `docker images` command.

0 comments on commit cd82719

Please sign in to comment.