types

Documentation

Index

• type ApplyOptions
• type CreateOptions
• type Creator
• type Deployer
• type DestroyOptions
• type PlanOptions
• type Type

Types

type ApplyOptions

type ApplyOptions struct{}

ApplyOptions holds the options of Deployer's Apply action.

type CreateOptions

type CreateOptions struct {
	// Type indicates the type for creating.
	Type       Type
	KubeConfig *rest.Config
}

CreateOptions holds the options for creating Deployer.

type Creator

type Creator func(context.Context, CreateOptions) (Deployer, error)

Creator is a factory func to create Deployer.

type Deployer

type Deployer interface {
	// Type returns Type.
	Type() Type

	// Apply creates/updates the resources of the given ResourceRun,
	// also cleans stale resources.
	Apply(context.Context, model.ClientSet, *model.ResourceRun, ApplyOptions) error

	// Destroy cleans all resources of the given ResourceRun.
	Destroy(context.Context, model.ClientSet, *model.ResourceRun, DestroyOptions) error

	// Plan plans the resources of the given ResourceRun.
	Plan(context.Context, model.ClientSet, *model.ResourceRun, PlanOptions) error
}

Deployer holds the actions that a deployer must satisfy.

type DestroyOptions

type DestroyOptions struct{}

DestroyOptions holds the options of Deployer's Destroy action.

type PlanOptions

type PlanOptions struct{}

PlanOptions holds the options of Deployer's Plan action.

type Type

type Type = string

Type indicates the type of Deployer, e.g. Terraform, KubeVela, etc.