cgu

Documentation

Index

• type CguBuilder
  • func ListInAllNamespaces(apiClient *clients.Settings, options ...runtimeclient.ListOptions) ([]*CguBuilder, error)
  • func NewCguBuilder(apiClient *clients.Settings, name, nsname string, maxConcurrency int) *CguBuilder
  • func Pull(apiClient *clients.Settings, name, nsname string) (*CguBuilder, error)
  • func (builder *CguBuilder) Create() (*CguBuilder, error)
  • func (builder *CguBuilder) Delete() (*CguBuilder, error)
  • func (builder *CguBuilder) Exists() bool
  • func (builder *CguBuilder) Update(force bool) (*CguBuilder, error)
  • func (builder *CguBuilder) WaitUntilBackupStarts(timeout time.Duration) (*CguBuilder, error)
  • func (builder *CguBuilder) WaitUntilComplete(timeout time.Duration) (*CguBuilder, error)
  • func (builder *CguBuilder) WithCanary(canary string) *CguBuilder
  • func (builder *CguBuilder) WithCluster(cluster string) *CguBuilder
  • func (builder *CguBuilder) WithManagedPolicy(policy string) *CguBuilder

Types

type CguBuilder

type CguBuilder struct {
	// cgu Definition, used to create the cgu object.
	Definition *v1alpha1.ClusterGroupUpgrade
	// created cgu object.
	Object *v1alpha1.ClusterGroupUpgrade
	// contains filtered or unexported fields
}

CguBuilder provides struct for the cgu object containing connection to the cluster and the cgu definitions.

func ListInAllNamespaces

func ListInAllNamespaces(apiClient *clients.Settings, options ...runtimeclient.ListOptions) ([]*CguBuilder, error)

ListInAllNamespaces returns a cluster-wide cgu inventory.

func NewCguBuilder

func NewCguBuilder(apiClient *clients.Settings, name, nsname string, maxConcurrency int) *CguBuilder

NewCguBuilder creates a new instance of CguBuilder.

func Pull

func Pull(apiClient *clients.Settings, name, nsname string) (*CguBuilder, error)

Pull pulls existing cgu into CguBuilder struct.

func (*CguBuilder) Create

func (builder *CguBuilder) Create() (*CguBuilder, error)

Create makes a cgu in the cluster and stores the created object in struct.

func (*CguBuilder) Delete

func (builder *CguBuilder) Delete() (*CguBuilder, error)

Delete removes a cgu from a cluster.

func (*CguBuilder) Exists

func (builder *CguBuilder) Exists() bool

Exists checks whether the given cgu exists.

func (*CguBuilder) Update

func (builder *CguBuilder) Update(force bool) (*CguBuilder, error)

Update renovates the existing cgu object with the cgu definition in builder.

func (*CguBuilder) WaitUntilBackupStarts

func (builder *CguBuilder) WaitUntilBackupStarts(timeout time.Duration) (*CguBuilder, error)

WaitUntilBackupStarts waits the specified timeout for the backup to start.

func (*CguBuilder) WaitUntilComplete

func (builder *CguBuilder) WaitUntilComplete(timeout time.Duration) (*CguBuilder, error)

WaitUntilComplete waits the specified timeout for the CGU to complete.

func (*CguBuilder) WithCanary

func (builder *CguBuilder) WithCanary(canary string) *CguBuilder

WithCanary appends a canary to the RemediationStrategy canaries list in the CGU definition.

func (*CguBuilder) WithCluster

func (builder *CguBuilder) WithCluster(cluster string) *CguBuilder

WithCluster appends a cluster to the clusters list in the CGU definition.

func (*CguBuilder) WithManagedPolicy

func (builder *CguBuilder) WithManagedPolicy(policy string) *CguBuilder

WithManagedPolicy appends a policies to the managed policies list in the CGU definition.