From 3ddacb6b4b8b226396db900eb401117f16462580 Mon Sep 17 00:00:00 2001 From: Matt Butcher Date: Tue, 10 May 2016 16:55:49 -0600 Subject: [PATCH] fix(proto): fix style issues and documentation This fixes indentation, documentation, and removes unused protobuf files. --- _proto/hapi/chart/chart.proto | 11 +- _proto/hapi/chart/config.proto | 16 +-- _proto/hapi/chart/metadata.proto | 27 ++--- _proto/hapi/chart/template.proto | 2 +- _proto/hapi/release/info.proto | 15 ++- _proto/hapi/release/release.proto | 14 +-- _proto/hapi/release/status.proto | 21 ++-- _proto/hapi/services/probe.proto | 16 --- _proto/hapi/services/tiller.proto | 106 ++++++-------------- docs/developers.md | 5 + pkg/proto/hapi/chart/chart.pb.go | 7 +- pkg/proto/hapi/chart/config.pb.go | 12 +-- pkg/proto/hapi/chart/metadata.pb.go | 17 +--- pkg/proto/hapi/release/info.pb.go | 5 +- pkg/proto/hapi/release/release.pb.go | 8 +- pkg/proto/hapi/release/status.pb.go | 5 +- pkg/proto/hapi/services/probe.pb.go | 145 --------------------------- pkg/proto/hapi/services/tiller.pb.go | 136 +++++++++++-------------- 18 files changed, 145 insertions(+), 423 deletions(-) delete mode 100644 _proto/hapi/services/probe.proto delete mode 100644 pkg/proto/hapi/services/probe.pb.go diff --git a/_proto/hapi/chart/chart.proto b/_proto/hapi/chart/chart.proto index 90e4938cc..02c51a994 100644 --- a/_proto/hapi/chart/chart.proto +++ b/_proto/hapi/chart/chart.proto @@ -8,11 +8,8 @@ import "hapi/chart/template.proto"; option go_package = "chart"; -// -// Chart: -// A chart is a helm package that contains metadata, a default config, zero or more -// optionally parameterizable templates, and zero or more charts (dependencies). -// +// Chart is a helm package that contains metadata, a default config, zero or more +// optionally parameterizable templates, and zero or more charts (dependencies). message Chart { // Contents of the Chartfile. hapi.chart.Metadata metadata = 1; @@ -23,7 +20,7 @@ message Chart { // Charts that this chart depends on. repeated Chart dependencies = 3; - // Default config for this template. - hapi.chart.Config values = 4; + // Default config for this template. + hapi.chart.Config values = 4; } diff --git a/_proto/hapi/chart/config.proto b/_proto/hapi/chart/config.proto index 0829632ac..6d0291f0c 100644 --- a/_proto/hapi/chart/config.proto +++ b/_proto/hapi/chart/config.proto @@ -4,22 +4,14 @@ package hapi.chart; option go_package = "chart"; -// -// Config: -// -// A config supplies values to the parametrizable templates of a chart. -// +// Config supplies values to the parametrizable templates of a chart. message Config { - string raw = 1; + string raw = 1; - map values = 2; + map values = 2; } -// -// Value: -// -// TODO -// +// Value describes a configuration value as a string. message Value { string value = 1; } diff --git a/_proto/hapi/chart/metadata.proto b/_proto/hapi/chart/metadata.proto index 08e03985d..aeb92e7b8 100644 --- a/_proto/hapi/chart/metadata.proto +++ b/_proto/hapi/chart/metadata.proto @@ -4,11 +4,7 @@ package hapi.chart; option go_package = "chart"; -// -// Maintainer: -// -// A descriptor of the Chart maintainer(s). -// +// Maintainer describes a Chart maintainer. message Maintainer { // Name is a user name or organization name string name = 1; @@ -17,33 +13,28 @@ message Maintainer { string email = 2; } +// Metadata for a Chart file. This models the structure of a Chart.yaml file. // -// Metadata: -// -// Metadata for a Chart file. This models the structure -// of a Chart.yaml file. -// -// Spec: https://github.com/kubernetes/helm/blob/master/docs/design/chart_format.md#the-chart-file -// +// Spec: https://github.com/kubernetes/helm/blob/master/docs/design/chart_format.md#the-chart-file message Metadata { // The name of the chart string name = 1; - - // The URL to a relecant project page, git repo, or contact person + + // The URL to a relevant project page, git repo, or contact person string home = 2; // Source is the URL to the source code of this chart repeated string sources = 3; - + // A SemVer 2 conformant version string of the chart string version = 4; - + // A one-sentence description of the chart string description = 5; - + // A list of string keywords repeated string keywords = 6; - + // A list of name and URL/email address combinations for the maintainer(s) repeated Maintainer maintainers = 7; } diff --git a/_proto/hapi/chart/template.proto b/_proto/hapi/chart/template.proto index 3e68113c2..c9d834a39 100644 --- a/_proto/hapi/chart/template.proto +++ b/_proto/hapi/chart/template.proto @@ -9,7 +9,7 @@ option go_package = "chart"; // By convention, name is a relative path within the scope of the chart's // base directory. message Template { - // Name is the path-like name of the template. + // Name is the path-like name of the template. string name = 1; // Data is the template as byte data. diff --git a/_proto/hapi/release/info.proto b/_proto/hapi/release/info.proto index 382f4acfc..bfa63a609 100644 --- a/_proto/hapi/release/info.proto +++ b/_proto/hapi/release/info.proto @@ -7,17 +7,14 @@ import "hapi/release/status.proto"; option go_package = "release"; -// -// Info: -// -// +// Info describes release information. message Info { - Status status = 1; + Status status = 1; - google.protobuf.Timestamp first_deployed = 2; + google.protobuf.Timestamp first_deployed = 2; - google.protobuf.Timestamp last_deployed = 3; + google.protobuf.Timestamp last_deployed = 3; - // Deleted tracks when this object was deleted. - google.protobuf.Timestamp deleted = 4; + // Deleted tracks when this object was deleted. + google.protobuf.Timestamp deleted = 4; } diff --git a/_proto/hapi/release/release.proto b/_proto/hapi/release/release.proto index 52ba2cd44..1532dfeed 100644 --- a/_proto/hapi/release/release.proto +++ b/_proto/hapi/release/release.proto @@ -8,12 +8,8 @@ import "hapi/chart/chart.proto"; option go_package = "release"; -// -// Release: -// -// A release describes a deployment of a chart, together with the chart -// and the variables used to deploy that chart. -// +// Release describes a deployment of a chart, together with the chart +// and the variables used to deploy that chart. message Release { // Name is the name of the release string name = 1; @@ -25,9 +21,9 @@ message Release { hapi.chart.Chart chart = 3; // Config is the set of extra Values added to the chart. - // These values override the default values inside of the chart. + // These values override the default values inside of the chart. hapi.chart.Config config = 4; - // Manifest is the string representation of the rendered template. - string manifest = 5; + // Manifest is the string representation of the rendered template. + string manifest = 5; } diff --git a/_proto/hapi/release/status.proto b/_proto/hapi/release/status.proto index c75033e8a..b74b876a7 100644 --- a/_proto/hapi/release/status.proto +++ b/_proto/hapi/release/status.proto @@ -6,25 +6,22 @@ import "google/protobuf/any.proto"; option go_package = "release"; -// -// Status: -// -// +// Status defines the status of a release. message Status { enum Code { - // Status_UNKNOWN indicates that a release is in an uncertain state. + // Status_UNKNOWN indicates that a release is in an uncertain state. UNKNOWN = 0; - // Status_DEPLOYED indicates that the release has been pushed to Kubernetes. + // Status_DEPLOYED indicates that the release has been pushed to Kubernetes. DEPLOYED = 1; - // Status_DELETED indicates that a release has been deleted from Kubermetes. + // Status_DELETED indicates that a release has been deleted from Kubermetes. DELETED = 2; - // Status_SUPERSEDED indicates that this release object is outdated and a newer one exists. + // Status_SUPERSEDED indicates that this release object is outdated and a newer one exists. SUPERSEDED = 3; - // Status_FAILED indicates that the release was not successfully deployed. - FAILED = 4; + // Status_FAILED indicates that the release was not successfully deployed. + FAILED = 4; } - + Code code = 1; - + google.protobuf.Any details = 2; } diff --git a/_proto/hapi/services/probe.proto b/_proto/hapi/services/probe.proto deleted file mode 100644 index 062b37bdb..000000000 --- a/_proto/hapi/services/probe.proto +++ /dev/null @@ -1,16 +0,0 @@ -syntax = "proto3"; - -package hapi.services.probe; - -option go_package = "services"; - -service ProbeService { - rpc Ready(ReadyRequest) returns (ReadyResponse) { - } -} - -message ReadyRequest { -} - -message ReadyResponse { -} diff --git a/_proto/hapi/services/tiller.proto b/_proto/hapi/services/tiller.proto index cd5adb958..136d5dc08 100644 --- a/_proto/hapi/services/tiller.proto +++ b/_proto/hapi/services/tiller.proto @@ -9,11 +9,8 @@ import "hapi/release/info.proto"; option go_package = "services"; -// -// ReleaseService: -// -// The service that a helm application uses to mutate, -// query, and manage releases. +// ReleaseService is the service that a helm application uses to mutate, +// query, and manage releases. // // Release: A named installation composed of a chart and // config. At any given time a release has one @@ -26,66 +23,45 @@ option go_package = "services"; // metadata, a default config, zero or more // optionally parameterizable templates, and // zero or more charts (dependencies). -// -// service ReleaseService { - // - // Retrieve release history. TODO: Allow filtering the set of releases by + // ListReleases retrieves release history. + // TODO: Allow filtering the set of releases by // release status. By default, ListAllReleases returns the releases who // current status is "Active". - // rpc ListReleases(ListReleasesRequest) returns (stream ListReleasesResponse) { } - - // - // Retrieve status information for the specified release. - // + + // GetReleasesStatus retrieves status information for the specified release. rpc GetReleaseStatus(GetReleaseStatusRequest) returns (GetReleaseStatusResponse) { } - - // - // Retrieve the release content (chart + value) for the specifed release. - // + + // GetReleaseContent retrieves the release content (chart + value) for the specifed release. rpc GetReleaseContent(GetReleaseContentRequest) returns (GetReleaseContentResponse) { } - // - // Update release content. - // + // UpdateRelease updates release content. rpc UpdateRelease(UpdateReleaseRequest) returns (UpdateReleaseResponse) { } - // - // Request release install. - // + // InstallRelease requests installation of a chart as a new release. rpc InstallRelease(InstallReleaseRequest) returns (InstallReleaseResponse) { } - - // - // Request release deletion. - // + + // UninstallRelease requests deletion of a named release. rpc UninstallRelease(UninstallReleaseRequest) returns (UninstallReleaseResponse) { } } -// -// ListReleasesRequest: -// -// TODO -// +// ListReleasesRequest requests a list of releases. message ListReleasesRequest { // The maximum number of releases to be returned int64 limit = 1; - - // The zero-based offset at which the returned release list begins + + // The zero-based offset at which the returned release list begins int64 offset = 2; } -// -// ListReleasesResponse: -// -// TODO -// +// ListReleasesResponse is a list of releases. message ListReleasesResponse { // The expected total number of releases to be returned int64 count = 1; @@ -127,55 +103,39 @@ message GetReleaseContentResponse { hapi.release.Release release = 1; } -// -// UpdateReleaseRequest: -// -// TODO -// +// UpdateReleaseRequest updates a release. message UpdateReleaseRequest { } -// -// UpdateReleaseResponse: -// -// TODO -// +// UpdateReleaseResponse is the response to an update request. message UpdateReleaseResponse { } -// -// InstallReleaseRequest: -// -// TODO -// +// InstallReleaseRequest is the request for an installation of a chart. message InstallReleaseRequest { - // Chart is the protobuf representation of a chart. - hapi.chart.Chart chart = 1; - // Values is a string containing (unparsed) TOML values. - hapi.chart.Config values = 2; - // DryRun, if true, will run through the release logic, but neither create - // a release object nor deploy to Kubernetes. The release object returned - // in the response will be fake. - bool dry_run = 3; + // Chart is the protobuf representation of a chart. + hapi.chart.Chart chart = 1; + // Values is a string containing (unparsed) TOML values. + hapi.chart.Config values = 2; + // DryRun, if true, will run through the release logic, but neither create + // a release object nor deploy to Kubernetes. The release object returned + // in the response will be fake. + bool dry_run = 3; } -// -// InstallReleaseResponse: -// -// TODO -// +// InstallReleaseResponse is the response from a release installation. message InstallReleaseResponse { - hapi.release.Release release = 1; + hapi.release.Release release = 1; } // UninstallReleaseRequest represents a request to uninstall a named release. message UninstallReleaseRequest { - // Name is the name of the release to delete. - string name = 1; + // Name is the name of the release to delete. + string name = 1; } // UninstallReleaseResponse represents a successful response to an uninstall request. message UninstallReleaseResponse { - // Release is the release that was marked deleted. - hapi.release.Release release = 1; + // Release is the release that was marked deleted. + hapi.release.Release release = 1; } diff --git a/docs/developers.md b/docs/developers.md index 0d252c356..c8f111788 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -41,6 +41,11 @@ Helm and Tiller communicate using gRPC. To get started with gRPC, you will need Note that you need to be on protobuf 3.x (`protoc --version`) and use the latest Go plugin. +While the gRPC and ProtoBuf specs remain silent on indentation, we +require that the indentation style matches the Go format specification. +Namely, protocol buffers should use tab-based indentation and rpc +declarations should follow the style of Go function declarations. + ### The Helm API (HAPI) We use gRPC as an API layer. See `pkg/proto/hapi` for the generated Go code, diff --git a/pkg/proto/hapi/chart/chart.pb.go b/pkg/proto/hapi/chart/chart.pb.go index ee27d39f5..d1c8f1c4e 100644 --- a/pkg/proto/hapi/chart/chart.pb.go +++ b/pkg/proto/hapi/chart/chart.pb.go @@ -34,11 +34,8 @@ var _ = math.Inf // is compatible with the proto package it is being compiled against. const _ = proto.ProtoPackageIsVersion1 -// -// Chart: -// A chart is a helm package that contains metadata, a default config, zero or more -// optionally parameterizable templates, and zero or more charts (dependencies). -// +// Chart is a helm package that contains metadata, a default config, zero or more +// optionally parameterizable templates, and zero or more charts (dependencies). type Chart struct { // Contents of the Chartfile. Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` diff --git a/pkg/proto/hapi/chart/config.pb.go b/pkg/proto/hapi/chart/config.pb.go index e4cd27998..c53bf71af 100644 --- a/pkg/proto/hapi/chart/config.pb.go +++ b/pkg/proto/hapi/chart/config.pb.go @@ -13,11 +13,7 @@ var _ = proto.Marshal var _ = fmt.Errorf var _ = math.Inf -// -// Config: -// -// A config supplies values to the parametrizable templates of a chart. -// +// Config supplies values to the parametrizable templates of a chart. type Config struct { Raw string `protobuf:"bytes,1,opt,name=raw" json:"raw,omitempty"` Values map[string]*Value `protobuf:"bytes,2,rep,name=values" json:"values,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` @@ -35,11 +31,7 @@ func (m *Config) GetValues() map[string]*Value { return nil } -// -// Value: -// -// TODO -// +// Value describes a configuration value as a string. type Value struct { Value string `protobuf:"bytes,1,opt,name=value" json:"value,omitempty"` } diff --git a/pkg/proto/hapi/chart/metadata.pb.go b/pkg/proto/hapi/chart/metadata.pb.go index 42f16e125..ceaa7914b 100644 --- a/pkg/proto/hapi/chart/metadata.pb.go +++ b/pkg/proto/hapi/chart/metadata.pb.go @@ -13,11 +13,7 @@ var _ = proto.Marshal var _ = fmt.Errorf var _ = math.Inf -// -// Maintainer: -// -// A descriptor of the Chart maintainer(s). -// +// Maintainer describes a Chart maintainer. type Maintainer struct { // Name is a user name or organization name Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` @@ -30,18 +26,13 @@ func (m *Maintainer) String() string { return proto.CompactTextString func (*Maintainer) ProtoMessage() {} func (*Maintainer) Descriptor() ([]byte, []int) { return fileDescriptor2, []int{0} } +// Metadata for a Chart file. This models the structure of a Chart.yaml file. // -// Metadata: -// -// Metadata for a Chart file. This models the structure -// of a Chart.yaml file. -// -// Spec: https://github.com/kubernetes/helm/blob/master/docs/design/chart_format.md#the-chart-file -// +// Spec: https://github.com/kubernetes/helm/blob/master/docs/design/chart_format.md#the-chart-file type Metadata struct { // The name of the chart Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` - // The URL to a relecant project page, git repo, or contact person + // The URL to a relevant project page, git repo, or contact person Home string `protobuf:"bytes,2,opt,name=home" json:"home,omitempty"` // Source is the URL to the source code of this chart Sources []string `protobuf:"bytes,3,rep,name=sources" json:"sources,omitempty"` diff --git a/pkg/proto/hapi/release/info.pb.go b/pkg/proto/hapi/release/info.pb.go index 4c3d8ed7c..9812997f4 100644 --- a/pkg/proto/hapi/release/info.pb.go +++ b/pkg/proto/hapi/release/info.pb.go @@ -31,10 +31,7 @@ var _ = math.Inf // is compatible with the proto package it is being compiled against. const _ = proto.ProtoPackageIsVersion1 -// -// Info: -// -// +// Info describes release information. type Info struct { Status *Status `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` FirstDeployed *google_protobuf.Timestamp `protobuf:"bytes,2,opt,name=first_deployed,json=firstDeployed" json:"first_deployed,omitempty"` diff --git a/pkg/proto/hapi/release/release.pb.go b/pkg/proto/hapi/release/release.pb.go index 6608f64a9..f3a737f52 100644 --- a/pkg/proto/hapi/release/release.pb.go +++ b/pkg/proto/hapi/release/release.pb.go @@ -15,12 +15,8 @@ var _ = proto.Marshal var _ = fmt.Errorf var _ = math.Inf -// -// Release: -// -// A release describes a deployment of a chart, together with the chart -// and the variables used to deploy that chart. -// +// Release describes a deployment of a chart, together with the chart +// and the variables used to deploy that chart. type Release struct { // Name is the name of the release Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` diff --git a/pkg/proto/hapi/release/status.pb.go b/pkg/proto/hapi/release/status.pb.go index 51ed1bf86..d64e4a0ae 100644 --- a/pkg/proto/hapi/release/status.pb.go +++ b/pkg/proto/hapi/release/status.pb.go @@ -49,10 +49,7 @@ func (x Status_Code) String() string { } func (Status_Code) EnumDescriptor() ([]byte, []int) { return fileDescriptor2, []int{0, 0} } -// -// Status: -// -// +// Status defines the status of a release. type Status struct { Code Status_Code `protobuf:"varint,1,opt,name=code,enum=hapi.release.Status_Code" json:"code,omitempty"` Details *google_protobuf1.Any `protobuf:"bytes,2,opt,name=details" json:"details,omitempty"` diff --git a/pkg/proto/hapi/services/probe.pb.go b/pkg/proto/hapi/services/probe.pb.go deleted file mode 100644 index 60b432820..000000000 --- a/pkg/proto/hapi/services/probe.pb.go +++ /dev/null @@ -1,145 +0,0 @@ -// Code generated by protoc-gen-go. -// source: hapi/services/probe.proto -// DO NOT EDIT! - -/* -Package services is a generated protocol buffer package. - -It is generated from these files: - hapi/services/probe.proto - hapi/services/tiller.proto - -It has these top-level messages: - ReadyRequest - ReadyResponse - ListReleasesRequest - ListReleasesResponse - GetReleaseStatusRequest - GetReleaseStatusResponse - GetReleaseContentRequest - GetReleaseContentResponse - UpdateReleaseRequest - UpdateReleaseResponse - InstallReleaseRequest - InstallReleaseResponse - UninstallReleaseRequest - UninstallReleaseResponse -*/ -package services - -import proto "github.com/golang/protobuf/proto" -import fmt "fmt" -import math "math" - -import ( - context "golang.org/x/net/context" - grpc "google.golang.org/grpc" -) - -// Reference imports to suppress errors if they are not otherwise used. -var _ = proto.Marshal -var _ = fmt.Errorf -var _ = math.Inf - -// This is a compile-time assertion to ensure that this generated file -// is compatible with the proto package it is being compiled against. -const _ = proto.ProtoPackageIsVersion1 - -type ReadyRequest struct { -} - -func (m *ReadyRequest) Reset() { *m = ReadyRequest{} } -func (m *ReadyRequest) String() string { return proto.CompactTextString(m) } -func (*ReadyRequest) ProtoMessage() {} -func (*ReadyRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{0} } - -type ReadyResponse struct { -} - -func (m *ReadyResponse) Reset() { *m = ReadyResponse{} } -func (m *ReadyResponse) String() string { return proto.CompactTextString(m) } -func (*ReadyResponse) ProtoMessage() {} -func (*ReadyResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{1} } - -func init() { - proto.RegisterType((*ReadyRequest)(nil), "hapi.services.probe.ReadyRequest") - proto.RegisterType((*ReadyResponse)(nil), "hapi.services.probe.ReadyResponse") -} - -// Reference imports to suppress errors if they are not otherwise used. -var _ context.Context -var _ grpc.ClientConn - -// This is a compile-time assertion to ensure that this generated file -// is compatible with the grpc package it is being compiled against. -const _ = grpc.SupportPackageIsVersion1 - -// Client API for ProbeService service - -type ProbeServiceClient interface { - Ready(ctx context.Context, in *ReadyRequest, opts ...grpc.CallOption) (*ReadyResponse, error) -} - -type probeServiceClient struct { - cc *grpc.ClientConn -} - -func NewProbeServiceClient(cc *grpc.ClientConn) ProbeServiceClient { - return &probeServiceClient{cc} -} - -func (c *probeServiceClient) Ready(ctx context.Context, in *ReadyRequest, opts ...grpc.CallOption) (*ReadyResponse, error) { - out := new(ReadyResponse) - err := grpc.Invoke(ctx, "/hapi.services.probe.ProbeService/Ready", in, out, c.cc, opts...) - if err != nil { - return nil, err - } - return out, nil -} - -// Server API for ProbeService service - -type ProbeServiceServer interface { - Ready(context.Context, *ReadyRequest) (*ReadyResponse, error) -} - -func RegisterProbeServiceServer(s *grpc.Server, srv ProbeServiceServer) { - s.RegisterService(&_ProbeService_serviceDesc, srv) -} - -func _ProbeService_Ready_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error) (interface{}, error) { - in := new(ReadyRequest) - if err := dec(in); err != nil { - return nil, err - } - out, err := srv.(ProbeServiceServer).Ready(ctx, in) - if err != nil { - return nil, err - } - return out, nil -} - -var _ProbeService_serviceDesc = grpc.ServiceDesc{ - ServiceName: "hapi.services.probe.ProbeService", - HandlerType: (*ProbeServiceServer)(nil), - Methods: []grpc.MethodDesc{ - { - MethodName: "Ready", - Handler: _ProbeService_Ready_Handler, - }, - }, - Streams: []grpc.StreamDesc{}, -} - -var fileDescriptor0 = []byte{ - // 131 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x09, 0x6e, 0x88, 0x02, 0xff, 0xe2, 0x92, 0xcc, 0x48, 0x2c, 0xc8, - 0xd4, 0x2f, 0x4e, 0x2d, 0x2a, 0xcb, 0x4c, 0x4e, 0x2d, 0xd6, 0x2f, 0x28, 0xca, 0x4f, 0x4a, 0xd5, - 0x03, 0x92, 0x25, 0xf9, 0x42, 0xc2, 0x20, 0x29, 0x3d, 0x98, 0x94, 0x1e, 0x58, 0x4a, 0x89, 0x8f, - 0x8b, 0x27, 0x28, 0x35, 0x31, 0xa5, 0x32, 0x28, 0xb5, 0xb0, 0x34, 0xb5, 0xb8, 0x44, 0x89, 0x9f, - 0x8b, 0x17, 0xca, 0x2f, 0x2e, 0xc8, 0xcf, 0x2b, 0x4e, 0x35, 0x4a, 0xe0, 0xe2, 0x09, 0x00, 0xa9, - 0x0c, 0x86, 0xe8, 0x13, 0x0a, 0xe0, 0x62, 0x05, 0x2b, 0x10, 0x52, 0xd4, 0xc3, 0x62, 0x9e, 0x1e, - 0xb2, 0x61, 0x52, 0x4a, 0xf8, 0x94, 0x40, 0xcc, 0x57, 0x62, 0x70, 0xe2, 0x8a, 0xe2, 0x80, 0xa9, - 0x48, 0x62, 0x03, 0x3b, 0xd5, 0x18, 0x10, 0x00, 0x00, 0xff, 0xff, 0x65, 0x03, 0x07, 0x01, 0xc7, - 0x00, 0x00, 0x00, -} diff --git a/pkg/proto/hapi/services/tiller.pb.go b/pkg/proto/hapi/services/tiller.pb.go index 6a4618645..1e81348eb 100644 --- a/pkg/proto/hapi/services/tiller.pb.go +++ b/pkg/proto/hapi/services/tiller.pb.go @@ -2,6 +2,26 @@ // source: hapi/services/tiller.proto // DO NOT EDIT! +/* +Package services is a generated protocol buffer package. + +It is generated from these files: + hapi/services/tiller.proto + +It has these top-level messages: + ListReleasesRequest + ListReleasesResponse + GetReleaseStatusRequest + GetReleaseStatusResponse + GetReleaseContentRequest + GetReleaseContentResponse + UpdateReleaseRequest + UpdateReleaseResponse + InstallReleaseRequest + InstallReleaseResponse + UninstallReleaseRequest + UninstallReleaseResponse +*/ package services import proto "github.com/golang/protobuf/proto" @@ -22,11 +42,11 @@ var _ = proto.Marshal var _ = fmt.Errorf var _ = math.Inf -// -// ListReleasesRequest: -// -// TODO -// +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +const _ = proto.ProtoPackageIsVersion1 + +// ListReleasesRequest requests a list of releases. type ListReleasesRequest struct { // The maximum number of releases to be returned Limit int64 `protobuf:"varint,1,opt,name=limit" json:"limit,omitempty"` @@ -37,13 +57,9 @@ type ListReleasesRequest struct { func (m *ListReleasesRequest) Reset() { *m = ListReleasesRequest{} } func (m *ListReleasesRequest) String() string { return proto.CompactTextString(m) } func (*ListReleasesRequest) ProtoMessage() {} -func (*ListReleasesRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{0} } +func (*ListReleasesRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{0} } -// -// ListReleasesResponse: -// -// TODO -// +// ListReleasesResponse is a list of releases. type ListReleasesResponse struct { // The expected total number of releases to be returned Count int64 `protobuf:"varint,1,opt,name=count" json:"count,omitempty"` @@ -58,7 +74,7 @@ type ListReleasesResponse struct { func (m *ListReleasesResponse) Reset() { *m = ListReleasesResponse{} } func (m *ListReleasesResponse) String() string { return proto.CompactTextString(m) } func (*ListReleasesResponse) ProtoMessage() {} -func (*ListReleasesResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{1} } +func (*ListReleasesResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{1} } func (m *ListReleasesResponse) GetReleases() []*hapi_release2.Release { if m != nil { @@ -76,7 +92,7 @@ type GetReleaseStatusRequest struct { func (m *GetReleaseStatusRequest) Reset() { *m = GetReleaseStatusRequest{} } func (m *GetReleaseStatusRequest) String() string { return proto.CompactTextString(m) } func (*GetReleaseStatusRequest) ProtoMessage() {} -func (*GetReleaseStatusRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{2} } +func (*GetReleaseStatusRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{2} } // GetReleaseStatusResponse is the response indicating the status of the named release. type GetReleaseStatusResponse struct { @@ -89,7 +105,7 @@ type GetReleaseStatusResponse struct { func (m *GetReleaseStatusResponse) Reset() { *m = GetReleaseStatusResponse{} } func (m *GetReleaseStatusResponse) String() string { return proto.CompactTextString(m) } func (*GetReleaseStatusResponse) ProtoMessage() {} -func (*GetReleaseStatusResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{3} } +func (*GetReleaseStatusResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{3} } func (m *GetReleaseStatusResponse) GetInfo() *hapi_release1.Info { if m != nil { @@ -107,7 +123,7 @@ type GetReleaseContentRequest struct { func (m *GetReleaseContentRequest) Reset() { *m = GetReleaseContentRequest{} } func (m *GetReleaseContentRequest) String() string { return proto.CompactTextString(m) } func (*GetReleaseContentRequest) ProtoMessage() {} -func (*GetReleaseContentRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{4} } +func (*GetReleaseContentRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{4} } // GetReleaseContentResponse is a response containing the contents of a release. type GetReleaseContentResponse struct { @@ -118,7 +134,7 @@ type GetReleaseContentResponse struct { func (m *GetReleaseContentResponse) Reset() { *m = GetReleaseContentResponse{} } func (m *GetReleaseContentResponse) String() string { return proto.CompactTextString(m) } func (*GetReleaseContentResponse) ProtoMessage() {} -func (*GetReleaseContentResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{5} } +func (*GetReleaseContentResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{5} } func (m *GetReleaseContentResponse) GetRelease() *hapi_release2.Release { if m != nil { @@ -127,37 +143,25 @@ func (m *GetReleaseContentResponse) GetRelease() *hapi_release2.Release { return nil } -// -// UpdateReleaseRequest: -// -// TODO -// +// UpdateReleaseRequest updates a release. type UpdateReleaseRequest struct { } func (m *UpdateReleaseRequest) Reset() { *m = UpdateReleaseRequest{} } func (m *UpdateReleaseRequest) String() string { return proto.CompactTextString(m) } func (*UpdateReleaseRequest) ProtoMessage() {} -func (*UpdateReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{6} } +func (*UpdateReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{6} } -// -// UpdateReleaseResponse: -// -// TODO -// +// UpdateReleaseResponse is the response to an update request. type UpdateReleaseResponse struct { } func (m *UpdateReleaseResponse) Reset() { *m = UpdateReleaseResponse{} } func (m *UpdateReleaseResponse) String() string { return proto.CompactTextString(m) } func (*UpdateReleaseResponse) ProtoMessage() {} -func (*UpdateReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{7} } +func (*UpdateReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{7} } -// -// InstallReleaseRequest: -// -// TODO -// +// InstallReleaseRequest is the request for an installation of a chart. type InstallReleaseRequest struct { // Chart is the protobuf representation of a chart. Chart *hapi_chart3.Chart `protobuf:"bytes,1,opt,name=chart" json:"chart,omitempty"` @@ -172,7 +176,7 @@ type InstallReleaseRequest struct { func (m *InstallReleaseRequest) Reset() { *m = InstallReleaseRequest{} } func (m *InstallReleaseRequest) String() string { return proto.CompactTextString(m) } func (*InstallReleaseRequest) ProtoMessage() {} -func (*InstallReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{8} } +func (*InstallReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{8} } func (m *InstallReleaseRequest) GetChart() *hapi_chart3.Chart { if m != nil { @@ -188,11 +192,7 @@ func (m *InstallReleaseRequest) GetValues() *hapi_chart.Config { return nil } -// -// InstallReleaseResponse: -// -// TODO -// +// InstallReleaseResponse is the response from a release installation. type InstallReleaseResponse struct { Release *hapi_release2.Release `protobuf:"bytes,1,opt,name=release" json:"release,omitempty"` } @@ -200,7 +200,7 @@ type InstallReleaseResponse struct { func (m *InstallReleaseResponse) Reset() { *m = InstallReleaseResponse{} } func (m *InstallReleaseResponse) String() string { return proto.CompactTextString(m) } func (*InstallReleaseResponse) ProtoMessage() {} -func (*InstallReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{9} } +func (*InstallReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{9} } func (m *InstallReleaseResponse) GetRelease() *hapi_release2.Release { if m != nil { @@ -218,7 +218,7 @@ type UninstallReleaseRequest struct { func (m *UninstallReleaseRequest) Reset() { *m = UninstallReleaseRequest{} } func (m *UninstallReleaseRequest) String() string { return proto.CompactTextString(m) } func (*UninstallReleaseRequest) ProtoMessage() {} -func (*UninstallReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{10} } +func (*UninstallReleaseRequest) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{10} } // UninstallReleaseResponse represents a successful response to an uninstall request. type UninstallReleaseResponse struct { @@ -229,7 +229,7 @@ type UninstallReleaseResponse struct { func (m *UninstallReleaseResponse) Reset() { *m = UninstallReleaseResponse{} } func (m *UninstallReleaseResponse) String() string { return proto.CompactTextString(m) } func (*UninstallReleaseResponse) ProtoMessage() {} -func (*UninstallReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor1, []int{11} } +func (*UninstallReleaseResponse) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{11} } func (m *UninstallReleaseResponse) GetRelease() *hapi_release2.Release { if m != nil { @@ -264,31 +264,20 @@ const _ = grpc.SupportPackageIsVersion1 // Client API for ReleaseService service type ReleaseServiceClient interface { - // - // Retrieve release history. TODO: Allow filtering the set of releases by + // ListReleases retrieves release history. + // TODO: Allow filtering the set of releases by // release status. By default, ListAllReleases returns the releases who // current status is "Active". - // ListReleases(ctx context.Context, in *ListReleasesRequest, opts ...grpc.CallOption) (ReleaseService_ListReleasesClient, error) - // - // Retrieve status information for the specified release. - // + // GetReleasesStatus retrieves status information for the specified release. GetReleaseStatus(ctx context.Context, in *GetReleaseStatusRequest, opts ...grpc.CallOption) (*GetReleaseStatusResponse, error) - // - // Retrieve the release content (chart + value) for the specifed release. - // + // GetReleaseContent retrieves the release content (chart + value) for the specifed release. GetReleaseContent(ctx context.Context, in *GetReleaseContentRequest, opts ...grpc.CallOption) (*GetReleaseContentResponse, error) - // - // Update release content. - // + // UpdateRelease updates release content. UpdateRelease(ctx context.Context, in *UpdateReleaseRequest, opts ...grpc.CallOption) (*UpdateReleaseResponse, error) - // - // Request release install. - // + // InstallRelease requests installation of a chart as a new release. InstallRelease(ctx context.Context, in *InstallReleaseRequest, opts ...grpc.CallOption) (*InstallReleaseResponse, error) - // - // Request release deletion. - // + // UninstallRelease requests deletion of a named release. UninstallRelease(ctx context.Context, in *UninstallReleaseRequest, opts ...grpc.CallOption) (*UninstallReleaseResponse, error) } @@ -380,31 +369,20 @@ func (c *releaseServiceClient) UninstallRelease(ctx context.Context, in *Uninsta // Server API for ReleaseService service type ReleaseServiceServer interface { - // - // Retrieve release history. TODO: Allow filtering the set of releases by + // ListReleases retrieves release history. + // TODO: Allow filtering the set of releases by // release status. By default, ListAllReleases returns the releases who // current status is "Active". - // ListReleases(*ListReleasesRequest, ReleaseService_ListReleasesServer) error - // - // Retrieve status information for the specified release. - // + // GetReleasesStatus retrieves status information for the specified release. GetReleaseStatus(context.Context, *GetReleaseStatusRequest) (*GetReleaseStatusResponse, error) - // - // Retrieve the release content (chart + value) for the specifed release. - // + // GetReleaseContent retrieves the release content (chart + value) for the specifed release. GetReleaseContent(context.Context, *GetReleaseContentRequest) (*GetReleaseContentResponse, error) - // - // Update release content. - // + // UpdateRelease updates release content. UpdateRelease(context.Context, *UpdateReleaseRequest) (*UpdateReleaseResponse, error) - // - // Request release install. - // + // InstallRelease requests installation of a chart as a new release. InstallRelease(context.Context, *InstallReleaseRequest) (*InstallReleaseResponse, error) - // - // Request release deletion. - // + // UninstallRelease requests deletion of a named release. UninstallRelease(context.Context, *UninstallReleaseRequest) (*UninstallReleaseResponse, error) } @@ -527,7 +505,7 @@ var _ReleaseService_serviceDesc = grpc.ServiceDesc{ }, } -var fileDescriptor1 = []byte{ +var fileDescriptor0 = []byte{ // 540 bytes of a gzipped FileDescriptorProto 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x09, 0x6e, 0x88, 0x02, 0xff, 0x9c, 0x55, 0xcd, 0x6e, 0xd3, 0x40, 0x10, 0xae, 0x49, 0x9a, 0x86, 0x29, 0x54, 0x74, 0xc8, 0x8f, 0xf1, 0xa9, 0xda, 0x03, 0x94, 0x42,