New to Stash? Please start here.
This document is intended to be the canonical source of truth for things like supported toolchain versions for building Stash. If you find a requirement that this doc does not capture, please submit an issue on github.
This document is intended to be relative to the branch in which it is found. It is guaranteed that requirements will change over time for the development branch, but release branches of Stash should not change.
Some of the Stash development helper scripts rely on a fairly up-to-date GNU tools environment, so most recent Linux distros should work just fine out-of-the-box.
Stash is written in Google’s GO programming language. Currently, Stash is developed and tested on go 1.9.2. If you haven’t set up a GO development environment, please follow these instructions to install GO.
$ go get github.com/appscode/stash $ cd $(go env GOPATH)/src/github.com/appscode/stash
Install Dev tools
To install various dev tools for Stash, run the following command:
$ ./hack/make.py $ stash version
Run Binary Locally
$ stash run \ --secure-port=8443 \ --kubeconfig="$HOME/.kube/config" \ --authorization-kubeconfig="$HOME/.kube/config" \ --authentication-kubeconfig="$HOME/.kube/config" \ --authentication-skip-lookup
Stash uses Glide to manage dependencies. Dependencies are already checked in the
If you want to update/add dependencies, run:
$ glide slow
Build Docker images
To build and push your custom Docker image, follow the steps below. To release a new version of Stash, please follow the release guide.
# Build Docker image $ ./hack/docker/setup.sh; ./hack/docker/setup.sh push # Add docker tag for your repository $ docker tag appscode/stash:<tag> <image>:<tag> # Push Image $ docker push <image>:<tag>
Generate CLI Reference Docs
$ ./hack/make.py test unit
Run e2e tests
Stash uses Ginkgo to run e2e tests.
$ ./hack/make.py test e2e
To run e2e tests against remote backends, you need to set cloud provider credentials in
./hack/config/.env. You can see an example file in