chart

Documentation

Overview

Package chart is a generated protocol buffer package.

It is generated from these files:

hapi/chart/chart.proto
hapi/chart/config.proto
hapi/chart/metadata.proto
hapi/chart/template.proto

It has these top-level messages:

Chart
Config
Value
Maintainer
Metadata
Template

Index

• Variables
• type Chart
  • func (*Chart) Descriptor() ([]byte, []int)
  • func (m *Chart) GetDependencies() []*Chart
  • func (m *Chart) GetFiles() []*google_protobuf.Any
  • func (m *Chart) GetMetadata() *Metadata
  • func (m *Chart) GetTemplates() []*Template
  • func (m *Chart) GetValues() *Config
  • func (*Chart) ProtoMessage()
  • func (m *Chart) Reset()
  • func (m *Chart) String() string
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (m *Config) GetValues() map[string]*Value
  • func (*Config) ProtoMessage()
  • func (m *Config) Reset()
  • func (m *Config) String() string
• type Maintainer
  • func (*Maintainer) Descriptor() ([]byte, []int)
  • func (*Maintainer) ProtoMessage()
  • func (m *Maintainer) Reset()
  • func (m *Maintainer) String() string
• type Metadata
  • func (*Metadata) Descriptor() ([]byte, []int)
  • func (m *Metadata) GetMaintainers() []*Maintainer
  • func (*Metadata) ProtoMessage()
  • func (m *Metadata) Reset()
  • func (m *Metadata) String() string
• type Metadata_Engine
  • func (Metadata_Engine) EnumDescriptor() ([]byte, []int)
  • func (x Metadata_Engine) String() string
• type Template
  • func (*Template) Descriptor() ([]byte, []int)
  • func (*Template) ProtoMessage()
  • func (m *Template) Reset()
  • func (m *Template) String() string
• type Value
  • func (*Value) Descriptor() ([]byte, []int)
  • func (*Value) ProtoMessage()
  • func (m *Value) Reset()
  • func (m *Value) String() string

Variables

var Metadata_Engine_name = map[int32]string{
	0: "UNKNOWN",
	1: "GOTPL",
}

var Metadata_Engine_value = map[string]int32{
	"UNKNOWN": 0,
	"GOTPL":   1,
}

Types

type Chart

type Chart struct {
	// Contents of the Chartfile.
	Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// Templates for this chart.
	Templates []*Template `protobuf:"bytes,2,rep,name=templates" json:"templates,omitempty"`
	// Charts that this chart depends on.
	Dependencies []*Chart `protobuf:"bytes,3,rep,name=dependencies" json:"dependencies,omitempty"`
	// Default config for this template.
	Values *Config `protobuf:"bytes,4,opt,name=values" json:"values,omitempty"`
	// Miscellaneous files in a chart archive,
	// e.g. README, LICENSE, etc.
	Files []*google_protobuf.Any `protobuf:"bytes,5,rep,name=files" json:"files,omitempty"`
}

Chart is a helm package that contains metadata, a default config, zero or more optionally parameterizable templates, and zero or more charts (dependencies).

func (*Chart) Descriptor

func (*Chart) Descriptor() ([]byte, []int)

func (*Chart) GetDependencies

func (m *Chart) GetDependencies() []*Chart

func (*Chart) GetFiles

func (m *Chart) GetFiles() []*google_protobuf.Any

func (*Chart) GetMetadata

func (m *Chart) GetMetadata() *Metadata

func (*Chart) GetTemplates

func (m *Chart) GetTemplates() []*Template

func (*Chart) GetValues

func (m *Chart) GetValues() *Config

func (*Chart) ProtoMessage

func (*Chart) ProtoMessage()

func (*Chart) Reset

func (m *Chart) Reset()

func (*Chart) String

func (m *Chart) String() string

type Config

type Config struct {
	Raw    string            `protobuf:"bytes,1,opt,name=raw" json:"raw,omitempty"`
	Values map[string]*Value `` /* 132-byte string literal not displayed */
}

Config supplies values to the parametrizable templates of a chart.

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

func (*Config) GetValues

func (m *Config) GetValues() map[string]*Value

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (m *Config) Reset()

func (*Config) String

func (m *Config) String() string

type Maintainer

type Maintainer struct {
	// Name is a user name or organization name
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Email is an optional email address to contact the named maintainer
	Email string `protobuf:"bytes,2,opt,name=email" json:"email,omitempty"`
}

Maintainer describes a Chart maintainer.

func (*Maintainer) Descriptor

func (*Maintainer) Descriptor() ([]byte, []int)

func (*Maintainer) ProtoMessage

func (*Maintainer) ProtoMessage()

func (*Maintainer) Reset

func (m *Maintainer) Reset()

func (*Maintainer) String

func (m *Maintainer) String() string

type Metadata

type Metadata struct {
	// The name of the chart
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// 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"`
	// A SemVer 2 conformant version string of the chart
	Version string `protobuf:"bytes,4,opt,name=version" json:"version,omitempty"`
	// A one-sentence description of the chart
	Description string `protobuf:"bytes,5,opt,name=description" json:"description,omitempty"`
	// A list of string keywords
	Keywords []string `protobuf:"bytes,6,rep,name=keywords" json:"keywords,omitempty"`
	// A list of name and URL/email address combinations for the maintainer(s)
	Maintainers []*Maintainer `protobuf:"bytes,7,rep,name=maintainers" json:"maintainers,omitempty"`
	// The name of the template engine to use. Defaults to 'gotpl'.
	Engine string `protobuf:"bytes,8,opt,name=engine" json:"engine,omitempty"`
	// The URL to an icon file.
	Icon string `protobuf:"bytes,9,opt,name=icon" json:"icon,omitempty"`
	// The API Version of this chart.
	ApiVersion string `protobuf:"bytes,10,opt,name=apiVersion" json:"apiVersion,omitempty"`
}

Metadata for a Chart file. This models the structure of a Chart.yaml file.

Spec: https://k8s.io/helm/blob/master/docs/design/chart_format.md#the-chart-file

func (*Metadata) Descriptor

func (*Metadata) Descriptor() ([]byte, []int)

func (*Metadata) GetMaintainers

func (m *Metadata) GetMaintainers() []*Maintainer

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) Reset

func (m *Metadata) Reset()

func (*Metadata) String

func (m *Metadata) String() string

type Metadata_Engine

type Metadata_Engine int32

const (
	Metadata_UNKNOWN Metadata_Engine = 0
	Metadata_GOTPL   Metadata_Engine = 1
)

func (Metadata_Engine) EnumDescriptor

func (Metadata_Engine) EnumDescriptor() ([]byte, []int)

func (Metadata_Engine) String

func (x Metadata_Engine) String() string

type Template

type Template struct {
	// Name is the path-like name of the template.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Data is the template as byte data.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
}

Template represents a template as a name/value pair.

By convention, name is a relative path within the scope of the chart's base directory.

func (*Template) Descriptor

func (*Template) Descriptor() ([]byte, []int)

func (*Template) ProtoMessage

func (*Template) ProtoMessage()

func (*Template) Reset

func (m *Template) Reset()

func (*Template) String

func (m *Template) String() string

type Value

type Value struct {
	Value string `protobuf:"bytes,1,opt,name=value" json:"value,omitempty"`
}

Value describes a configuration value as a string.

func (*Value) Descriptor

func (*Value) Descriptor() ([]byte, []int)

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) Reset

func (m *Value) Reset()

func (*Value) String

func (m *Value) String() string