plan

type BuildFailurePlanOptions ¶ added in v1.14.0

type BuildFailurePlanOptions struct {
	NoFinalTracking bool
}

type BuildPlanOptions ¶ added in v1.14.0

type BuildPlanOptions struct {
	NoFinalTracking bool
}

type BuildResourceInfosOptions ¶ added in v1.15.1

type BuildResourceInfosOptions struct {
	NetworkParallelism    int
	NoRemoveManualChanges bool
}

type CalculatePlannedChangesOptions ¶ added in v1.13.0

type CalculatePlannedChangesOptions struct {
	DiffContextLines       int
	ShowVerboseCRDDiffs    bool
	ShowVerboseDiffs       bool
	ShowSensitiveDiffs     bool
	ShowInsignificantDiffs bool
}

type DeletableResourceInfo ¶ added in v1.13.0

type DeletableResourceInfo struct {
	*spec.ResourceMeta

	LocalResource *resource.DeletableResource
	GetResult     *unstructured.Unstructured

	MustDelete       bool
	MustTrackAbsence bool

	Stage common.Stage
}

A data class, which stores all info to make a decision on what to do with the to-be-deleted resource in the plan.

type ExecutePlanOptions ¶ added in v1.13.0

type ExecutePlanOptions struct {
	common.TrackingOptions

	NetworkParallelism int
}

type InstallableResourceInfo ¶ added in v1.13.0

type InstallableResourceInfo struct {
	*spec.ResourceMeta

	LocalResource  *resource.InstallableResource
	GetResult      *unstructured.Unstructured
	DryApplyResult *unstructured.Unstructured
	DryApplyErr    error

	MustInstall                   ResourceInstallType
	MustDeleteOnSuccessfulInstall bool
	MustDeleteOnFailedInstall     bool
	MustTrackReadiness            bool

	Stage                          common.Stage
	StageDeleteOnSuccessfulInstall common.Stage
	Iteration                      int
}

A data class, which stores all info to make a decision on what to do with the to-be-installed resource in the plan.

type Operation ¶ added in v1.13.0

type Operation struct {
	Type      OperationType
	Version   OperationVersion
	Category  OperationCategory
	Iteration OperationIteration
	Status    OperationStatus
	Config    OperationConfig
}

Represents an operation on a resource, such as create, update, track readiness, etc. The operation ID must be unique: you can't have two operations with the same ID in the plan/graph. Operation must be easily serializable.

func (o *Operation) ID() string

func (o *Operation) IDHuman() string

type OperationCategory ¶ added in v1.13.0

type OperationCategory string

const (
	// Does nothing. Used for things like  grouping.
	OperationCategoryMeta OperationCategory = "meta"
	// Operations that mutate Kubernetes resources in the cluster.
	OperationCategoryResource OperationCategory = "resource"
	// Operations that track resources in the cluster. Never mutate anything.
	OperationCategoryTrack OperationCategory = "track"
	// Operations that mutate Helm releases in the cluster.
	OperationCategoryRelease OperationCategory = "release"
)

type OperationConfig ¶ added in v1.13.0

type OperationConfig interface {
	ID() string
	IDHuman() string
}

Any config that is needed to execute the operation goes here, as long as it doesn't fit into other fields of the Operation struct. The underlying struct can have any number of fields of any kind, just make sure they are easily serializable.

type OperationConfigApply ¶ added in v1.13.0

type OperationConfigApply struct {
	ResourceSpec *spec.ResourceSpec
}

func (c *OperationConfigApply) ID() string

func (c *OperationConfigApply) IDHuman() string

type OperationConfigCreate ¶ added in v1.13.0

type OperationConfigCreate struct {
	ResourceSpec  *spec.ResourceSpec
	ForceReplicas *int
}

func (c *OperationConfigCreate) ID() string

func (c *OperationConfigCreate) IDHuman() string

type OperationConfigCreateRelease ¶ added in v1.13.0

type OperationConfigCreateRelease struct {
	Release *helmrelease.Release
}

func (c *OperationConfigCreateRelease) ID() string

func (c *OperationConfigCreateRelease) IDHuman() string

type OperationConfigDelete ¶ added in v1.13.0

type OperationConfigDelete struct {
	ResourceMeta      *spec.ResourceMeta
	DeletePropagation metav1.DeletionPropagation
}

