Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.33 KB

README.md

File metadata and controls

90 lines (66 loc) · 2.33 KB
Raw

Building Veracruz

This directory has the code for building the Docker containers used for developing Veracruz.

Requirements

  • Docker: We use Docker to provide a consistent build environment. Follow this guide to install Docker if necessary.

Local build setup

This repository uses git submodule, use the following command to clone:

git clone --recursive https://github.com/veracruz-project/veracruz.git

Enter this directory in a local copy of the Veracruz source:

cd veracruz/docker

Build and run

There are several different Docker containers that can be used, depending on the platform. If you are new to Veracruz you should probably try localci first.

localci

To build the container:

make localci-build

To run the container:

make localci-run

With docker ps you should now be able to see the container running.

To get a shell in the container running as the appropriate non-root user:

make localci-exec

The Veracruz tree should be mounted in the container, so you can run, for example:

cd /work/veracruz/workspaces
make linux && make linux-tests
make nitro

(On an ordinary Linux system you can build for nitro, but not run the tests.)

linux

This is the same as localci, above, except only for the Linux platform.

nitro

This is the same as localci, above, except only for the AWS Nitro platform and you can also run the Nitro tests on appropriate hardware. See the Nitro instructions.

ci

This is the same as localci, above, except that you will run as root. This container is used for CI in the cloud.

Docker images

flowchart TD
    A[ubuntu:22.04] -->|base/Dockerfile| B(veracruz/base:$VERSION)
    B --> |linux/Dockerfile| C(veracruz/linux:$VERSION)
    C --> |Dockerfile| D(veracruz/linux/$USER:$VERSION)
    B --> |nitro/Dockerfile| E(veracruz/nitro:$VERSION)
    E --> |Dockerfile| F(veracruz/nitro/$USER:$VERSION)
    E --> |ci/Dockerfile.base| G(veracruz/ci-base:$VERSION)
    G --> |ci/Dockerfile.cache| H(veracruz/ci:$VERSION)
    G --> |ci/Dockerfile.local| I(veracruz/localci:$VERSION)
    I --> |Dockerfile| J(veracruz/localci/$USER:$VERSION)