Developer guide

This document explains how to setup your dev environment.

Download Operator SDK

Go to https://github.com/operator-framework/operator-sdk and follow the fork guide to fork, clone, and setup the local operator-sdk repository.

We use dep to manage dependencies. Run the following in the project root directory to update the vendored dependencies:

$ cd $GOPATH/src/github.com/operator-framework/operator-sdk
$ dep ensure

Requirement:

Build the Operator SDK CLI operator-sdk binary:

# TODO: replace this with the ./build script.
$ go install github.com/operator-framework/operator-sdk/commands/operator-sdk

Run unit tests:

TODO: use ./test script