state

package
v0.41.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2018 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const DefaultEnv = "default"

Variables

This section is empty.

Functions

func NewCreator added in v0.33.4 

func NewCreator(logger *zap.SugaredLogger, readFile func(string) ([]byte, error), abs func(string) (string, error)) *creator

Types

type DiffError added in v0.32.0 

type DiffError struct {
	*ReleaseSpec

	Code int
	// contains filtered or unexported fields
}

func (*DiffError) Error added in v0.32.0 

func (e *DiffError) Error() string

type EnvironmentSpec added in v0.28.0 

type EnvironmentSpec struct {
	Values  []string `yaml:"values"`
	Secrets []string `yaml:"secrets"`
}

type HelmSpec added in v0.20.0 

type HelmSpec struct {
	KubeContext     string   `yaml:"kubeContext"`
	TillerNamespace string   `yaml:"tillerNamespace"`
	Args            []string `yaml:"args"`
	Verify          bool     `yaml:"verify"`
	// Devel, when set to true, use development versions, too. Equivalent to version '>0.0.0-0'
	Devel bool `yaml:"devel"`
	// Wait, if set to true, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful
	Wait bool `yaml:"wait"`
	// Timeout is the time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness) (default 300)
	Timeout int `yaml:"timeout"`
	// RecreatePods, when set to true, instruct helmfile to perform pods restart for the resource if applicable
	RecreatePods bool `yaml:"recreatePods"`
	// Force, when set to true, forces resource update through delete/recreate if needed
	Force bool `yaml:"force"`
}

HelmSpec to defines helmDefault values

type HelmState 

type HelmState struct {
	Environments       map[string]EnvironmentSpec
	FilePath           string
	HelmDefaults       HelmSpec         `yaml:"helmDefaults"`
	Helmfiles          []string         `yaml:"helmfiles"`
	DeprecatedContext  string           `yaml:"context"`
	DeprecatedReleases []ReleaseSpec    `yaml:"charts"`
	Namespace          string           `yaml:"namespace"`
	Repositories       []RepositorySpec `yaml:"repositories"`
	Releases           []ReleaseSpec    `yaml:"releases"`

	Env environment.Environment
	// contains filtered or unexported fields
}

HelmState structure for the helmfile

func (*HelmState) Clean 

func (state *HelmState) Clean() []error

Clean will remove any generated secrets

func (*HelmState) DeleteReleases 

func (state *HelmState) DeleteReleases(helm helmexec.Interface, purge bool) []error

DeleteReleases wrapper for executing helm delete on the releases

func (*HelmState) DetectReleasesToBeDeleted added in v0.36.0 

func (state *HelmState) DetectReleasesToBeDeleted(helm helmexec.Interface) ([]*ReleaseSpec, error)

func (*HelmState) DiffReleases 

func (state *HelmState) DiffReleases(helm helmexec.Interface, additionalValues []string, workerLimit int, detailedExitCode, suppressSecrets bool) ([]*ReleaseSpec, []error)

DiffReleases wrapper for executing helm diff on the releases It returns releases that had any changes

func (*HelmState) FilterReleases 

func (state *HelmState) FilterReleases(labels []string) error

FilterReleases allows for the execution of helm commands against a subset of the releases in the helmfile.

func (*HelmState) JoinBase added in v0.33.2 

func (state *HelmState) JoinBase(relPath string) string

JoinBase returns an absolute path in the form basePath/relative

func (*HelmState) LintReleases added in v0.20.0 

func (state *HelmState) LintReleases(helm helmexec.Interface, additionalValues []string, args []string, workerLimit int) []error

LintReleases wrapper for executing helm lint on the releases

func (*HelmState) PrepareRelease added in v0.37.0 

func (state *HelmState) PrepareRelease(helm helmexec.Interface, helmfileCommand string) []error

func (*HelmState) ReleaseStatuses added in v0.14.0 

func (state *HelmState) ReleaseStatuses(helm helmexec.Interface, workerLimit int) []error

func (*HelmState) RenderValuesFileToBytes added in v0.28.0 

func (state *HelmState) RenderValuesFileToBytes(path string) ([]byte, error)

func (*HelmState) SyncReleases 

func (state *HelmState) SyncReleases(helm helmexec.Interface, additionalValues []string, workerLimit int) []error

SyncReleases wrapper for executing helm upgrade on the releases

func (*HelmState) SyncRepos 

func (state *HelmState) SyncRepos(helm RepoUpdater) []error

