Skip to content

submariner-io/shipyard

Repository files navigation

Shipyard

CII Best Practices Release Images Periodic

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

Prerequisites

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

Shipyard provides this file automatically for you. You can also define it explicitly to be more tailored to the specific project.

The Dockerfile should build upon quay.io/submariner/shipyard-dapper-base.

For example, this very basic file allows E2E testing:

FROM quay.io/submariner/shipyard-dapper-base:devel

ENV 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, but it's best to download and import it. To use Shipyard's target, simply include the Makefile.inc file in your own Makefile.

The simplest Makefile would look like this:

BASE_BRANCH=devel
PROJECT=shipyard
SHIPYARD_URL=https://raw.githubusercontent.com/submariner-io/shipyard/$(BASE_BRANCH)
export BASE_BRANCH PROJECT SHIPYARD_URL

ifneq (,$(DAPPER_HOST_ARCH))

# Running in Dapper

include $(SHIPYARD_DIR)/Makefile.inc

else

# Not running in Dapper

Makefile.dapper:
        @echo Downloading $@
        @curl -sfLO $(SHIPYARD_URL)/$@

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.