release

Documentation

Index

• type Client
  • func NewClient(config *config.Config) Client
• type InstallRequest
  • func (r *InstallRequest) Atomic() *InstallRequest
  • func (r *InstallRequest) CaFile(caFile string) *InstallRequest
  • func (r *InstallRequest) CertFile(certFile string) *InstallRequest
  • func (r *InstallRequest) DisableHooks() *InstallRequest
  • func (r *InstallRequest) DisableOpenAPIValidation() *InstallRequest
  • func (r *InstallRequest) Do() (*Release, error)
  • func (r *InstallRequest) DryRun() *InstallRequest
  • func (r *InstallRequest) IncludeCRDs() *InstallRequest
  • func (r *InstallRequest) KeyFile(keyFile string) *InstallRequest
  • func (r *InstallRequest) Password(password string) *InstallRequest
  • func (r *InstallRequest) Replace() *InstallRequest
  • func (r *InstallRequest) Repo(url string) *InstallRequest
  • func (r *InstallRequest) Set(path string, value interface{}) *InstallRequest
  • func (r *InstallRequest) SkipCRDs() *InstallRequest
  • func (r *InstallRequest) Timeout(timeout time.Duration) *InstallRequest
  • func (r *InstallRequest) Username(username string) *InstallRequest
  • func (r *InstallRequest) Version(version string) *InstallRequest
  • func (r *InstallRequest) Wait() *InstallRequest
• type Release
  • func (r *Release) Client() kubernetes.Client
  • func (r *Release) Values() *values.ImmutableValues
• type RollbackRequest
  • func (r *RollbackRequest) Do() error
• type Status
• type StatusReport
• type UninstallRequest
  • func (r *UninstallRequest) Do() error
• type UpgradeRequest
  • func (r *UpgradeRequest) Atomic() *UpgradeRequest
  • func (r *UpgradeRequest) CaFile(caFile string) *UpgradeRequest
  • func (r *UpgradeRequest) CertFile(certFile string) *UpgradeRequest
  • func (r *UpgradeRequest) DisableHooks() *UpgradeRequest
  • func (r *UpgradeRequest) Do() (*Release, error)
  • func (r *UpgradeRequest) DryRun() *UpgradeRequest
  • func (r *UpgradeRequest) KeyFile(keyFile string) *UpgradeRequest
  • func (r *UpgradeRequest) Password(password string) *UpgradeRequest
  • func (r *UpgradeRequest) Repo(url string) *UpgradeRequest
  • func (r *UpgradeRequest) Set(path string, value interface{}) *UpgradeRequest
  • func (r *UpgradeRequest) Timeout(timeout time.Duration) *UpgradeRequest
  • func (r *UpgradeRequest) Username(username string) *UpgradeRequest
  • func (r *UpgradeRequest) Version(version string) *UpgradeRequest
  • func (r *UpgradeRequest) Wait() *UpgradeRequest

Types

type Client

type Client interface {
	// Namespace returns the release client namespace
	Namespace() string
	// Get gets a release
	Get(name string) (*Release, error)
	// List lists releases
	List() ([]*Release, error)
	// Status gets the status of a release
	Status(name string) (StatusReport, error)
	// Install installs a release
	Install(release string, chart string) *InstallRequest
	// Uninstall uninstalls a release
	Uninstall(release string) *UninstallRequest
	// Upgrade upgrades a release
	Upgrade(release string, chart string) *UpgradeRequest
	// Rollback rolls back a release
	Rollback(release string) *RollbackRequest
}

Client is a Helm release client

func NewClient

func NewClient(config *config.Config) Client

NewClient returns a new release client

type InstallRequest

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

InstallRequest is a release install request

func (*InstallRequest) Atomic

func (r *InstallRequest) Atomic() *InstallRequest

func (*InstallRequest) CaFile

func (r *InstallRequest) CaFile(caFile string) *InstallRequest

func (*InstallRequest) CertFile

func (r *InstallRequest) CertFile(certFile string) *InstallRequest

func (*InstallRequest) DisableHooks

func (r *InstallRequest) DisableHooks() *InstallRequest

func (*InstallRequest) DisableOpenAPIValidation

func (r *InstallRequest) DisableOpenAPIValidation() *InstallRequest

func (*InstallRequest) Do

func (r *InstallRequest) Do() (*Release, error)

func (*InstallRequest) DryRun

func (r *InstallRequest) DryRun() *InstallRequest

func (*InstallRequest) IncludeCRDs

func (r *InstallRequest) IncludeCRDs() *InstallRequest

func (*InstallRequest) KeyFile

func (r *InstallRequest) KeyFile(keyFile string) *InstallRequest

func (*InstallRequest) Password

