To use Shipyard in your project, it’s easiest to use Dapper and Make. To use Dapper you’ll need a specific Dockerfile that Dapper consumes to create a consistent environment based upon Shipyard’s base image. To use Make you’ll need some commands to enable Dapper and also include the targets which ship in the base image.
The project should have a Dockerfile.dapper Dockerfile which builds upon quay.io/submariner/shipyard-dapper-base.
For example:
FROM quay.io/submariner/shipyard-dapper-base
ENV DAPPER_ENV="REPO TAG QUAY_USERNAME QUAY_PASSWORD TRAVIS_COMMIT" \
DAPPER_SOURCE=<your source directory> DAPPER_DOCKER_SOCKET=true
ENV DAPPER_OUTPUT=${DAPPER_SOURCE}/output
WORKDIR ${DAPPER_SOURCE}
ENTRYPOINT ["./scripts/entry"]
CMD ["ci"]
You can also refer to the project’s own Dockerfile.dapper as an example.
To build the base container image used in the shared developer and CI enviroment, simply run:
make dapper-image
The project’s Makefile should include targets to run everything in Dapper. These are defined in Shipyard’s Makefile.dapper which can be copied as is into your project and included in the Makefile. To use Shipyard’s built-in targets available in the base Dapper image, include the Makefile.inc file in the project’s Makefile within the section where the Dapper environment is detected.
The simplest Makefile would look like this:
ifneq (,$(DAPPER_HOST_ARCH))
# Running in Dapper
include $(SHIPYARD_DIR)/Makefile.inc
else
# Not running in Dapper
include Makefile.dapper
endif
# Disable rebuilding Makefile
Makefile Makefile.dapper Makefile.inc: ;
You can also refer to the project’s own Makefile as an example.