gc

Documentation

Overview

Package gc provides a way to handle AWS garbage collection on deletion.

Index

• type CmdProcessor
  • func New(input GCInput, opts ...CmdProcessorOption) (*CmdProcessor, error)
  • func (c *CmdProcessor) Configure(ctx context.Context, gcTasks []string) error
  • func (c *CmdProcessor) Disable(ctx context.Context) error
  • func (c *CmdProcessor) Enable(ctx context.Context) error
• type CmdProcessorOption
  • func WithClient(client client.Client) CmdProcessorOption
• type GCInput

Types

type CmdProcessor

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

CmdProcessor handles the garbage collection commands.

func New

func New(input GCInput, opts ...CmdProcessorOption) (*CmdProcessor, error)

New creates a new instance of the command processor.

func (*CmdProcessor) Configure

func (c *CmdProcessor) Configure(ctx context.Context, gcTasks []string) error

Configure is used to configure external resource garbage collection for a cluster.

func (*CmdProcessor) Disable

func (c *CmdProcessor) Disable(ctx context.Context) error

Disable is used to disable external resource garbage collection for a cluster.

func (*CmdProcessor) Enable

func (c *CmdProcessor) Enable(ctx context.Context) error

Enable is used to enable external resource garbage collection for a cluster.

type CmdProcessorOption

type CmdProcessorOption func(proc *CmdProcessor) error

CmdProcessorOption is a function type to supply options when creating the command processor.

func WithClient

func WithClient(client client.Client) CmdProcessorOption

WithClient is an option that enable you to explicitly supply a client.

type GCInput

type GCInput struct {
	ClusterName    string
	Namespace      string
	KubeconfigPath string
}

GCInput holds the configuration for the command processor.