helm

Documentation

Index

• Constants
• Variables
• func GetReleaseContent(rlsName string) (*rls.GetReleaseContentResponse, error)
• func GetReleaseStatus(rlsName string) (*rls.GetReleaseStatusResponse, error)
• func InstallRelease(vals []byte, rlsName, chStr string, dryRun bool) (*rls.InstallReleaseResponse, error)
• func ListReleases(limit int, offset string, sort rls.ListSort_SortBy, ...) (*rls.ListReleasesResponse, error)
• func UninstallRelease(rlsName string, dryRun bool) (*rls.UninstallReleaseResponse, error)
• func UpdateRelease(rlsName string) (*rls.UpdateReleaseResponse, error)
• type Client
  • func NewClient(opts ...Option) *Client
  • func (h *Client) DeleteRelease(rlsName string, opts ...DeleteOption) (*rls.UninstallReleaseResponse, error)
  • func (h *Client) Init() *Client
  • func (h *Client) InstallRelease(chStr string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
  • func (h *Client) ListReleases(opts ...ReleaseListOption) (*rls.ListReleasesResponse, error)
  • func (h *Client) Option(opts ...Option) *Client
  • func (h *Client) ReleaseContent(rlsName string, opts ...ContentOption) (*rls.GetReleaseContentResponse, error)
  • func (h *Client) ReleaseStatus(rlsName string, opts ...StatusOption) (*rls.GetReleaseStatusResponse, error)
  • func (h *Client) UpdateRelease(rlsName string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error)
• type ContentOption
• type DeleteOption
• type InstallOption
  • func ReleaseName(name string) InstallOption
  • func ValueOverrides(raw []byte) InstallOption
• type Option
  • func DryRun() Option
  • func HelmHome(home string) Option
  • func HelmHost(host string) Option
• type ReleaseListOption
  • func ReleaseListFilter(filter string) ReleaseListOption
  • func ReleaseListLimit(limit int) ReleaseListOption
  • func ReleaseListOffset(offset string) ReleaseListOption
  • func ReleaseListOrder(order int32) ReleaseListOption
  • func ReleaseListSort(sort int32) ReleaseListOption
• type StatusOption
• type UpdateOption

Constants

const (
	// $HELM_HOST envvar
	HelmHostEnvVar = "HELM_HOST"

	// $HELM_HOME envvar
	HelmHomeEnvVar = "HELM_HOME"

	// Default tiller server host address.
	DefaultHelmHost = ":44134"

	// Default $HELM_HOME envvar value
	DefaultHelmHome = "$HOME/.helm"
)

Variables

var Config struct {
	ServAddr string
}

Functions

func GetReleaseContent

func GetReleaseContent(rlsName string) (*rls.GetReleaseContentResponse, error)

Soon to be deprecated helm GetReleaseContent API.

func GetReleaseStatus

func GetReleaseStatus(rlsName string) (*rls.GetReleaseStatusResponse, error)

Soon to be deprecated helm GetReleaseStatus API.

func InstallRelease

func InstallRelease(vals []byte, rlsName, chStr string, dryRun bool) (*rls.InstallReleaseResponse, error)

Soon to be deprecated helm InstallRelease API.

func ListReleases

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

Soon to be deprecated helm ListReleases API.

func UninstallRelease

func UninstallRelease(rlsName string, dryRun bool) (*rls.UninstallReleaseResponse, error)

Soon to be deprecated helm UninstallRelease API.

func UpdateRelease

func UpdateRelease(rlsName string) (*rls.UpdateReleaseResponse, error)

Soon to be deprecated helm UpdateRelease API.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Helm client manages client side of the helm-tiller protocol

func NewClient

func NewClient(opts ...Option) *Client

func (*Client) DeleteRelease

func (h *Client) DeleteRelease(rlsName string, opts ...DeleteOption) (*rls.UninstallReleaseResponse, error)

UninstallRelease uninstalls a named release and returns the response.

Note: there aren't currently any supported DeleteOptions, but they are kept in the API signature as a placeholder for future additions.

func (*Client) Init

func (h *Client) Init() *Client

Initializes the helm client with default options

func (*Client) InstallRelease

func (h *Client) InstallRelease(chStr string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)

InstallRelease installs a new chart and returns the release response.

func (*Client) ListReleases

func (h *Client) ListReleases(opts ...ReleaseListOption) (*rls.ListReleasesResponse, error)

ListReleases lists the current releases.

func (*Client) Option

func (h *Client) Option(opts ...Option) *Client

Configure the helm client with the provided options

func (*Client) ReleaseContent

func (h *Client) ReleaseContent(rlsName string, opts ...ContentOption) (*rls.GetReleaseContentResponse, error)

ReleaseContent returns the configuration for a given release.

Note: there aren't currently any supported ContentOptions, but they are kept in the API signature as a placeholder for future additions.

func (*Client) ReleaseStatus

func (h *Client) ReleaseStatus(rlsName string, opts ...StatusOption) (*rls.GetReleaseStatusResponse, error)

ReleaseStatus returns the given release's status.

Note: there aren't currently any supported StatusOptions, but they are kept in the API signature as a placeholder for future additions.

func (*Client) UpdateRelease

func (h *Client) UpdateRelease(rlsName string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error)

UpdateRelease updates a release to a new/different chart.

Note: there aren't currently any supported UpdateOptions, but they are kept in the API signature as a placeholder for future additions.

type ContentOption

type ContentOption func(*options)

ContentOption -- TODO

type DeleteOption

type DeleteOption func(*options)

DeleteOption -- TODO

type InstallOption

type InstallOption func(*options)

InstallOption allows specifying various settings configurable by the helm client user for overriding the defaults used when running the `helm install` command.

func ReleaseName

func ReleaseName(name string) InstallOption

ReleaseName specifies the name of the release when installing.

func ValueOverrides

func ValueOverrides(raw []byte) InstallOption

ValueOverrides specifies a list of values to include when installing.

type Option

type Option func(*options)

Option allows specifying various settings configurable by the helm client user for overriding the defaults used when issuing rpc's to the Tiller release server.

func DryRun

func DryRun() Option

DryRun returns an Option which instructs the helm client to dry-run tiller rpcs.

func HelmHome

func HelmHome(home string) Option

HelmHome specifies the location of helm home, (default = "$HOME/.helm").

func HelmHost

func HelmHost(host string) Option

HelmHost specifies the host address of the Tiller release server, (default = ":44134").

type ReleaseListOption

type ReleaseListOption func(*options)

ReleaseListOption allows specifying various settings configurable by the helm client user for overriding the defaults used when running the `helm list` command.

func ReleaseListFilter

func ReleaseListFilter(filter string) ReleaseListOption

ReleaseListFilter specifies a filter to apply a list of releases.

func ReleaseListLimit

func ReleaseListLimit(limit int) ReleaseListOption

ReleaseListLimit set an upper bound on the number of releases returned.

func ReleaseListOffset

func ReleaseListOffset(offset string) ReleaseListOption

ReleaseListOffset specifies the offset into a list of releases.

func ReleaseListOrder

func ReleaseListOrder(order int32) ReleaseListOption

ReleaseListOrder specifies how to order a list of releases.

func ReleaseListSort

func ReleaseListSort(sort int32) ReleaseListOption

ReleaseListSort specifies how to sort a release list.

type StatusOption

type StatusOption func(*options)

StatusOption -- TODO

type UpdateOption

type UpdateOption func(*options)

UpdateOption -- TODO