This document is intended to be the canonical source of truth for things like supported toolchain versions for building OSM. 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 OSM should not change.
Some of the OSM 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.
OSM is written in Google's GO programming language. Currently, OSM is developed and tested on go 1.8.3. If you haven't set up a GO development environment, please follow these instructions to install GO.
$ go get github.com/appscode/osm
$ cd $(go env GOPATH)/src/github.com/appscode/osmTo install various dev tools for OSM, run the following command:
# setting up dependencies for compiling osm...
$ ./hack/builddeps.sh$ ./hack/make.py
$ osm version
OSM uses Glide to manage dependencies. Dependencies are already checked in the vendor folder.
If you want to update/add dependencies, run:
$ glide slowTo build and push your custom Docker image, follow the steps below. To release a new version of OSM, 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/osm:<tag> <image>:<tag>
# Push Image
$ docker push <image>:<tag>$ ./hack/gendocs/make.sh