func (c *OperationConfigDelete) ID() string

func (c *OperationConfigDelete) IDHuman() string

type OperationConfigDeleteRelease ¶ added in v1.13.0

type OperationConfigDeleteRelease struct {
	ReleaseName      string
	ReleaseNamespace string
	ReleaseRevision  int
}

func (c *OperationConfigDeleteRelease) ID() string

func (c *OperationConfigDeleteRelease) IDHuman() string

type OperationConfigNoop ¶ added in v1.13.0

type OperationConfigNoop struct {
	OpID string
}

func (c *OperationConfigNoop) ID() string

func (c *OperationConfigNoop) IDHuman() string

type OperationConfigRecreate ¶ added in v1.13.0

type OperationConfigRecreate struct {
	ResourceSpec      *spec.ResourceSpec
	DeletePropagation metav1.DeletionPropagation
	ForceReplicas     *int
}

func (c *OperationConfigRecreate) ID() string

func (c *OperationConfigRecreate) IDHuman() string

type OperationConfigTrackAbsence ¶ added in v1.13.0

type OperationConfigTrackAbsence struct {
	ResourceMeta *spec.ResourceMeta
}

func (c *OperationConfigTrackAbsence) ID() string

func (c *OperationConfigTrackAbsence) IDHuman() string

type OperationConfigTrackPresence ¶ added in v1.13.0

type OperationConfigTrackPresence struct {
	ResourceMeta *spec.ResourceMeta
}

func (c *OperationConfigTrackPresence) ID() string

func (c *OperationConfigTrackPresence) IDHuman() string

type OperationConfigTrackReadiness ¶ added in v1.13.0

type OperationConfigTrackReadiness struct {
	ResourceMeta *spec.ResourceMeta

	FailMode                                 multitrack.FailMode
	FailuresAllowed                          int
	IgnoreLogs                               bool
	IgnoreLogsForContainers                  []string
	IgnoreLogsByRegex                        *regexp.Regexp
	IgnoreLogsByRegexForContainers           map[string]*regexp.Regexp
	IgnoreReadinessProbeFailsByContainerName map[string]time.Duration
	NoActivityTimeout                        time.Duration
	SaveEvents                               bool
	SaveLogsByRegex                          *regexp.Regexp
	SaveLogsByRegexForContainers             map[string]*regexp.Regexp
	SaveLogsOnlyForContainers                []string
	SaveLogsOnlyForNumberOfReplicas          int
}

func (c *OperationConfigTrackReadiness) ID() string

func (c *OperationConfigTrackReadiness) IDHuman() string

type OperationConfigUpdate ¶ added in v1.13.0

type OperationConfigUpdate struct {
	ResourceSpec *spec.ResourceSpec
}

func (c *OperationConfigUpdate) ID() string

func (c *OperationConfigUpdate) IDHuman() string

type OperationConfigUpdateRelease ¶ added in v1.13.0

type OperationConfigUpdateRelease struct {
	Release *helmrelease.Release
}

func (c *OperationConfigUpdateRelease) ID() string

func (c *OperationConfigUpdateRelease) IDHuman() string

type OperationIteration ¶ added in v1.13.0

type OperationIteration int

Helps to avoid operation ID collisions. Since you can't have two operations with the same ID in the graph, you can increment the iteration to get a new unique ID for the operation. The higher the iteration, the later in the plan/graph the operation should appear.

type OperationStatus ¶ added in v1.13.0

type OperationStatus string

const (
	OperationStatusUnknown   OperationStatus = ""
	OperationStatusPending   OperationStatus = "pending"
	OperationStatusCompleted OperationStatus = "completed"
	OperationStatusFailed    OperationStatus = "failed"
)

type OperationType ¶ added in v1.13.0

type OperationType string

const (
	OperationTypeApply          OperationType = "apply"
	OperationTypeCreate         OperationType = "create"
	OperationTypeCreateRelease  OperationType = "create-release"
	OperationTypeDelete         OperationType = "delete"
	OperationTypeDeleteRelease  OperationType = "delete-release"
	OperationTypeNoop           OperationType = "noop"
	OperationTypeRecreate       OperationType = "recreate"
	OperationTypeTrackAbsence   OperationType = "track-absence"
	OperationTypeTrackPresence  OperationType = "track-presence"
	OperationTypeTrackReadiness OperationType = "track-readiness"
	OperationTypeUpdate         OperationType = "update"
	OperationTypeUpdateRelease  OperationType = "update-release"
)

