Hermit enables you to make Docker container images for the Xilinx tools listed below.

• Vivado Design Suite HLx Editions(Vivado)
• Vitis Unified Software Platform(Vitis)
• PetaLinux Tools

The name "Hermit" represents

• isolation of the tools based on containerization,
• that itself is developed while quarantine caused by COVID-19.

• Docker Host Environment
  • Docker Engine
  • Docker Compose(18.06.0+, which can work with Compose file format 3.7)

• Vivado HLx 20xx.x: All OS installer Single-File(e.g. Xilinx_Vivado_20xx.x_xxxx_xxxx.tar.gz)
  Note that its size is nearly 30 GB.
• Free disk space larger than 30 GB, for the built container image.

• Xilinx Vitis 20xx.x: All OS installer Single-File(e.g. Xilinx_Vitis_20xx.x_xxxx_xxxx.tar.gz)
  Note that its size is nearly 30 GB.
• Free disk space larger than 45 GB, for the built container image.

• PetaLinux 20xx.x installer(e.g. petalinux-v20xx.x-final-installer.run)
  Note that its size is nearly 10 GB.
• Free disk space larger than 12 GB, for the built container image.

$ git clone /path/to/this/repo
$ cd repo

# for Vivado
$ mv /path/to/Xilinx_Vivado_20xx.x_xxxx_xxxx.tar.gz Xilinx_Vivado_20xx.x.tar.gz
$ chmod a+r Xilinx_Vivado_20xx.x.tar.gz

# for Vitis
$ mv /path/to/Xilinx_Vitis_20xx.x_xxxx_xxxx.tar.gz Xilinx_Vitis_20xx.x.tar.gz
$ chmod a+r Xilinx_Vitis_20xx.x.tar.gz

# for PetaLinux Tools
$ mv /path/to/petalinux-v20xx.x-final-installer.run .
$ chmod a+r petalinux-v20xx.x-final-installer.run

We have to grant 'others' read access to the installers, so that the file server mensioned later can access the installers to serve them. Therefore, the above chmod commands do so.

The names of the original installers for Vivado and Vitis contain numbers, which seem to be release date and time. Because they could be cause of any troubles, the above mv commands remove the numbers from the names, as well as move files.

$ docker-compose -f docker-compose.ext.yml up -d repository

You can build each container image by simply running the following command.

$ docker-compose -f docker-compose.yml -f docker-compose.ext.yml build service_name

Note that service_name is a place holder, and must be replaced by a specific service name based on the following table.

Not only built images but also dangling images and cached images are so big. Therefore, it is strongly recommended to dispose these wasted images.

$ docker image prune -f

The above build command, by default, builds corresponding images with revisions specified in .env. For example, petalinux:2020.2-slim is built for PetaLinux Tools, as specified in .env, given that ofcourse the installer for v2020.2 has been placed.

If you prefer to build each images with other revisions of the corresponding tools, run the build command like(e.g. with PetaLinux Tools v2018.2):

$ PETALINUX_VER=2018.2 docker-compose -f docker-compose.yml -f docker-compose.ext.yml build petalinux

or, run the above build command after modify .env directly.

It takes 1 or 2 hour(s) to build images for PetaLinux Tools. It may be longer than expected, depending on the network performance of your system.

It takes 2 or more hours to build images for each of Vivado and Vitis. This is because the size of their installers is too big. It is recommended not to use the computer on which Docker Engine serves while building the images in order to avoid I/O thrashing.

$ docker-compose -f docker-compose.ext.yml down

If you want to work with Bash interactive shell, run the following command(e.g. with PetaLinux Tools).

$ docker-compose run --rm petalinux # with image for PetaLinux Tools

This starts a interactive bash process on a container with the image petalinux-20xx.x-slim(by default 2020.2). The started bash process is source'd, prior to interaction with you, so that PetaLinux Tools commands(e.g. petalinux-config) are available.

You can also similarly start bash interactive shell with images for Vivado and Vitis. Try the following commands.

$ docker-compose run --rm vivado # with image for Vivado
$ docker-compose run --rm vitis # with image for Vitis

If you want to use commands(e.g. petalinux-config) directly on the command line within Docker host environment, add the command simply to the command line.

$ docker-compose run --rm petalinux petalinux-config

• shrink container image size
• make Platform Cable USB II available within containers

• incorporate/automate to apply license key

• solve incompatibility issue between Ubuntu 18.04 and Python 3.5
• make tftp available

• UG973 Vivado Design Suite User Guide - Release Notes, Installation, and Licensing
• UG1400 Vitis Unified Software Platform Documentation - Embedded Software Development
• UG1144 PetaLinux Tools Documentation - Reference Guide
• Xilinx の開発ツールを Docker コンテナに閉じ込める