apply

Documentation

Index

• func Apply(o *ApplyOptions, runtime runtime.Runtime, storage states.StateStorage, ...) error
• func NewCmdApply() *cobra.Command
• func Watch(o *ApplyOptions, r runtime.Runtime, planResources *models.Spec, ...) error
• type ApplyFlag
• type ApplyOptions
  • func NewApplyOptions() *ApplyOptions
  • func (o *ApplyOptions) Complete(args []string)
  • func (o *ApplyOptions) Run() error
  • func (o *ApplyOptions) Validate() error

Functions

func Apply

func Apply(
	o *ApplyOptions,
	runtime runtime.Runtime,
	storage states.StateStorage,
	planResources *models.Spec,
	changes *opsmodels.Changes,
	out io.Writer,
) error

The Apply function will apply the resources changes through the execution Kusion Engine, and will save the state to specified storage.

You can customize the runtime of engine and the state storage through `runtime` and `storage` parameters.

Example:

o := NewApplyOptions()
stateStorage := &states.FileSystemState{
    Path: filepath.Join(o.WorkDir, states.KusionState)
}
kubernetesRuntime, err := runtime.NewKubernetesRuntime()
if err != nil {
    return err
}

err = Apply(o, kubernetesRuntime, stateStorage, planResources, changes, os.Stdout)
if err != nil {
    return err
}

func NewCmdApply

func NewCmdApply() *cobra.Command

func Watch

func Watch(o *ApplyOptions,
	r runtime.Runtime,
	planResources *models.Spec,
	changes *opsmodels.Changes,
	out io.Writer,
) error

Watch function will observe the changes of each resource by the execution engine.

Example:

o := NewApplyOptions()
kubernetesRuntime, err := runtime.NewKubernetesRuntime()
if err != nil {
    return err
}

Watch(o, kubernetesRuntime, planResources, changes, os.Stdout)
if err != nil {
    return err
}

Types

type ApplyFlag

type ApplyFlag struct {
	Yes    bool
	DryRun bool
	Watch  bool
}

type ApplyOptions

type ApplyOptions struct {
	previewcmd.PreviewOptions
	ApplyFlag
}

ApplyOptions defines flags for the `apply` command

func NewApplyOptions

func NewApplyOptions() *ApplyOptions

NewApplyOptions returns a new ApplyOptions instance

func (*ApplyOptions) Complete

func (o *ApplyOptions) Complete(args []string)

func (*ApplyOptions) Run

func (o *ApplyOptions) Run() error

func (*ApplyOptions) Validate

func (o *ApplyOptions) Validate() error