type OperationVersion ¶ added in v1.13.0

type OperationVersion int

Used to handle breaking changes in the Operation struct.

const (
	OperationVersionApply          OperationVersion = 1
	OperationVersionCreate         OperationVersion = 1
	OperationVersionCreateRelease  OperationVersion = 1
	OperationVersionDelete         OperationVersion = 1
	OperationVersionDeleteRelease  OperationVersion = 1
	OperationVersionNoop           OperationVersion = 1
	OperationVersionRecreate       OperationVersion = 1
	OperationVersionTrackAbsence   OperationVersion = 1
	OperationVersionTrackPresence  OperationVersion = 1
	OperationVersionTrackReadiness OperationVersion = 1
	OperationVersionUpdate         OperationVersion = 1
	OperationVersionUpdateRelease  OperationVersion = 1
)

type Plan ¶

type Plan struct {
	Graph graph.Graph[string, *Operation]
}

Wrapper over dominikbraun/graph to make it easier to use as a plan/graph of operations.

func BuildFailurePlan(failedPlan *Plan, installableInfos []*InstallableResourceInfo, releaseInfos []*ReleaseInfo, opts BuildFailurePlanOptions) (*Plan, error)

func BuildPlan(installableInfos []*InstallableResourceInfo, deletableInfos []*DeletableResourceInfo, releaseInfos []*ReleaseInfo, opts BuildPlanOptions) (*Plan, error)

func NewPlan() *Plan

func (p *Plan) AddOperationChain() *planChainBuilder

func (p *Plan) Connect(fromID, toID string) error

func (p *Plan) Operation(id string) (op *Operation, found bool)

func (p *Plan) Operations() []*Operation

func (p *Plan) Optimize(noFinalTracking bool) error

func (p *Plan) SquashOperation(op *Operation)

func (p *Plan) ToDOT() ([]byte, error)

type ReleaseInfo ¶ added in v1.13.0

type ReleaseInfo struct {
	Release *helmrelease.Release

	Must                   ReleaseType
	MustFailOnFailedDeploy bool
}

Data class, which stores all info to make a decision on what to do with the release revision in the plan.

func BuildReleaseInfos(ctx context.Context, deployType common.DeployType, prevReleases []*helmrelease.Release, newRel *helmrelease.Release) ([]*ReleaseInfo, error)

type ReleaseType ¶ added in v1.13.0

type ReleaseType string

const (
	// No-op
	ReleaseTypeNone ReleaseType = "none"
	// First release revision is to be installed
	ReleaseTypeInstall ReleaseType = "install"
	// New release revision is to be installed as an upgrade over the previous one
	ReleaseTypeUpgrade ReleaseType = "upgrade"
	// New release revision is to be installed, based on one of the previous revisions
	ReleaseTypeRollback ReleaseType = "rollback"
	// One of the previous revisions is to be superseded by a successful release
	ReleaseTypeSupersede ReleaseType = "supersede"
	// Release is to be uninstalled as a whole, with its resources
	ReleaseTypeUninstall ReleaseType = "uninstall"
	// Release revision is to be dropped/deleted (its resources are untouched)
	ReleaseTypeDelete ReleaseType = "delete"
)

type ResourceChange ¶ added in v1.13.0

type ResourceChange struct {
	// Any operations on the resource after the initial one.
	ExtraOperations []string
	// The reason for the change.
	Reason       string
	ResourceMeta *spec.ResourceMeta
	Type         string
	TypeStyle    color.Style
	Udiff        string
}

func CalculatePlannedChanges(installableInfos []*InstallableResourceInfo, deletableInfos []*DeletableResourceInfo, opts CalculatePlannedChangesOptions) ([]*ResourceChange, error)

type ResourceInstallType ¶ added in v1.13.0

type ResourceInstallType string

const (
	ResourceInstallTypeNone     ResourceInstallType = "none"
	ResourceInstallTypeCreate   ResourceInstallType = "create"
	ResourceInstallTypeRecreate ResourceInstallType = "recreate"
	ResourceInstallTypeUpdate   ResourceInstallType = "update"
	// When we can't figure out whether to create or update the resource, we blindly apply it
	ResourceInstallTypeApply ResourceInstallType = "apply"
)