v1alpha1

Documentation

Index

• type Executor
  • func (e *Executor) Execute() error
• type ExecutorBuilder
  • func ExecutorBuilderForConfig(cfg *apis.UpgradeConfig) *ExecutorBuilder
  • func (eb *ExecutorBuilder) Build() (*Executor, error)
• type Upgrade
  • func NewUpgradeForConfigPath(filePath string) (*Upgrade, error)
  • func (u Upgrade) GoString() string
  • func (u *Upgrade) Run() error
  • func (u Upgrade) String() string
• type UpgradeResult
• type UpgradeResultGetOrCreateBuilder
  • func NewUpgradeResultGetOrCreateBuilder() *UpgradeResultGetOrCreateBuilder
  • func (urb *UpgradeResultGetOrCreateBuilder) GetOrCreate() (res *upgrade.UpgradeResult, err error)
  • func (urb *UpgradeResultGetOrCreateBuilder) GoString() string
  • func (urb *UpgradeResultGetOrCreateBuilder) String() string
  • func (urb *UpgradeResultGetOrCreateBuilder) WithOwner(owner *metav1.OwnerReference) *UpgradeResultGetOrCreateBuilder
  • func (urb *UpgradeResultGetOrCreateBuilder) WithResourceDetails(resource *upgrade.ResourceDetails) *UpgradeResultGetOrCreateBuilder
  • func (urb *UpgradeResultGetOrCreateBuilder) WithSelfNamespace(namespace string) *UpgradeResultGetOrCreateBuilder
  • func (urb *UpgradeResultGetOrCreateBuilder) WithTasks(tasks []upgrade.UpgradeResultTask) *UpgradeResultGetOrCreateBuilder
  • func (urb *UpgradeResultGetOrCreateBuilder) WithUpgradeConfig(config *upgrade.UpgradeConfig) *UpgradeResultGetOrCreateBuilder

Types

type Executor

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

Executor contains list of castEngine

func (*Executor) Execute

func (e *Executor) Execute() error

Execute runs list of castEngines. It returns error if there is any while running these engines

type ExecutorBuilder

type ExecutorBuilder struct {
	*errors.ErrorList
	// contains filtered or unexported fields
}

ExecutorBuilder helps to build Executor instance

func ExecutorBuilderForConfig

func ExecutorBuilderForConfig(cfg *apis.UpgradeConfig) *ExecutorBuilder

ExecutorBuilderForConfig returns an instance of ExecutorBuilder It adds object in ExecutorBuilder struct with the help of config

func (*ExecutorBuilder) Build

func (eb *ExecutorBuilder) Build() (*Executor, error)

Build builds a new instance of Executor with the help of ExecutorBuilder instance

type Upgrade

type Upgrade struct {
	// ConfigPath represents the configuration that
	// is provided to upgrade as its input
	ConfigPath string

	// Config represents the config instance
	// built from ConfigPath
	Config *apis.UpgradeConfig
}

Upgrade contains configurations to perform upgrade

func NewUpgradeForConfigPath

func NewUpgradeForConfigPath(filePath string) (*Upgrade, error)

NewUpgradeForConfigPath takes config file path and add config in upgrade instance

func (Upgrade) GoString

func (u Upgrade) GoString() string

GoString implements GoStringer interface

func (*Upgrade) Run

func (u *Upgrade) Run() error

Run runs various steps to upgrade unit of upgrades present in config.

func (Upgrade) String

func (u Upgrade) String() string

String implements Stringer interface

type UpgradeResult

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

UpgradeResult is a wrapper over upgrade.UpgradeResult struct

type UpgradeResultGetOrCreateBuilder

type UpgradeResultGetOrCreateBuilder struct {
	*errors.ErrorList
	SelfNamespace   string
	Owner           *metav1.OwnerReference      // owner reference for upgrade result cr
	UpgradeConfig   *upgrade.UpgradeConfig      // runtime config for upgrade
	ResourceDetails *upgrade.ResourceDetails    // unit of upgrade details
	Tasks           []upgrade.UpgradeResultTask // list of runtasks used to upgrade a resource
	UpgradeResult   *UpgradeResult
}

UpgradeResultGetOrCreateBuilder helps to get or create UpgradeResult instance

func NewUpgradeResultGetOrCreateBuilder

func NewUpgradeResultGetOrCreateBuilder() *UpgradeResultGetOrCreateBuilder

NewUpgradeResultGetOrCreateBuilder returns a new UpgradeResult instance

func (*UpgradeResultGetOrCreateBuilder) GetOrCreate

func (urb *UpgradeResultGetOrCreateBuilder) GetOrCreate() (
	res *upgrade.UpgradeResult, err error)

GetOrCreate builds a new instance of UpgradeResult with the helps of UpgradeResultGetOrCreateBuilder. Upgrade result cr is required to maintain resiliency in upgrade.

func (*UpgradeResultGetOrCreateBuilder) GoString

func (urb *UpgradeResultGetOrCreateBuilder) GoString() string

GoString implements GoStringer interface

func (*UpgradeResultGetOrCreateBuilder) String

func (urb *UpgradeResultGetOrCreateBuilder) String() string

String implements GoStringer interface

func (*UpgradeResultGetOrCreateBuilder) WithOwner

func (urb *UpgradeResultGetOrCreateBuilder) WithOwner(
	owner *metav1.OwnerReference) *UpgradeResultGetOrCreateBuilder

WithOwner adds OwnerReference in UpgradeResult instance

func (*UpgradeResultGetOrCreateBuilder) WithResourceDetails

func (urb *UpgradeResultGetOrCreateBuilder) WithResourceDetails(
	resource *upgrade.ResourceDetails) *UpgradeResultGetOrCreateBuilder

WithResourceDetails adds ResourceDetails in UpgradeResult instance

func (*UpgradeResultGetOrCreateBuilder) WithSelfNamespace

func (urb *UpgradeResultGetOrCreateBuilder) WithSelfNamespace(
	namespace string) *UpgradeResultGetOrCreateBuilder

WithSelfNamespace adds Namespace in UpgradeResult instance

func (*UpgradeResultGetOrCreateBuilder) WithTasks

func (urb *UpgradeResultGetOrCreateBuilder) WithTasks(
	tasks []upgrade.UpgradeResultTask) *UpgradeResultGetOrCreateBuilder

WithTasks adds Tasks in UpgradeResult instance

func (*UpgradeResultGetOrCreateBuilder) WithUpgradeConfig

func (urb *UpgradeResultGetOrCreateBuilder) WithUpgradeConfig(
	config *upgrade.UpgradeConfig) *UpgradeResultGetOrCreateBuilder

WithUpgradeConfig adds UpgradeConfig in UpgradeResult instance