helm/docs/developers.md

Developers Guide

This guide explains how to set up your environment for developing on Helm and Tiller.

Prerequisites

• Go 1.6.0 or later
• kubectl 1.2 or later
• A Kubernetes cluster (optional)
• The gRPC toolchain

Tiller uses gRPC. To get started with gRPC, you will need to...

• Install protoc for compiling protobuf files. Releases are here
• Install the protoc Go plugin: go get -u github.com/golang/protobuf/protoc-gen-go

Note that you need to be on protobuf 3.x (protoc --version) and use the latest Go plugin.

The Helm API (HAPI)

We use gRPC as an API layer. See pkg/hapi for the generated Go code, and _proto for the protocol buffer definitions.

To regenerate hapi, use go generate pkg/hapi.