Documentation ¶
Index ¶
- Constants
- func Apply(o *APIOptions, storage state.Storage, planResources *apiv1.Spec, ...) error
- func Destroy(o *APIOptions, planResources *apiv1.Spec, changes *models.Changes, ...) error
- func DestroyPreview(o *APIOptions, planResources *apiv1.Spec, proj *apiv1.Project, ...) (*models.Changes, error)
- func GenerateSpecWithSpinner(project *v1.Project, stack *v1.Stack, workspace *v1.Workspace, noStyle bool) (*v1.Spec, error)
- func Preview(o *APIOptions, storage state.Storage, planResources *apiv1.Spec, ...) (*opsmodels.Changes, error)
- func SpecFromFile(filePath string) (*v1.Spec, error)
- func Watch(o *APIOptions, planResources *apiv1.Spec, changes *models.Changes) error
- type APIOptions
Constants ¶
const JSONOutput = "json"
Variables ¶
This section is empty.
Functions ¶
func Apply ¶
func Apply( o *APIOptions, storage state.Storage, planResources *apiv1.Spec, changes *models.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 DestroyPreview ¶
func GenerateSpecWithSpinner ¶
func GenerateSpecWithSpinner(project *v1.Project, stack *v1.Stack, workspace *v1.Workspace, noStyle bool) (*v1.Spec, error)
GenerateSpecWithSpinner calls generator to generate versioned Spec. Add a method wrapper for testing purposes.
func Preview ¶
func Preview( o *APIOptions, storage state.Storage, planResources *apiv1.Spec, proj *apiv1.Project, stack *apiv1.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 }
func Watch ¶
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 APIOptions ¶
func NewAPIOptions ¶
func NewAPIOptions() APIOptions