shipyard

README

Shipyard

The Shipyard project provides tooling for creating K8s clusters with kind(K8s in Docker) and provides a Go framework for creating E2E tests.

Prerequisites

• go 1.12 with $GOPATH configured
• docker

Usage

To use Shipyard for 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.

Dockerfile.dapper

The Dockerfile should build 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=/go/src/github.com/submariner-io/submariner 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.

Makefile

The Makefile should include targets to run everything in Dapper. They're defined in Makefile.dapper and can be copied as-is and included. To use Shipyard's target, simply include the Makefile.inc file in your own Makefile.

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.

Releases

Get the latest version from the Releases page.