Documentation
¶
Index ¶
- Variables
- type Chart
- func (*Chart) Descriptor() ([]byte, []int)
- func (m *Chart) GetDependencies() []*Chart
- func (m *Chart) GetFiles() []*any.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
- func (m *Chart) XXX_DiscardUnknown()
- func (m *Chart) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Chart) XXX_Merge(src proto.Message)
- func (m *Chart) XXX_Size() int
- func (m *Chart) XXX_Unmarshal(b []byte) error
- type Config
- func (*Config) Descriptor() ([]byte, []int)
- func (m *Config) GetRaw() string
- func (m *Config) GetValues() map[string]*Value
- func (*Config) ProtoMessage()
- func (m *Config) Reset()
- func (m *Config) String() string
- func (m *Config) XXX_DiscardUnknown()
- func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Config) XXX_Merge(src proto.Message)
- func (m *Config) XXX_Size() int
- func (m *Config) XXX_Unmarshal(b []byte) error
- type Maintainer
- func (*Maintainer) Descriptor() ([]byte, []int)
- func (m *Maintainer) GetEmail() string
- func (m *Maintainer) GetName() string
- func (m *Maintainer) GetUrl() string
- func (*Maintainer) ProtoMessage()
- func (m *Maintainer) Reset()
- func (m *Maintainer) String() string
- func (m *Maintainer) XXX_DiscardUnknown()
- func (m *Maintainer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Maintainer) XXX_Merge(src proto.Message)
- func (m *Maintainer) XXX_Size() int
- func (m *Maintainer) XXX_Unmarshal(b []byte) error
- type Metadata
- func (*Metadata) Descriptor() ([]byte, []int)
- func (m *Metadata) GetAnnotations() map[string]string
- func (m *Metadata) GetApiVersion() string
- func (m *Metadata) GetAppVersion() string
- func (m *Metadata) GetCondition() string
- func (m *Metadata) GetDeprecated() bool
- func (m *Metadata) GetDescription() string
- func (m *Metadata) GetEngine() string
- func (m *Metadata) GetHome() string
- func (m *Metadata) GetIcon() string
- func (m *Metadata) GetKeywords() []string
- func (m *Metadata) GetKubeVersion() string
- func (m *Metadata) GetMaintainers() []*Maintainer
- func (m *Metadata) GetName() string
- func (m *Metadata) GetSources() []string
- func (m *Metadata) GetTags() string
- func (m *Metadata) GetTillerVersion() string
- func (m *Metadata) GetVersion() string
- func (*Metadata) ProtoMessage()
- func (m *Metadata) Reset()
- func (m *Metadata) String() string
- func (m *Metadata) XXX_DiscardUnknown()
- func (m *Metadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Metadata) XXX_Merge(src proto.Message)
- func (m *Metadata) XXX_Size() int
- func (m *Metadata) XXX_Unmarshal(b []byte) error
- type Metadata_Engine
- type Template
- func (*Template) Descriptor() ([]byte, []int)
- func (m *Template) GetData() []byte
- func (m *Template) GetName() string
- func (*Template) ProtoMessage()
- func (m *Template) Reset()
- func (m *Template) String() string
- func (m *Template) XXX_DiscardUnknown()
- func (m *Template) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Template) XXX_Merge(src proto.Message)
- func (m *Template) XXX_Size() int
- func (m *Template) XXX_Unmarshal(b []byte) error
- type Value
- func (*Value) Descriptor() ([]byte, []int)
- func (m *Value) GetValue() string
- func (*Value) ProtoMessage()
- func (m *Value) Reset()
- func (m *Value) String() string
- func (m *Value) XXX_DiscardUnknown()
- func (m *Value) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Value) XXX_Merge(src proto.Message)
- func (m *Value) XXX_Size() int
- func (m *Value) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var Metadata_Engine_name = map[int32]string{
0: "UNKNOWN",
1: "GOTPL",
}
View Source
var Metadata_Engine_value = map[string]int32{
"UNKNOWN": 0,
"GOTPL": 1,
}
Functions ¶
This section is empty.
Types ¶
type Chart ¶
type Chart struct {
// Contents of the Chartfile.
Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
// Templates for this chart.
Templates []*Template `protobuf:"bytes,2,rep,name=templates,proto3" json:"templates,omitempty"`
// Charts that this chart depends on.
Dependencies []*Chart `protobuf:"bytes,3,rep,name=dependencies,proto3" json:"dependencies,omitempty"`
// Default config for this template.
Values *Config `protobuf:"bytes,4,opt,name=values,proto3" json:"values,omitempty"`
// Miscellaneous files in a chart archive,
// e.g. README, LICENSE, etc.
Files []*any.Any `protobuf:"bytes,5,rep,name=files,proto3" json:"files,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
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) GetMetadata ¶
func (m *Chart) GetMetadata() *Metadata
func (*Chart) GetTemplates ¶
func (m *Chart) GetTemplates() []*Template
func (*Chart) ProtoMessage ¶
func (*Chart) ProtoMessage()
func (*Chart) XXX_DiscardUnknown ¶
func (m *Chart) XXX_DiscardUnknown()
func (*Chart) XXX_Marshal ¶
func (m *Chart) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Chart) XXX_Unmarshal ¶
func (m *Chart) XXX_Unmarshal(b []byte) error
type Config ¶
type Config struct {
Raw string `protobuf:"bytes,1,opt,name=raw,proto3" json:"raw,omitempty"`
Values map[string]*Value `` /* 153-byte string literal not displayed */
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
Config supplies values to the parametrizable templates of a chart.
func (*Config) Descriptor ¶
func (*Config) Descriptor() ([]byte, []int)
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) XXX_DiscardUnknown ¶
func (m *Config) XXX_DiscardUnknown()
func (*Config) XXX_Marshal ¶
func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Config) XXX_Unmarshal ¶
func (m *Config) XXX_Unmarshal(b []byte) error
type Maintainer ¶
type Maintainer struct {
// Name is a user name or organization name
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Email is an optional email address to contact the named maintainer
Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
// Url is an optional URL to an address for the named maintainer
Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
Maintainer describes a Chart maintainer.
func (*Maintainer) Descriptor ¶
func (*Maintainer) Descriptor() ([]byte, []int)
func (*Maintainer) ProtoMessage ¶
func (*Maintainer) ProtoMessage()
func (*Maintainer) XXX_DiscardUnknown ¶
func (m *Maintainer) XXX_DiscardUnknown()
func (*Maintainer) XXX_Marshal ¶
func (m *Maintainer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Maintainer) XXX_Unmarshal ¶
func (m *Maintainer) XXX_Unmarshal(b []byte) error
type Metadata ¶
type Metadata struct {
// The name of the chart
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The URL to a relevant project page, git repo, or contact person
Home string `protobuf:"bytes,2,opt,name=home,proto3" json:"home,omitempty"`
// Source is the URL to the source code of this chart
Sources []string `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
// A SemVer 2 conformant version string of the chart
Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
// A one-sentence description of the chart
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// A list of string keywords
Keywords []string `protobuf:"bytes,6,rep,name=keywords,proto3" json:"keywords,omitempty"`
// A list of name and URL/email address combinations for the maintainer(s)
Maintainers []*Maintainer `protobuf:"bytes,7,rep,name=maintainers,proto3" json:"maintainers,omitempty"`
// The name of the template engine to use. Defaults to 'gotpl'.
Engine string `protobuf:"bytes,8,opt,name=engine,proto3" json:"engine,omitempty"`
// The URL to an icon file.
Icon string `protobuf:"bytes,9,opt,name=icon,proto3" json:"icon,omitempty"`
// The API Version of this chart.
ApiVersion string `protobuf:"bytes,10,opt,name=apiVersion,proto3" json:"apiVersion,omitempty"`
// The condition to check to enable chart
Condition string `protobuf:"bytes,11,opt,name=condition,proto3" json:"condition,omitempty"`
// The tags to check to enable chart
Tags string `protobuf:"bytes,12,opt,name=tags,proto3" json:"tags,omitempty"`
// The version of the application enclosed inside of this chart.
AppVersion string `protobuf:"bytes,13,opt,name=appVersion,proto3" json:"appVersion,omitempty"`
// Whether or not this chart is deprecated
Deprecated bool `protobuf:"varint,14,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
// TillerVersion is a SemVer constraints on what version of Tiller is required.
// See SemVer ranges here: https://github.com/Masterminds/semver#basic-comparisons
TillerVersion string `protobuf:"bytes,15,opt,name=tillerVersion,proto3" json:"tillerVersion,omitempty"`
// Annotations are additional mappings uninterpreted by Tiller,
// made available for inspection by other applications.
Annotations map[string]string `` /* 164-byte string literal not displayed */
// KubeVersion is a SemVer constraint specifying the version of Kubernetes required.
KubeVersion string `protobuf:"bytes,17,opt,name=kubeVersion,proto3" json:"kubeVersion,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
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) GetAnnotations ¶
func (m *Metadata) GetAnnotations() map[string]string
func (*Metadata) GetApiVersion ¶
func (m *Metadata) GetApiVersion() string
func (*Metadata) GetAppVersion ¶
func (m *Metadata) GetAppVersion() string
func (*Metadata) GetCondition ¶
func (m *Metadata) GetCondition() string
func (*Metadata) GetDeprecated ¶
func (m *Metadata) GetDeprecated() bool
func (*Metadata) GetDescription ¶
func (m *Metadata) GetDescription() string
func (*Metadata) GetKeywords ¶
func (m *Metadata) GetKeywords() []string
func (*Metadata) GetKubeVersion ¶
func (m *Metadata) GetKubeVersion() string
func (*Metadata) GetMaintainers ¶
func (m *Metadata) GetMaintainers() []*Maintainer
func (*Metadata) GetSources ¶
func (m *Metadata) GetSources() []string
func (*Metadata) GetTillerVersion ¶
func (m *Metadata) GetTillerVersion() string
func (*Metadata) GetVersion ¶
func (m *Metadata) GetVersion() string
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
func (*Metadata) XXX_DiscardUnknown ¶
func (m *Metadata) XXX_DiscardUnknown()
func (*Metadata) XXX_Marshal ¶
func (m *Metadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Metadata) XXX_Unmarshal ¶
func (m *Metadata) XXX_Unmarshal(b []byte) error
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)
type Template ¶
type Template struct {
// Name is the path-like name of the template.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Data is the template as byte data.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
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) XXX_DiscardUnknown ¶
func (m *Template) XXX_DiscardUnknown()
func (*Template) XXX_Marshal ¶
func (m *Template) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Template) XXX_Unmarshal ¶
func (m *Template) XXX_Unmarshal(b []byte) error
type Value ¶
type Value struct {
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
Value describes a configuration value as a string.
func (*Value) Descriptor ¶
func (*Value) Descriptor() ([]byte, []int)
func (*Value) ProtoMessage ¶
func (*Value) ProtoMessage()
func (*Value) XXX_DiscardUnknown ¶
func (m *Value) XXX_DiscardUnknown()
func (*Value) XXX_Marshal ¶
func (m *Value) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Value) XXX_Unmarshal ¶
func (m *Value) XXX_Unmarshal(b []byte) error
Click to show internal directories.
Click to hide internal directories.