preview

Documentation

Index

• func NewCmdPreview() *cobra.Command
• func Preview(o *Options, storage state.Storage, planResources *apiv1.Intent, ...) (*models.Changes, error)
• type Flags
• type Options
  • func NewPreviewOptions() *Options
  • func (o *Options) AddPreviewFlags(cmd *cobra.Command)
  • func (o *Options) Complete(args []string)
  • func (o *Options) Run() error
  • func (o *Options) Validate() error
  • func (o *Options) ValidateIntentFile() error

Functions

func NewCmdPreview

func NewCmdPreview() *cobra.Command

func Preview

func Preview(
	o *Options,
	storage state.Storage,
	planResources *apiv1.Intent,
	proj *apiv1.Project,
	stack *apiv1.Stack,
) (*models.Changes, error)

The Preview function calculates the upcoming actions of each resource through the execution Kusion Engine, and you can customize the runtime of engine and the state storage through `runtime` and `storage` parameters.

Example:

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

changes, err := Preview(o, kubernetesRuntime, stateStorage,
    planResources, project, stack, os.Stdout)
if err != nil {
    return err
}

Types

type Flags

type Flags struct {
	Operator     string
	Detail       bool
	All          bool
	NoStyle      bool
	Output       string
	IntentFile   string
	IgnoreFields []string
}

type Options

type Options struct {
	build.Options
	Flags
}

func NewPreviewOptions

func NewPreviewOptions() *Options

func (*Options) AddPreviewFlags

func (o *Options) AddPreviewFlags(cmd *cobra.Command)

func (*Options) Complete

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

func (*Options) Run

func (o *Options) Run() error

func (*Options) Validate

func (o *Options) Validate() error

func (*Options) ValidateIntentFile

func (o *Options) ValidateIntentFile() error