Documentation
¶
Overview ¶
Package action contains the logic for each action that Helm can perform.
This is a library for calling top-level Helm actions like 'install', 'upgrade', or 'list'. Actions approximately match the command line invocations that the Helm client uses.
Index ¶
- Constants
- Variables
- func CheckDependencies(ch *chart.Chart, reqs []*chart.Dependency) error
- func GetKubernetesVersion(c *Configuration) string
- func GetVersionSet(client discovery.ServerResourcesInterface) (chartutil.VersionSet, error)
- func TemplateName(nameTemplate string) (string, error)
- type ChartExport
- type ChartList
- type ChartPathOptions
- type ChartPull
- type ChartPush
- type ChartRemove
- type ChartSave
- type Configuration
- type DebugLog
- type Dependency
- type Get
- type GetValues
- type History
- type HookWithResources
- type Install
- type Lint
- type LintResult
- type List
- type ListStates
- type Package
- type Pull
- type RESTClientGetter
- type RegistryLogin
- type RegistryLogout
- type ReleaseTesting
- type Rollback
- type Show
- type ShowOutputFormat
- type Sorter
- type Status
- type Uninstall
- type Upgrade
- type Verify
Constants ¶
const ListAll = ListDeployed | ListUninstalled | ListUninstalling | ListPendingInstall | ListPendingRollback | ListPendingUpgrade | ListSuperseded | ListFailed
ListAll is a convenience for enabling all list filters
Variables ¶
var Timestamper = time.Now
Timestamper is a function capable of producing a timestamp.Timestamper.
By default, this is a time.Time function from the Helm time package. This can be overridden for testing though, so that timestamps are predictable.
var ValidName = regexp.MustCompile("^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])+$")
ValidName is a regular expression for names.
According to the Kubernetes help text, the regular expression it uses is:
(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?
We modified that. First, we added start and end delimiters. Second, we changed the final ? to + to require that the pattern match at least once. This modification prevents an empty string from matching.
Functions ¶
func CheckDependencies ¶
func CheckDependencies(ch *chart.Chart, reqs []*chart.Dependency) error
CheckDependencies checks the dependencies for a chart.
func GetKubernetesVersion ¶ added in v1.0.0
func GetKubernetesVersion(c *Configuration) string
func GetVersionSet ¶
func GetVersionSet(client discovery.ServerResourcesInterface) (chartutil.VersionSet, error)
GetVersionSet retrieves a set of available k8s API versions
func TemplateName ¶
TemplateName renders a name template, returning the name or an error.
Types ¶
type ChartExport ¶
type ChartExport struct {
Destination string
// contains filtered or unexported fields
}
ChartExport performs a chart export operation.
func NewChartExport ¶
func NewChartExport(cfg *Configuration) *ChartExport
NewChartExport creates a new ChartExport object with the given configuration.
type ChartList ¶
type ChartList struct {
// contains filtered or unexported fields
}
ChartList performs a chart list operation.
func NewChartList ¶
func NewChartList(cfg *Configuration) *ChartList
NewChartList creates a new ChartList object with the given configuration.
type ChartPathOptions ¶
type ChartPathOptions struct {
CaFile string // --ca-file
CertFile string // --cert-file
KeyFile string // --key-file
Keyring string // --keyring
Password string // --password
RepoURL string // --repo
Username string // --username
Verify bool // --verify
Version string // --version
}
ChartPathOptions captures common options used for controlling chart paths
func (*ChartPathOptions) LocateChart ¶
func (c *ChartPathOptions) LocateChart(name string, settings *cli.EnvSettings) (string, error)
LocateChart looks for a chart directory in known places, and returns either the full path or an error.
This does not ensure that the chart is well-formed; only that the requested filename exists.
Order of resolution: - relative to current working directory - if path is absolute or begins with '.', error out here - URL
If 'verify' was set on ChartPathOptions, this will attempt to also verify the chart.
type ChartPull ¶
type ChartPull struct {
// contains filtered or unexported fields
}
ChartPull performs a chart pull operation.
func NewChartPull ¶
func NewChartPull(cfg *Configuration) *ChartPull
NewChartPull creates a new ChartPull object with the given configuration.
type ChartPush ¶
type ChartPush struct {
// contains filtered or unexported fields
}
ChartPush performs a chart push operation.
func NewChartPush ¶
func NewChartPush(cfg *Configuration) *ChartPush
NewChartPush creates a new ChartPush object with the given configuration.
type ChartRemove ¶
type ChartRemove struct {
// contains filtered or unexported fields
}
ChartRemove performs a chart remove operation.
func NewChartRemove ¶
func NewChartRemove(cfg *Configuration) *ChartRemove
NewChartRemove creates a new ChartRemove object with the given configuration.
type ChartSave ¶
type ChartSave struct {
// contains filtered or unexported fields
}
ChartSave performs a chart save operation.
func NewChartSave ¶
func NewChartSave(cfg *Configuration) *ChartSave
NewChartSave creates a new ChartSave object with the given configuration.
type Configuration ¶
type Configuration struct {
// RESTClientGetter is an interface that loads Kubernetes clients.
RESTClientGetter RESTClientGetter
// Releases stores records of releases.
Releases *storage.Storage
// KubeClient is a Kubernetes API client.
KubeClient kube.Interface
// RegistryClient is a client for working with registries
RegistryClient *registry.Client
// Capabilities describes the capabilities of the Kubernetes cluster.
Capabilities *chartutil.Capabilities
ClientSet *kubernetes.Clientset
Log func(string, ...interface{})
}
Configuration injects the dependencies that all actions share.
func (*Configuration) Init ¶
func (c *Configuration) Init(getter genericclioptions.RESTClientGetter, namespace string, helmDriver string, log DebugLog) error
Init initializes the action configuration
func (*Configuration) KubernetesClientSet ¶
func (c *Configuration) KubernetesClientSet() (kubernetes.Interface, error)
KubernetesClientSet creates a new kubernetes ClientSet based on the configuration
func (*Configuration) Now ¶
func (c *Configuration) Now() time.Time
Now generates a timestamp
If the configuration has a Timestamper on it, that will be used. Otherwise, this will use time.Now().
type DebugLog ¶
type DebugLog func(format string, v ...interface{})
DebugLog sets the logger that writes debug strings
type Dependency ¶
Dependency is the action for building a given chart's dependency tree.
It provides the implementation of 'helm dependency' and its respective subcommands.
func NewDependency ¶
func NewDependency() *Dependency
NewDependency creates a new Dependency object with the given configuration.
type Get ¶
type Get struct {
Version int
// contains filtered or unexported fields
}
Get is the action for checking a given release's information.
It provides the implementation of 'helm get' and its respective subcommands (except `helm get values`).
func NewGet ¶
func NewGet(cfg *Configuration) *Get
NewGet creates a new Get object with the given configuration.
type GetValues ¶
GetValues is the action for checking a given release's values.
It provides the implementation of 'helm get values'.
func NewGetValues ¶
func NewGetValues(cfg *Configuration) *GetValues
NewGetValues creates a new GetValues object with the given configuration.
type History ¶
History is the action for checking the release's ledger.
It provides the implementation of 'helm history'.
func NewHistory ¶
func NewHistory(cfg *Configuration) *History
NewHistory creates a new History object with the given configuration.
type HookWithResources ¶
type HookWithResources struct {
Hook *release.Hook
Resources kube.ResourceList
}
type Install ¶
type Install struct {
ChartPathOptions
ClientOnly bool
CreateNamespace bool
DryRun bool
DisableHooks bool
Replace bool
Wait bool
WaitForJobs bool
Devel bool
DependencyUpdate bool
Timeout time.Duration
Namespace string
ReleaseName string
GenerateName bool
NameTemplate string
Description string
OutputDir string
Atomic bool
SkipCRDs bool
SubNotes bool
DisableOpenAPIValidation bool
IncludeCRDs bool
// APIVersions allows a manual set of supported API Versions to be passed
// (for things like templating). These are ignored if ClientOnly is false
APIVersions chartutil.VersionSet
// Used by helm template to render charts with .Release.IsUpgrade. Ignored if Dry-Run is false
IsUpgrade bool
// Used by helm template to add the release as part of OutputDir path
// OutputDir/<ReleaseName>
UseReleaseName bool
PostRenderer postrender.PostRenderer
Commit string
ImagePullSecret []v1.LocalObjectReference
ChartName string
ChartVersion string
ClusterCode string
AgentVersion string
DoCallbackReleaseHandler func(string, *release.Release)
// contains filtered or unexported fields
}
Install performs an installation operation.
func NewInstall ¶
func NewInstall(cfg *Configuration, chartPathOptions ChartPathOptions, commit string, imagePullSecret []v1.LocalObjectReference, namespace string, releaseName string, chartName string, chartVersion string, clusterCode string, agentVersion string, doCallbackReleaseHandler func(string, *release.Release)) *Install
NewInstall creates a new Install object with the given configuration.
func (*Install) NameAndChart ¶
NameAndChart returns the name and chart that should be used.
This will read the flags and handle name generation if necessary.
type Lint ¶
Lint is the action for checking that the semantics of a chart are well-formed.
It provides the implementation of 'helm lint'.
type LintResult ¶
LintResult is the result of Lint
type List ¶
type List struct {
// All ignores the limit/offset
All bool
// AllNamespaces searches across namespaces
AllNamespaces bool
// Sort indicates the sort to use
//
// see pkg/releaseutil for several useful sorters
Sort Sorter
// Overrides the default lexicographic sorting
ByDate bool
SortReverse bool
// StateMask accepts a bitmask of states for items to show.
// The default is ListDeployed
StateMask ListStates
// Limit is the number of items to return per Run()
Limit int
// Offset is the starting index for the Run() call
Offset int
// Filter is a filter that is applied to the results
Filter string
Short bool
Uninstalled bool
Superseded bool
Uninstalling bool
Deployed bool
Failed bool
Pending bool
// contains filtered or unexported fields
}
List is the action for listing releases.
It provides, for example, the implementation of 'helm list'.
func (*List) SetStateMask ¶
func (l *List) SetStateMask()
SetStateMask calculates the state mask based on parameters.
type ListStates ¶
type ListStates uint
ListStates represents zero or more status codes that a list item may have set
Because this is used as a bitmask filter, more than one bit can be flipped in the ListStates.
const ( // ListDeployed filters on status "deployed" ListDeployed ListStates = 1 << iota // ListUninstalled filters on status "uninstalled" ListUninstalled // ListUninstalling filters on status "uninstalling" (uninstall in progress) ListUninstalling // ListPendingInstall filters on status "pending" (deployment in progress) ListPendingInstall // ListPendingUpgrade filters on status "pending_upgrade" (upgrade in progress) ListPendingUpgrade // ListPendingRollback filters on status "pending_rollback" (rollback in progress) ListPendingRollback // ListSuperseded filters on status "superseded" (historical release version that is no longer deployed) ListSuperseded // ListFailed filters on status "failed" (release version not deployed because of error) ListFailed // ListUnknown filters on an unknown status ListUnknown )
func (ListStates) FromName ¶
func (s ListStates) FromName(str string) ListStates
FromName takes a state name and returns a ListStates representation.
Currently, there are only names for individual flipped bits, so the returned ListStates will only match one of the constants. However, it is possible that this behavior could change in the future.
type Package ¶
type Package struct {
Sign bool
Key string
Keyring string
Version string
AppVersion string
Destination string
DependencyUpdate bool
RepositoryConfig string
RepositoryCache string
}
Package is the action for packaging a chart.
It provides the implementation of 'helm package'.
func NewPackage ¶
func NewPackage() *Package
NewPackage creates a new Package object with the given configuration.
type Pull ¶
type Pull struct {
ChartPathOptions
Settings *cli.EnvSettings // TODO: refactor this out of pkg/action
Devel bool
Untar bool
VerifyLater bool
UntarDir string
DestDir string
}
Pull is the action for checking a given release's information.
It provides the implementation of 'helm pull'.
type RESTClientGetter ¶
type RESTClientGetter interface {
ToRESTConfig() (*rest.Config, error)
ToDiscoveryClient() (discovery.CachedDiscoveryInterface, error)
ToRESTMapper() (meta.RESTMapper, error)
}
RESTClientGetter gets the rest client
type RegistryLogin ¶
type RegistryLogin struct {
// contains filtered or unexported fields
}
RegistryLogin performs a registry login operation.
func NewRegistryLogin ¶
func NewRegistryLogin(cfg *Configuration) *RegistryLogin
NewRegistryLogin creates a new RegistryLogin object with the given configuration.
type RegistryLogout ¶
type RegistryLogout struct {
// contains filtered or unexported fields
}
RegistryLogout performs a registry login operation.
func NewRegistryLogout ¶
func NewRegistryLogout(cfg *Configuration) *RegistryLogout
NewRegistryLogout creates a new RegistryLogout object with the given configuration.
type ReleaseTesting ¶
type ReleaseTesting struct {
Timeout time.Duration
// Used for fetching logs from test pods
Namespace string
// contains filtered or unexported fields
}
ReleaseTesting is the action for testing a release.
It provides the implementation of 'helm test'.
func NewReleaseTesting ¶
func NewReleaseTesting(cfg *Configuration) *ReleaseTesting
NewReleaseTesting creates a new ReleaseTesting object with the given configuration.
func (*ReleaseTesting) GetPodLogs ¶
GetPodLogs will write the logs for all test pods in the given release into the given writer. These can be immediately output to the user or captured for other uses
type Rollback ¶
type Rollback struct {
Version int
Timeout time.Duration
Wait bool
DisableHooks bool
DryRun bool
Recreate bool // will (if true) recreate pods after a rollback.
Force bool // will (if true) force resource upgrade through uninstall/recreate if needed
CleanupOnFail bool
ReleaseName string
Commit string
ImagePullSecret []v1.LocalObjectReference
ClusterCode string
AgentVersion string
ChartName string
ChartVersion string
// contains filtered or unexported fields
}
Rollback is the action for rolling back to a given release.
It provides the implementation of 'helm rollback'.
func NewRollback ¶
func NewRollback(cfg *Configuration) *Rollback
NewRollback creates a new Rollback object with the given configuration.
type Show ¶
type Show struct {
Namespace string
ChartPathOptions
Devel bool
OutputFormat ShowOutputFormat
// contains filtered or unexported fields
}
Show is the action for checking a given release's information.
It provides the implementation of 'helm show' and its respective subcommands.
func NewShow ¶
func NewShow(cfg *Configuration, output ShowOutputFormat, chartPathOptions ChartPathOptions) *Show
NewShow creates a new Show object with the given configuration.
type ShowOutputFormat ¶
type ShowOutputFormat string
ShowOutputFormat is the format of the output of `helm show`
const ( // ShowAll is the format which shows all the information of a chart ShowAll ShowOutputFormat = "all" // ShowChart is the format which only shows the chart's definition ShowChart ShowOutputFormat = "chart" // ShowValues is the format which only shows the chart's values ShowValues ShowOutputFormat = "values" // ShowReadme is the format which only shows the chart's README ShowReadme ShowOutputFormat = "readme" // ShowHook is the format which only show the chart's hooks ShowHook ShowOutputFormat = "hook" )
func (ShowOutputFormat) String ¶
func (o ShowOutputFormat) String() string
type Status ¶
type Status struct {
Version int
// contains filtered or unexported fields
}
Status is the action for checking the deployment status of releases.
It provides the implementation of 'helm status'.
func NewStatus ¶
func NewStatus(cfg *Configuration) *Status
NewStatus creates a new Status object with the given configuration.
type Uninstall ¶
type Uninstall struct {
DisableHooks bool
DryRun bool
KeepHistory bool
Timeout time.Duration
Description string
// contains filtered or unexported fields
}
Uninstall is the action for uninstalling releases.
It provides the implementation of 'helm uninstall'.
func NewUninstall ¶
func NewUninstall(cfg *Configuration) *Uninstall
NewUninstall creates a new Uninstall object with the given configuration.
type Upgrade ¶
type Upgrade struct {
ChartPathOptions
Install bool
Devel bool
Namespace string
// SkipCRDs skip installing CRDs when install flag is enabled during upgrade
SkipCRDs bool
Timeout time.Duration
Wait bool
WaitForJobs bool
DisableHooks bool
DryRun bool
Force bool
ResetValues bool
ReuseValues bool
// Recreate will (if true) recreate pods after a rollback.
Recreate bool
// MaxHistory limits the maximum number of revisions saved per release
MaxHistory int
Atomic bool
CleanupOnFail bool
SubNotes bool
Description string
PostRenderer postrender.PostRenderer
DisableOpenAPIValidation bool
ReleaseName string
Commit string
ImagePullSecret []v1.LocalObjectReference
ChartName string
ChartVersion string
ClusterCode string
AgentVersion string
DoCallbackReleaseHandler func(string, *release.Release)
// contains filtered or unexported fields
}
func NewUpgrade ¶
func NewUpgrade(cfg *Configuration, chartPathOptions ChartPathOptions, commit string, imagePullSecret []v1.LocalObjectReference, ReleaseName string, chartName string, chartVersion string, clusterCode string, agentVersion string, reuseValues bool, doCallbackReleaseHandler func(string, *release.Release)) *Upgrade
NewUpgrade creates a new Upgrade object with the given configuration.
Source Files
¶
- action.go
- chart_export.go
- chart_list.go
- chart_pull.go
- chart_push.go
- chart_remove.go
- chart_save.go
- dependency.go
- doc.go
- get.go
- get_values.go
- history.go
- hooks.go
- install.go
- lint.go
- list.go
- package.go
- pull.go
- registry_login.go
- registry_logout.go
- release_testing.go
- resource_policy.go
- rollback.go
- show.go
- status.go
- uninstall.go
- upgrade.go
- validate.go
- verify.go