client

Documentation

Index

• type Applier
  • func (a *Applier) Run(ctx context.Context, objects []*unstructured.Unstructured, ...) <-chan event.Event
• type ApplierOptions
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() (*Applier, error)
  • func (b *Builder) WithCustomStatusChecker(customResourceCheck poller.CustomStatusCheckers) *Builder
  • func (b *Builder) WithFactory(factory util.ClientFactory) *Builder
  • func (b *Builder) WithFilters(filters ...filter.Interface) *Builder
  • func (b *Builder) WithGenerators(generators ...generator.Interface) *Builder
  • func (b *Builder) WithInventory(inventory inventory.Store) *Builder
  • func (b *Builder) WithMutator(mutators ...mutator.Interface) *Builder
  • func (b *Builder) WithStatusPoller(poller poller.StatusPoller) *Builder
• type QueueBuilder
  • func (b *QueueBuilder) Build(options QueueOptions) (<-chan runner.Task, error)
  • func (b *QueueBuilder) WithObjects(objs []*unstructured.Unstructured) *QueueBuilder
  • func (b *QueueBuilder) WithPruneObjects(objs []*unstructured.Unstructured) *QueueBuilder
• type QueueOptions
• type RunnerState
  • func (s *RunnerState) GetContext() context.Context
  • func (s *RunnerState) SendEvent(e event.Event)
  • func (s *RunnerState) SkipWaitCurrentStatus(obj *unstructured.Unstructured) bool

Types

type Applier

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

Applier can be used for appling a list of resources to a remote api-server

func (*Applier) Run

func (a *Applier) Run(ctx context.Context, objects []*unstructured.Unstructured, options ApplierOptions) <-chan event.Event

Run will apply the passed objects to a remote api-server

type ApplierOptions

type ApplierOptions struct {
	DryRun       bool
	Timeout      time.Duration
	FieldManager string
}

ApplierOptions options for the apply step

type Builder

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

Builder is used to correctly instantiate an Applier client with the correct properties

func NewBuilder

func NewBuilder() *Builder

NewBuilder return a new Builder instance with configured defaults

func (*Builder) Build

func (b *Builder) Build() (*Applier, error)

Build use default values and configured builder porperty for correctly setup an Applier

func (*Builder) WithCustomStatusChecker

func (b *Builder) WithCustomStatusChecker(customResourceCheck poller.CustomStatusCheckers) *Builder

func (*Builder) WithFactory

func (b *Builder) WithFactory(factory util.ClientFactory) *Builder

WithFactory assing a ClientFactory to the builder

func (*Builder) WithFilters

func (b *Builder) WithFilters(filters ...filter.Interface) *Builder

WithFilters assing one or more generators to the Builder

func (*Builder) WithGenerators

func (b *Builder) WithGenerators(generators ...generator.Interface) *Builder

WithGenerators assing one or more generators to the Builder

func (*Builder) WithInventory

func (b *Builder) WithInventory(inventory inventory.Store) *Builder

WithInventory assing an inventory.Store to the Builder

func (*Builder) WithMutator

func (b *Builder) WithMutator(mutators ...mutator.Interface) *Builder

WithMutator assing one or more generators to the Builder

func (*Builder) WithStatusPoller

func (b *Builder) WithStatusPoller(poller poller.StatusPoller) *Builder

type QueueBuilder

type QueueBuilder struct {
	Manager      *inventory.Manager
	Client       dynamic.Interface
	Mapper       meta.RESTMapper
	Filters      []filter.Interface
	InfoFetcher  task.InfoFetcher
	RemoteGetter cache.RemoteResourceGetter
	Poller       poller.StatusPoller
	// contains filtered or unexported fields
}

func (*QueueBuilder) Build

func (b *QueueBuilder) Build(options QueueOptions) (<-chan runner.Task, error)

func (*QueueBuilder) WithObjects

func (b *QueueBuilder) WithObjects(objs []*unstructured.Unstructured) *QueueBuilder

func (*QueueBuilder) WithPruneObjects

func (b *QueueBuilder) WithPruneObjects(objs []*unstructured.Unstructured) *QueueBuilder

type QueueOptions

type QueueOptions struct {
	DryRun       bool
	Prune        bool
	FieldManager string
}

type RunnerState

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

func (*RunnerState) GetContext

func (s *RunnerState) GetContext() context.Context

func (*RunnerState) SendEvent

func (s *RunnerState) SendEvent(e event.Event)

func (*RunnerState) SkipWaitCurrentStatus

func (s *RunnerState) SkipWaitCurrentStatus(obj *unstructured.Unstructured) bool