plan

package
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Aug 6, 2026 License: MIT Imports: 51 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Dir is the default directory for generated files.
	Dir = ".helmtide/"

	// File is the default file name for planfile.
	File = "planfile"

	// Body is a default file name for the main config.
	Body = "helmtide.yml"

	// LegacyBody is the config file name of helmwave, which helmtide was forked
	// from. It is still accepted so an existing repository works unchanged.
	LegacyBody = "helmwave.yml"

	// Tpl is the default template for the main config.
	Tpl = "helmtide.yml.tpl"

	// LegacyTpl is the template name inherited from helmwave, still accepted.
	LegacyTpl = "helmwave.yml.tpl"

	// Manifest is the default directory under Dir for manifests.
	Manifest = "manifest/"

	// Values is default directory for values.
	Values = "values/"
)

Variables

View Source 
var (
	// ErrValidateFailed is returned for failed values validation.
	ErrValidateFailed = errors.New("validate failed")

	// ErrPlansAreTheSame is returned when trying to compare plan with itself.
	ErrPlansAreTheSame = errors.New("plan1 and plan2 are the same")

	ErrMultipleKubecontexts = errors.New("kubedog can't work with releases in multiple kubecontexts")

	// ErrManifestDirEmpty is an error for empty manifest dir.
	ErrManifestDirEmpty = fmt.Errorf("manifests dir %s is empty", Manifest)

	// ErrDeploy is returned when deploy is failed for whatever reason.
	ErrDeploy = errors.New("deploy failed")

	// ErrUnsafePlanDir is returned when the plan directory resolves to a path
	// that must never be wiped on export (empty, ".", "..", the filesystem
	// root, the current working directory or the shared temp root).
	ErrUnsafePlanDir = errors.New("unsafe plan directory")
)
View Source 
var (
	// FailStatusColor is tablewriter color for failed releases.
	FailStatusColor = tablewriter.Color(tablewriter.Bold, tablewriter.BgRedColor)

	// SuccessStatusColor is tablewriter color for succeeded releases.
	SuccessStatusColor = tablewriter.Color(tablewriter.Bold, tablewriter.BgRedColor)
)
View Source 
var SkippedAnnotations = map[string][]string{
	live.HookAnnotation:               {string(live.HookTest), "test-success", "test-failure"},
	helper.RootAnnoName + "skip-diff": {"true"},
}

SkippedAnnotations is a map with all annotations to be skipped by differ.

Functions

func DefaultBody 

func DefaultBody() string

DefaultBody returns the config file to use when none was given.

helmtide reads helmtide.yml, but it was forked from helmwave and an existing repository has a helmwave.yml instead. Rather than making everyone rename a file to try this out, the old name is accepted when the new one is absent. A directory holding both is answered with the new name, so a migration can be done by adding helmtide.yml and deleting helmwave.yml afterwards.

func DefaultTpl 

func DefaultTpl() string

DefaultTpl does the same for the template of the main config.

func GenSchema 

func GenSchema() *jsonschema.Schema

func NewBody 

func NewBody(_ context.Context, file string, validate bool) (*planBody, error)

NewBody parses plan from file.

func ParallelLimit 

func ParallelLimit(ctx context.Context, releases release.Configs) int

func SyncRepositories 

func SyncRepositories(ctx context.Context, repositories repo.Configs) error

SyncRepositories initializes helm repository.yaml file with flock and installs provided repositories.

Types

type BuildOptions 

type BuildOptions struct {
	Yml                string
	Templater          string
	Tags               []string
	GraphWidth         int
	MatchAll           bool
	EnableDependencies bool
}

type Plan 

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

Plan contains full helmwave state.

func New 

func New(dir string) *Plan

New returns empty *Plan for provided directory.

func NewAndImport 

func NewAndImport(ctx context.Context, src string) (p *Plan, err error)

NewAndImport wrapper for New and Import in one.

func (*Plan) ApplyReport 

func (p *Plan) ApplyReport(
	releasesFails map[release.Config]error,
	monitorsFails map[monitor.Config]error,
) error

ApplyReport renders a table report for failed releases.

func (*Plan) Build 

func (p *Plan) Build(ctx context.Context, o BuildOptions) (err error)

Build plan with yml and tags/matchALL options.

func (*Plan) BuildGraphASCII 

func (p *Plan) BuildGraphASCII(width int) string

func (*Plan) DiffLive 

func (p *Plan) DiffLive(ctx context.Context, opts *diff.Options, threeWayMerge bool)

DiffLive show diff with production releases in k8s-cluster.

func (*Plan) DiffPlan 

func (p *Plan) DiffPlan(b *Plan, opts *diff.Options)

DiffPlan show diff between 2 plans.

func (*Plan) Down 

func (p *Plan) Down(ctx context.Context) (err error)

Down destroys all releases that exist in a plan.

func (*Plan) Export 

func (p *Plan) Export(ctx context.Context, skipUnchanged bool) error

Export allows save plan to file.

func (*Plan) GetLive 

func (p *Plan) GetLive(
	ctx context.Context,
) (found map[uniqname.UniqName]*live.Release, notFound []uniqname.UniqName, err error)

GetLive returns maps of releases in a k8s-cluster.

func (*Plan) Graph 

func (p *Plan) Graph() *dependency.Graph[uniqname.UniqName, release.Config]

func (*Plan) Import 

func (p *Plan) Import(ctx context.Context) error

Import parses directory with plan files and imports them into structure.

func (*Plan) IsExist 

func (p *Plan) IsExist() bool

IsExist returns true if planfile exists.

func (*Plan) IsManifestExist 

func (p *Plan) IsManifestExist() bool

IsManifestExist returns true if planfile exists.

func (*Plan) List 

func (p *Plan) List() error

List renders releases status table and writes it to stdout. Listed only releases that exist in plan.

func (*Plan) Logger 

func (p *Plan) Logger() *log.Entry

Logger will pretty build log.Entry.

func (*Plan) Manifests 

func (p *Plan) Manifests() map[uniqname.UniqName]string

func (*Plan) ParallelLimiter 

func (p *Plan) ParallelLimiter(ctx context.Context) int

func (*Plan) Rollback 

func (p *Plan) Rollback(ctx context.Context, version int, dog *kubedog.Config) (err error)

Rollback rollbacks helm release.

func (*Plan) Status 

func (p *Plan) Status(names ...string) error

Status renders status table for list of releases names.

func (*Plan) Up 

func (p *Plan) Up(ctx context.Context, dog *kubedog.Config) (err error)

Up syncs repositories and releases.

func (*Plan) ValidateValuesBuild 

func (p *Plan) ValidateValuesBuild() error

ValidateValuesBuild Dst now is a public method. Dst needs to marshal for export. Also, dst needs to unmarshal for import from plan.

func (*Plan) ValidateValuesImport 

func (p *Plan) ValidateValuesImport() error

ValidateValuesImport checks whether all values files exist.

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.