helm

Documentation

Index

• Constants
• 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, ns 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, chStr string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error)
• type ContentOption
• type DeleteOption
  • func DeleteDisableHooks(disable bool) DeleteOption
  • func DeleteDryRun(dry bool) DeleteOption
  • func DeletePurge(purge bool) DeleteOption
• type InstallOption
  • func InstallDisableHooks(disable bool) InstallOption
  • func InstallDryRun(dry bool) InstallOption
  • func InstallReuseName(reuse bool) InstallOption
  • func ReleaseName(name string) InstallOption
  • func ValueOverrides(raw []byte) InstallOption
• type Interface
• type Option
  • func Home(home string) Option
  • func Host(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
  • func ReleaseListStatuses(statuses []release.Status_Code) ReleaseListOption
• type StatusOption
• type UpdateOption
  • func UpdateValueOverrides(raw []byte) UpdateOption
  • func UpgradeDisableHooks(disable bool) UpdateOption
  • func UpgradeDryRun(dry bool) UpdateOption

Constants

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

	// HelmHomeEnvVar is the $HELM_HOME envvar
	HelmHomeEnvVar = "HELM_HOME"

	// DefaultHelmHost is the default tiller server host address.
	DefaultHelmHost = ":44134"

	// DefaultHelmHome is the default $HELM_HOME envvar value
	DefaultHelmHome = "$HOME/.helm"
)

Types

type Client

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

Client manages client side of the helm-tiller protocol

func NewClient

func NewClient(opts ...Option) *Client

NewClient creates a new client.

func (*Client) DeleteRelease

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

DeleteRelease 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

Init initializes the helm client with default options

func (*Client) InstallRelease

func (h *Client) InstallRelease(chStr, ns 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

Option configures 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, chStr string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error)

UpdateRelease updates a release to a new/different chart

type ContentOption

type ContentOption func(*options)

ContentOption -- TODO

type DeleteOption

type DeleteOption func(*options)

DeleteOption -- TODO

func DeleteDisableHooks

func DeleteDisableHooks(disable bool) DeleteOption

DeleteDisableHooks will disable hooks for a deletion operation.

func DeleteDryRun

func DeleteDryRun(dry bool) DeleteOption

DeleteDryRun will (if true) execute a deletion as a dry run.

func DeletePurge

func DeletePurge(purge bool) DeleteOption

DeletePurge removes the release from the store and make its name free for later use.

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 InstallDisableHooks

func InstallDisableHooks(disable bool) InstallOption

InstallDisableHooks disables hooks during installation.

func InstallDryRun

func InstallDryRun(dry bool) InstallOption

InstallDryRun will (if true) execute an installation as a dry run.

func InstallReuseName

func InstallReuseName(reuse bool) InstallOption

InstallReuseName will (if true) instruct Tiller to re-use an existing name.

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 Interface

type Interface interface {
	ListReleases(opts ...ReleaseListOption) (*rls.ListReleasesResponse, error)
	InstallRelease(chStr, namespace string, opts ...InstallOption) (*rls.InstallReleaseResponse, error)
	DeleteRelease(rlsName string, opts ...DeleteOption) (*rls.UninstallReleaseResponse, error)
	ReleaseStatus(rlsName string, opts ...StatusOption) (*rls.GetReleaseStatusResponse, error)
	UpdateRelease(rlsName, chStr string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error)
	ReleaseContent(rlsName string, opts ...ContentOption) (*rls.GetReleaseContentResponse, error)
}

Interface for helm client for mocking in tests

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 Home

func Home(home string) Option

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

func Host

func Host(host string) Option

Host 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.

func ReleaseListStatuses

func ReleaseListStatuses(statuses []release.Status_Code) ReleaseListOption

ReleaseListStatuses specifies which status codes should be returned.

type StatusOption

type StatusOption func(*options)

StatusOption -- TODO

type UpdateOption

type UpdateOption func(*options)

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

func UpdateValueOverrides

func UpdateValueOverrides(raw []byte) UpdateOption

UpdateValueOverrides specifies a list of values to include when upgrading

func UpgradeDisableHooks

func UpgradeDisableHooks(disable bool) UpdateOption

UpgradeDisableHooks will disable hooks for an upgrade operation.

func UpgradeDryRun

func UpgradeDryRun(dry bool) UpdateOption

UpgradeDryRun will (if true) execute an upgrade as a dry run.