Documentation

Build From Scratch

While the README pulls from the Heptio image registry, you can also build your own Heptio Ark container with the following steps:

0. Prerequisites

In addition to the handling the prerequisites mentioned in the Quickstart, you should have Go installed (minimum version 1.8).

1. Download

Install with go: go get github.com/heptio/ark The files are installed in $GOPATH/src/github.com/heptio/ark.

2. Build

You can build your Ark image locally on the machine where you run your cluster, or you can push it to a private registry. This section covers both workflows.

Set the $REGISTRY environment variable (used in the Makefile) if you want to push the Heptio Ark images to your own registry. This allows any node in your cluster to pull your locally built image.

$PROJECT and $VERSION environment variables are also specified in the Makefile, and can be similarly modified as desired.

Run the following in the Ark root directory to build your container with the tag $REGISTRY/$PROJECT:$VERSION: sudo make all

To push your image to a registry, use make push.

3. Run

Considerations

When running Heptio Ark, you will need to account for the following (all of which are handled in the /examples manifests): * Appropriate RBAC permissions in the cluster * Read access for all data from the source cluster and namespaces * Write access to the target cluster and namespaces * Cloud provider credentials * Read/write access to volumes * Read/write access to object storage for backup data * A Config object definition for the Ark server

See Cloud Provider Specifics for a more detailed guide.

Specifying your image

Once your Ark deployment is up and running, you need to replace the Heptio-provided Ark image with the specific one that you built. You can do so with the following command: kubectl set image deployment/ark ark=$REGISTRY/$PROJECT:$VERSION where $REGISTRY, $PROJECT, and $VERSION match what you used in the build step.

4. Vendoring dependencies

If you need to add or update the vendored dependencies, please see Vendoring dependencies.

Getting Started

To help you get started, see the documentation.