The image repository is located on Docker Hub.
The images include language-specific implementations of Aries Cloudagent such as:
The repository is structured so that there is a folder for each implementation/language , and this contains the dockerfiles and resources required to build and test the output image.
Inside make_image.py a data structure called VERSIONS describes the versions and base image for each implementation/language.
To add a new implementation/language:
- create a new folder named after the new implementation in the root of the repository. For reference, the python folder can be copied and its contents updated to reflect the new implementation/language.
- Update the
VERSIONSobject in make_image.py to add the new implementation/language details.
All the aries-cloudagent images will reside on the Aries Cloud Agent Docker Hub, and will differentiate between each other by using specific tags.
By default, the tag for a new image will be composed by $base_image_tag, followed by _$agent_version. Because of this naming convention, please make sure you use a tagged version for each base image rather than using latest or a more generic tag that is not as descriptive.
| Image tag | Implementation | Base image | aries-cloudagent |
|---|---|---|---|
| py36-1.11-0_0.3.0 | python | von-image:py36-1.11-0 | 0.3.0 |
| py36-1.11-0_0.3.1 | python | von-image:py36-1.11-0 | 0.3.1 |
| py36-1.11-1_0.3.2 | python | von-image:py36-1.11-1 | 0.3.2 |
| py36-1.11-1_0.3.3 | python | von-image:py36-1.11-1 | 0.3.3 |
| py36-1.11-1_0.3.4 | python | von-image:py36-1.11-1 | 0.3.4 |
| py36-1.11-1_0.3.5 | python | von-image:py36-1.11-1 | 0.3.5 |
| py36-1.11-1_0.4.0 | python | von-image:py36-1.11-1 | 0.4.0 |
| py36-1.11-1_0.4.1 | python | von-image:py36-1.11-1 | 0.4.1 |
| py36-1.14-0_0.4.2 | python | von-image:py36-1.14-0 | 0.4.2 |
| py36-1.14-1_0.4.3 | python | von-image:py36-1.14-1 | 0.4.3 |
| py36-1.14-1_0.4.4 | python | von-image:py36-1.14-1 | 0.4.4 |
| py36-1.14-1_0.4.5 | python | von-image:py36-1.14-1 | 0.4.5 |
| py36-1.14-1_0.5.0 | python | von-image:py36-1.14-1 | 0.5.0 |
| py36-1.14-1_0.5.1 | python | von-image:py36-1.14-1 | 0.5.1 |
| py36-1.15-0_0.5.2 | python | von-image:py36-1.15-0 | 0.5.2 |
| py36-1.15-0_0.5.3 | python | von-image:py36-1.15-0 | 0.5.3 |
| py36-1.15-0_0.5.4 | python | von-image:py36-1.15-0 | 0.5.4 |
| py36-1.15-0_0.5.5 | python | von-image:py36-1.15-0 | 0.5.5 |
| py36-1.15-0_0.5.6 | python | von-image:py36-1.15-0 | 0.5.6 |
| py36-1.15-1_0.6.0 | python | von-image:py36-1.15-1 | 0.6.0 |
| py36-1.16-1_0.7.0 | python | von-image:py36-1.16-1 | 0.7.0 |
| py36-1.16-1_0.7.1 | python | von-image:py36-1.16-1 | 0.7.1 |
| py36-1.16-1_0.7.1 | python | von-image:py36-1.16-1 | 0.7.2-rc0 |
To build the image locally you will need to install:
To build the image, open a terminal session at the root of this git repo and execute: python make_image.py 0.3.0 python,
replacing 0.3.0 with the aries-cloudagent version you need.
Additional parameters can be specified through command-line, for more information please type python make_image.py --help to display the command's usage page.
To add a new version of aries-cloudagent to this repo, create a PR with the following changes:
- Decide on the base image to be used for the image, and the version of Aries Cloud Agent.
- The image tag of the output will be a concatenation of the two, as indicated in the table above.
- Update the table in this readme to add the new version.
- Edit the make_image.py file in this repo to add the new version.
- Create and test the build of the local image using the options
--no-cacheand--testpython make_image.py 0.7.2-rc0 --no-cache --test python
- If successful, push the image to the bcgovimages organization of Docker Hub using the
--pushoptionpython make_image.py 0.7.2-rc0 --push python
- If successful, verify the publishing of the image by checking Docker Hub
- Note that it make take a few minutes for the new tag to appear. Hit refresh periodically until the image is visible.
The build scripts in this repository have taken inspiration from the ones used to build von-image