helm

Documentation

Index

• Constants
• Variables
• func ChartToProto(ch *chartutil.Chart) (chpb *chartpbs.Chart, err error)
• func GetReleaseContent(name string) (*services.GetReleaseContentResponse, error)
• func GetReleaseStatus(name string) (*services.GetReleaseStatusResponse, error)
• func InstallRelease(rawVals []byte, name string, chStr string, dryRun bool) (*services.InstallReleaseResponse, error)
• func ListReleases(limit int, offset string, sort services.ListSort_SortBy, ...) (*services.ListReleasesResponse, error)
• func MetadataToProto(ch *chartutil.Chart) (*chartpbs.Metadata, error)
• func OverridesToProto(values []byte) *chartpbs.Config
• func TemplatesToProto(ch *chartutil.Chart) (tpls []*chartpbs.Template, err error)
• func UninstallRelease(name string, dryRun bool) (*services.UninstallReleaseResponse, error)
• func UpdateRelease(name string) (*services.UpdateReleaseResponse, error)
• func ValuesToProto(ch *chartutil.Chart) (*chartpbs.Config, error)
• func WalkChartFile(chfi *chartutil.Chart) (*chartObj, error)
• type Error
  • func (e Error) Error() string

Constants

const (
	// ErrNotImplemented indicates that this API is not implemented.
	ErrNotImplemented = Error("helm api not implemented")
	// ErrInvalidSrvAddr indicates an invalid address to the Tiller server.
	ErrInvalidSrvAddr = Error("invalid tiller address")
	// ErrMissingTpls indicates that the templates are missing from a chart.
	ErrMissingTpls = Error("missing chart templates")
	// ErrMissingChart indicates that the Chart.yaml data is missing.
	ErrMissingChart = Error("missing chart metadata")
	// ErrMissingValues indicates that the config values.toml data is missing.
	ErrMissingValues = Error("missing chart values")
)

Variables

var Config = &config{
	ServAddr: ":44134",
	Insecure: true,
}

Config defines a gRPC client's configuration.

Functions

func ChartToProto

func ChartToProto(ch *chartutil.Chart) (chpb *chartpbs.Chart, err error)

ChartToProto converts a chart to its Protobuf struct representation.

func GetReleaseContent

func GetReleaseContent(name string) (*services.GetReleaseContentResponse, error)

GetReleaseContent returns the configuration for a given release.

func GetReleaseStatus

func GetReleaseStatus(name string) (*services.GetReleaseStatusResponse, error)

GetReleaseStatus returns the given release's status.

func InstallRelease

func InstallRelease(rawVals []byte, name string, chStr string, dryRun bool) (*services.InstallReleaseResponse, error)

InstallRelease installs a new chart and returns the release response.

func ListReleases

func ListReleases(limit int, offset string, sort services.ListSort_SortBy, order services.ListSort_SortOrder, filter string) (*services.ListReleasesResponse, error)

ListReleases lists the current releases.

func MetadataToProto

func MetadataToProto(ch *chartutil.Chart) (*chartpbs.Metadata, error)

MetadataToProto converts Chart.yaml data into protocol buffere Metadata.

func OverridesToProto

func OverridesToProto(values []byte) *chartpbs.Config

OverridesToProto converts arbitary TOML override data to Config data.

func TemplatesToProto

func TemplatesToProto(ch *chartutil.Chart) (tpls []*chartpbs.Template, err error)

TemplatesToProto converts chart templates to their protobuf representation.

func UninstallRelease

func UninstallRelease(name string, dryRun bool) (*services.UninstallReleaseResponse, error)

UninstallRelease uninstalls a named release and returns the response.

func UpdateRelease

func UpdateRelease(name string) (*services.UpdateReleaseResponse, error)

UpdateRelease updates a release to a new/different chart. TODO: This must take more than just name for an arg.

func ValuesToProto

func ValuesToProto(ch *chartutil.Chart) (*chartpbs.Config, error)

ValuesToProto converts a chart's values.toml data to protobuf.

func WalkChartFile

func WalkChartFile(chfi *chartutil.Chart) (*chartObj, error)

WalkChartFile walks a chart and returns a *chartObj.

FIXME: Why does an exported function return an unexported struct whose only exported method is to return the object passed into this method?

Types

type Error

type Error string

Error represents a Helm client error.

func (Error) Error

func (e Error) Error() string

Error returns a string representation of this error.