run

Documentation

Index

• Variables
• func CleanupCluster(ctx context.Context, log logger.Logger, fns CleanupFuncs) error
• func RunCommand(opts *config.Options) *cobra.Command
• type CleanupFunc
• type CleanupFuncs
  • func (c *CleanupFuncs) Pop() (CleanupFunc, error)
  • func (c *CleanupFuncs) Push(f CleanupFunc)
• type RunCommandFlags

Variables

var ErrEmptyStack = errors.New("stack is empty")

var HelmChartVersion = "3.0.0"

Functions

func CleanupCluster

func CleanupCluster(ctx context.Context, log logger.Logger, fns CleanupFuncs) error

func RunCommand

func RunCommand(opts *config.Options) *cobra.Command

Types

type CleanupFunc

type CleanupFunc func(ctx context.Context, log logger.Logger) error

CleanupFunc is a function supposed to be called while a GitOps Run session is terminating. Each component creating resources on the cluster should return such a function that is then added to the CleanupFuncs stack by the orchestrating code and removed from it and executed during shutdown.

type CleanupFuncs

type CleanupFuncs struct {
	// contains filtered or unexported fields
}

CleanupFuncs is a stack holding CleanupFunc references that are used to roll up all resources created during an GitOps Run session as soon as the session is terminated.

func (*CleanupFuncs) Pop

func (c *CleanupFuncs) Pop() (CleanupFunc, error)

Pop implements the stack's Pop operation, returning and removing the top CleanupFunc from the stack.

func (*CleanupFuncs) Push

func (c *CleanupFuncs) Push(f CleanupFunc)

Push implements the stack's Push operation, adding the given CleanupFunc to the top of the stack.

type RunCommandFlags

type RunCommandFlags struct {
	FluxVersion       string
	AllowK8sContext   []string
	Components        []string
	ComponentsExtra   []string
	Timeout           time.Duration
	PortForward       string // port forward specifier, e.g. "port=8080:8080,resource=svc/app"
	RootDir           string
	DecryptionKeyFile string

	// Dashboard
	DashboardPort           string
	DashboardHashedPassword string
	SkipDashboardInstall    bool
	DashboardImage          string

	// Session
	SessionName         string
	SessionNamespace    string
	NoSession           bool
	SkipResourceCleanup bool
	NoBootstrap         bool

	// Global flags.
	Namespace  string
	KubeConfig string

	// Flags, created by genericclioptions.
	Context string

	// Hidden session name for the sub-process
	HiddenSessionName string
}