Documentation
¶
Index ¶
- Variables
- func IsHelmOciRepo(repoURL string) bool
- func IsMissingDependencyErr(err error) bool
- func IsVersion(text string) bool
- func Version(shortForm bool) (string, error)
- type Client
- type ClientOpts
- type Cmd
- func (c *Cmd) Close()
- func (c *Cmd) Fetch(repo, chartName, version, destination string, creds Creds, ...) (string, error)
- func (c *Cmd) Init() (string, error)
- func (c *Cmd) PullOCI(repo string, chart string, version string, destination string) (string, error)
- func (c *Cmd) RegistryLogin(repo string, creds Creds) (string, error)
- func (c *Cmd) RegistryLogout(repo string, creds Creds) (string, error)
- func (c *Cmd) RepoAdd(name string, url string, opts Creds, passCredentials bool) (string, error)
- type Creds
- type Entries
- type Entry
- type Helm
- type HelmRepository
- type HelmVer
- type Index
- type TemplateOpts
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // HelmV2 represents helm V2 specific settings HelmV2 = HelmVer{ // contains filtered or unexported fields } // HelmV3 represents helm V3 specific settings HelmV3 = HelmVer{ // contains filtered or unexported fields } )
Functions ¶
func IsHelmOciRepo ¶
Ensures that given OCI registries URL does not have protocol
func IsMissingDependencyErr ¶
IsMissingDependencyErr tests if the error is related to a missing chart dependency
Types ¶
type Client ¶
type Client interface {
CleanChartCache(chart string, version string) error
ExtractChart(chart string, version string, passCredentials bool) (string, io.Closer, error)
GetIndex(noCache bool) (*Index, error)
TestHelmOCI() (bool, error)
}
func NewClientWithLock ¶
type ClientOpts ¶ added in v2.1.0
type ClientOpts func(c *nativeHelmChart)
func WithIndexCache ¶ added in v2.1.0
func WithIndexCache(indexCache indexCache) ClientOpts
type Cmd ¶
type Cmd struct {
HelmVer
WorkDir string
IsLocal bool
IsHelmOci bool
// contains filtered or unexported fields
}
A thin wrapper around the "helm" command, adding logging and error translation.
func NewCmdWithVersion ¶
func (*Cmd) RegistryLogin ¶ added in v2.2.0
func (*Cmd) RegistryLogout ¶ added in v2.2.0
type Helm ¶
type Helm interface {
// Template returns a list of unstructured objects from a `helm template` command
Template(opts *TemplateOpts) (string, error)
// GetParameters returns a list of chart parameters taking into account values in provided YAML files.
GetParameters(valuesFiles []pathutil.ResolvedFilePath) (map[string]string, error)
// DependencyBuild runs `helm dependency build` to download a chart's dependencies
DependencyBuild() error
// Init runs `helm init --client-only`
Init() error
// Dispose deletes temp resources
Dispose()
}
Helm provides wrapper functionality around the `helm` command.
func NewHelmApp ¶
func NewHelmApp(workDir string, repos []HelmRepository, isLocal bool, version string, proxy string, passCredentials bool) (Helm, error)
NewHelmApp create a new wrapper to run commands on the `helm` command-line tool.
type HelmVer ¶
type HelmVer struct {
// contains filtered or unexported fields
}
HelmVer contains Helm version specific settings such as helm binary and command names
type TemplateOpts ¶
Click to show internal directories.
Click to hide internal directories.