preview

Documentation

Index

• func NewCmdPreview() *cobra.Command
• func Preview(o *PreviewOptions, runtime runtime.Runtime, storage states.StateStorage, ...) (*opsmodels.Changes, error)
• type PreviewFlags
• type PreviewOptions
  • func NewPreviewOptions() *PreviewOptions
  • func (o *PreviewOptions) AddPreviewFlags(cmd *cobra.Command)
  • func (o *PreviewOptions) Complete(args []string)
  • func (o *PreviewOptions) Run() error
  • func (o *PreviewOptions) Validate() error

Functions

func NewCmdPreview

func NewCmdPreview() *cobra.Command

func Preview

func Preview(
	o *PreviewOptions,
	runtime runtime.Runtime,
	storage states.StateStorage,
	planResources *models.Spec,
	project *projectstack.Project,
	stack *projectstack.Stack,
) (*opsmodels.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 PreviewFlags

type PreviewFlags struct {
	Operator     string
	Detail       bool
	All          bool
	NoStyle      bool
	IgnoreFields []string
}

type PreviewOptions

type PreviewOptions struct {
	compilecmd.CompileOptions
	PreviewFlags
	backend.BackendOps
}

func NewPreviewOptions

func NewPreviewOptions() *PreviewOptions

func (*PreviewOptions) AddPreviewFlags

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

func (*PreviewOptions) Complete

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

func (*PreviewOptions) Run

func (o *PreviewOptions) Run() error

func (*PreviewOptions) Validate

func (o *PreviewOptions) Validate() error