func (r *InstallRequest) Password(password string) *InstallRequest

func (*InstallRequest) Replace

func (r *InstallRequest) Replace() *InstallRequest

func (*InstallRequest) Repo

func (r *InstallRequest) Repo(url string) *InstallRequest

func (*InstallRequest) Set

func (r *InstallRequest) Set(path string, value interface{}) *InstallRequest

func (*InstallRequest) SkipCRDs

func (r *InstallRequest) SkipCRDs() *InstallRequest

func (*InstallRequest) Timeout

func (r *InstallRequest) Timeout(timeout time.Duration) *InstallRequest

func (*InstallRequest) Username

func (r *InstallRequest) Username(username string) *InstallRequest

func (*InstallRequest) Version

func (r *InstallRequest) Version(version string) *InstallRequest

func (*InstallRequest) Wait

func (r *InstallRequest) Wait() *InstallRequest

type Release

type Release struct {
	StatusReport
	Namespace string
	Name      string
	// contains filtered or unexported fields
}

Release is a Helm release

func (*Release) Client

func (r *Release) Client() kubernetes.Client

Client returns the release client

func (*Release) Values

func (r *Release) Values() *values.ImmutableValues

Values returns the release values

type RollbackRequest

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

RollbackRequest is a release rollback request

func (*RollbackRequest) Do

func (r *RollbackRequest) Do() error

type Status

type Status string

const (
	// StatusUnknown indicates that a release is in an uncertain state.
	StatusUnknown Status = Status(release.StatusUnknown)
	// StatusDeployed indicates that the release has been pushed to Kubernetes.
	StatusDeployed Status = Status(release.StatusDeployed)
	// StatusUninstalled indicates that a release has been uninstalled from Kubernetes.
	StatusUninstalled Status = Status(release.StatusUninstalled)
	// StatusSuperseded indicates that this release object is outdated and a newer one exists.
	StatusSuperseded Status = Status(release.StatusSuperseded)
	// StatusFailed indicates that the release was not successfully deployed.
	StatusFailed Status = Status(release.StatusFailed)
	// StatusUninstalling indicates that a uninstall operation is underway.
	StatusUninstalling Status = Status(release.StatusUninstalling)
	// StatusPendingInstall indicates that an install operation is underway.
	StatusPendingInstall Status = Status(release.StatusPendingInstall)
	// StatusPendingUpgrade indicates that an upgrade operation is underway.
	StatusPendingUpgrade Status = Status(release.StatusPendingUpgrade)
	// StatusPendingRollback indicates that an rollback operation is underway.
	StatusPendingRollback Status = Status(release.StatusPendingRollback)
)

type StatusReport

type StatusReport struct {
	Status        Status
	FirstDeployed time.Time
	LastDeployed  time.Time
}

StatusReport is Helm release status report

type UninstallRequest

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

UninstallRequest is a release uninstall request

func (*UninstallRequest) Do

func (r *UninstallRequest) Do() error

type UpgradeRequest

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

UpgradeRequest is a release upgrade request

func (*UpgradeRequest) Atomic

func (r *UpgradeRequest) Atomic() *UpgradeRequest

func (*UpgradeRequest) CaFile

func (r *UpgradeRequest) CaFile(caFile string) *UpgradeRequest

func (*UpgradeRequest) CertFile

func (r *UpgradeRequest) CertFile(certFile string) *UpgradeRequest

func (*UpgradeRequest) DisableHooks

func (r *UpgradeRequest) DisableHooks() *UpgradeRequest

func (*UpgradeRequest) Do

func (r *UpgradeRequest) Do() (*Release, error)

func (*UpgradeRequest) DryRun

func (r *UpgradeRequest) DryRun() *UpgradeRequest

func (*UpgradeRequest) KeyFile

func (r *UpgradeRequest) KeyFile(keyFile string) *UpgradeRequest

func (*UpgradeRequest) Password

func (r *UpgradeRequest) Password(password string) *UpgradeRequest

func (*UpgradeRequest) Repo

func (r *UpgradeRequest) Repo(url string) *UpgradeRequest

func (*UpgradeRequest) Set

func (r *UpgradeRequest) Set(path string, value interface{}) *UpgradeRequest

func (*UpgradeRequest) Timeout

func (r *UpgradeRequest) Timeout(timeout time.Duration) *UpgradeRequest

func (*UpgradeRequest) Username

func (r *UpgradeRequest) Username(username string) *UpgradeRequest

func (*UpgradeRequest) Version

func (r *UpgradeRequest) Version(version string) *UpgradeRequest

func (*UpgradeRequest) Wait

func (r *UpgradeRequest) Wait() *UpgradeRequest