/aries-cloudagent-container

Runnable Docker image for the Hyperledger Aries Cloudagent

Primary LanguagePythonApache License 2.0Apache-2.0

img License

Docker images for Hyperledger Aries Cloud Agent

The image repository is located on Docker Hub.

The images include language-specific implementations of Aries Cloudagent such as:

Repository structure

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.

Adding a new implementation/language

To add a new implementation/language:

  1. 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.
  2. Update the VERSIONS object in make_image.py to add the new implementation/language details.

Image versioning

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 (minus -$version, if present), followed by _$version, where both values are from the VERSIONS JSON structure in make_image.py. For example:

  • $base_image: py3.9-indy-1.16.0-0.9.0-rc0
  • $version: 0.9.0-rc0
  • Tag: py3.9-indy-1.16.0_0.9.0-rc0

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.

Up until release 0.9.0 (and 1.0.0-rc3), the base image came from von-images and used Python 3.6. After those versions, the base image comes from the released container image from ACA-Py CI/CD publication process that pushes to Hyperledger's GitHub Container Repository based on Python 3.9. As such, the bcgovimages images are now just republications of the same images that are published from the ACA-Py CI/CD pipeline. We are retaining them because of the large user base still using pulling ACA-Py from the bcgovimages repository.

Building the image locally

This project is setup to use Visual Studio Code Remote - Containers. The devContainer includes everything you need to work on the project and build the images. The container uses docker-from-docker so any images you build will show up in your host's docker repository.

Pre-requisites

Using the devContainer:

  • Visual Studio Code with the Remote - Containers extension installed.
  • Docker

To develop and build the image locally you will need to install:

Running the build

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.

Building an image from a GitHub source

In some cases you may want to build an image from a particular repository and branch. You can do this by adding the git_egg_ref build-arg to the command line. In this case the version number you specify will only be used to determine the relevant base_image and acapy_reqs to use for the build.

The format of the git_egg_ref argument is:

  • git+<git_repo_url>[@<git_ref>]#egg=
    • Where:
      • <git_repo_url>: Is the url to the repo including the trailing .git extension.
      • <git_ref>: Optional. The git_ref of the branch or tag to use. If specified, the <git_repo_url> and <git_ref> must be separated by a @.

Example:

./make_image.py 0.7.3 python --build-arg git_egg_ref="git+https://github.com/WadeBarnes/aries-cloudagent-python.git@persistant_queue#egg="

Adding and Publishing a New Image

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 Python.
    • The image tag of the output will be a concatenation of the two, as described above.
  • 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-cache and --test
    • python make_image.py 0.12.1 --no-cache --test python
  • If successful, push the image to the bcgovimages organization of Docker Hub using the --push option
    • python make_image.py 0.12.1 --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.

Credits

The build scripts in this repository have taken inspiration from the ones used to build von-image