helm/docs/developers.md
Matt Butcher 0868355d3e feat(cmd): add grpc client and server
So far, they just have basic readiness checks.
2016-04-08 16:41:21 -06:00

681 B

Developers Guide

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

Prerequisites

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.