SyncRepos will update the given helm releases

func (*HelmState) TemplateReleases added in v0.31.0 

func (state *HelmState) TemplateReleases(helm helmexec.Interface, additionalValues []string, args []string, workerLimit int) []error

TemplateReleases wrapper for executing helm template on the releases

func (*HelmState) TestReleases added in v0.18.0 

func (state *HelmState) TestReleases(helm helmexec.Interface, cleanup bool, timeout int) []error

TestReleases wrapper for executing helm test on the releases

func (*HelmState) UpdateDeps 

func (state *HelmState) UpdateDeps(helm helmexec.Interface) []error

UpdateDeps wrapper for updating dependencies on the releases

type LabelFilter 

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

LabelFilter matches a release with the given positive lables. Negative labels invert the match for cases such as tier!=backend

func ParseLabels 

func ParseLabels(l string) (LabelFilter, error)

ParseLabels takes a label in the form foo=bar,baz!=bat and returns a LabelFilter that will match the labels

func (LabelFilter) Match 

func (l LabelFilter) Match(r ReleaseSpec) bool

Match will match a release that has the same labels as the filter

type ReleaseError added in v0.23.0 

type ReleaseError struct {
	*ReleaseSpec
	// contains filtered or unexported fields
}

func (*ReleaseError) Error added in v0.23.0 

func (e *ReleaseError) Error() string

type ReleaseFilter 

type ReleaseFilter interface {
	// Match returns true if the ReleaseSpec matches the Filter
	Match(r ReleaseSpec) bool
}

ReleaseFilter is used to determine if a given release should be used during helmfile execution

type ReleaseSpec 

type ReleaseSpec struct {
	// Chart is the name of the chart being installed to create this release
	Chart   string `yaml:"chart"`
	Version string `yaml:"version"`
	Verify  *bool  `yaml:"verify"`
	// Devel, when set to true, use development versions, too. Equivalent to version '>0.0.0-0'
	Devel *bool `yaml:"devel"`
	// Wait, if set to true, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful
	Wait *bool `yaml:"wait"`
	// Timeout is the time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness) (default 300)
	Timeout *int `yaml:"timeout"`
	// RecreatePods, when set to true, instruct helmfile to perform pods restart for the resource if applicable
	RecreatePods *bool `yaml:"recreatePods"`
	// Force, when set to true, forces resource update through delete/recreate if needed
	Force *bool `yaml:"force"`
	// Installed, when set to true, `delete --purge` the release
	Installed *bool `yaml:"installed"`

	// Hooks is a list of extension points paired with operations, that are executed in specific points of the lifecycle of releases defined in helmfile
	Hooks []event.Hook `yaml:"hooks"`

	// Name is the name of this release
	Name      string            `yaml:"name"`
	Namespace string            `yaml:"namespace"`
	Labels    map[string]string `yaml:"labels"`
	Values    []interface{}     `yaml:"values"`
	Secrets   []string          `yaml:"secrets"`
	SetValues []SetValue        `yaml:"set"`

	// The 'env' section is not really necessary any longer, as 'set' would now provide the same functionality
	EnvValues []SetValue `yaml:"env"`

	ValuesPathPrefix string `yaml:"valuesPathPrefix"`
	// contains filtered or unexported fields
}

ReleaseSpec defines the structure of a helm release

type RepoUpdater added in v0.38.0 

type RepoUpdater interface {
	AddRepo(name, repository, certfile, keyfile, username, password string) error
	UpdateRepo() error
}

type RepositorySpec 

type RepositorySpec struct {
	Name     string `yaml:"name"`
	URL      string `yaml:"url"`
	CertFile string `yaml:"certFile"`
	KeyFile  string `yaml:"keyFile"`
	Username string `yaml:"username"`
	Password string `yaml:"password"`
}

RepositorySpec that defines values for a helm repo

type SetValue 

type SetValue struct {
	Name   string   `yaml:"name"`
	Value  string   `yaml:"value"`
	File   string   `yaml:"file"`
	Values []string `yaml:"values"`
}

SetValue are the key values to set on a helm release

type StateLoadError added in v0.32.0 

type StateLoadError struct {
	Cause error
	// contains filtered or unexported fields
}

func (*StateLoadError) Error added in v0.32.0 

func (e *StateLoadError) Error() string

type UndefinedEnvError added in v0.32.0 

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

func (*UndefinedEnvError) Error added in v0.32.0 

func (e *UndefinedEnvError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.