operations

Documentation

Overview

Package operations provides higher level operations on cluster templates.

Index

• func DeleteCluster(ctx context.Context, clusterName string, out io.Writer, st state.State, ...) error
• func DeleteTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, ...) error
• func DiffTemplate(ctx context.Context, templateReader io.Reader, output io.Writer, ...) error
• func ExportTemplate(ctx context.Context, st state.State, clusterID string, writer io.Writer) (models.List, error)
• func RenderTemplate(templateReader io.Reader, output io.Writer) error
• func StatusCluster(ctx context.Context, clusterName string, out io.Writer, st state.State, ...) error
• func StatusTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, ...) error
• func SyncTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, ...) error
• func ValidateTemplate(templateReader io.Reader) error
• type StatusOptions
• type SyncOptions

Functions

func DeleteCluster

func DeleteCluster(ctx context.Context, clusterName string, out io.Writer, st state.State, syncOptions SyncOptions) error

DeleteCluster removes all cluster resources from Omni via template operations.

func DeleteTemplate

func DeleteTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, syncOptions SyncOptions) error

DeleteTemplate removes all template resources from Omni.

func DiffTemplate

func DiffTemplate(ctx context.Context, templateReader io.Reader, output io.Writer, st state.State) error

DiffTemplate outputs the diff between template resources and existing resources.

func ExportTemplate

func ExportTemplate(ctx context.Context, st state.State, clusterID string, writer io.Writer) (models.List, error)

ExportTemplate exports the cluster configuration as a template.

func RenderTemplate

func RenderTemplate(templateReader io.Reader, output io.Writer) error

RenderTemplate outputs the rendered template to the given output.

func StatusCluster

func StatusCluster(ctx context.Context, clusterName string, out io.Writer, st state.State, options StatusOptions) error

StatusCluster queries, renders and (optionally) waits for the cluster status (health).

func StatusTemplate

func StatusTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, options StatusOptions) error

StatusTemplate queries, renders and (optionally) waits for the cluster status (health).

func SyncTemplate

func SyncTemplate(ctx context.Context, templateReader io.Reader, out io.Writer, st state.State, syncOptions SyncOptions) error

SyncTemplate performs resource sync to Omni.

func ValidateTemplate

func ValidateTemplate(templateReader io.Reader) error

ValidateTemplate performs template validation.

Types

type StatusOptions

type StatusOptions struct {
	Wait  bool
	Quiet bool
}

StatusOptions configures the status operation.

type SyncOptions

type SyncOptions struct {
	// DryRun indicates that no changes should be made to the cluster.
	DryRun bool

	// Verbose indicates that diff for each resource should be printed.
	Verbose bool

	// DestroyMachines forcefully remove the disconnected nodes from Omni.
	DestroyMachines bool
}

SyncOptions contains options for SyncTemplate.