Maintainers: Heptio

This repository contains example plugins for Heptio Ark.

Ark currently supports the following kinds of plugins:

• Object Store - persists and retrieves backups, backup log files, restore warning/error files, restore logs.
• Block Store - creates snapshots from volumes (during a backup) and volumes from snapshots (during a restore).
• Backup Item Action - performs arbitrary logic on individual items prior to storing them in the backup file.
• Restore Item Action - performs arbitrary logic on individual items prior to restoring them in the Kubernetes cluster.

To build the plugins, run

$ make container

To build the image, run

$ make container

This builds an image tagged as gcr.io/heptio-images/ark-plugin-example. If you want to specify a different name, run

$ make container IMAGE=your-repo/your-name:here

To deploy your plugin image to an Ark server:

1. Make sure your image is pushed to a registry that is accessible to your cluster's nodes.
2. Run ark plugin add <image>, e.g. ark plugin add gcr.io/heptio-images/ark-plugin-example

When the plugin is deployed, it is only made available to use. To make the plugin effective, you must modify your configuration:

1. Run kubectl edit config <config-name> -n <ark-namespace> e.g. kubectl edit config default -n heptio-ark
2. Change the name of section: backupStorageProvider for Object Store plugin, persistentVolumeProvider for Block Store plugin
3. Save and quit, the plugin will be used for the next backup/restore

1. Create a new directory in your $GOPATH, e.g. $GOPATH/src/github.com/someuser/ark-plugins
2. Copy everything from this project into your new project

$ cp -a $GOPATH/src/github.com/heptio/ark-plugin-example/* $GOPATH/src/github.com/someuser/ark-plugins/.

3. Remove the git history

$ cd $GOPATH/src/github.com/someuser/ark-plugins
$ rm -rf .git

4. Adjust the existing plugin directories and source code as needed.

The Makefile is configured to automatically build all directories starting with the prefix ark-. You most likely won't need to edit this file, as long as you follow this convention.

If you need to pull in additional dependencies to your vendor directory, just run

$ ./dep-save.sh

Note that currently, Ark uses the name of the plugin binary to determine the type and unique name of the plugin. This means that Ark will only recognize one plugin per binary file.

If you want to implement more than one plugin in a single binary, you can create hard or symbolic links to your binary and add them to the image, changing the name of each link to match the name of the desired plugin.

For example, if your binary is ark-awesome-plugins, you could create hard/symoblic links ark-objectstore-mycloud and ark-blockstore-mycloud that both point to ark-awesome-plugins.

In the future, we do hope to make it easier to register a multi-plugin binary with Ark - stay tuned!