clients

Documentation

Index

• Constants
• Variables
• func DefaultNamespaceIfEmpty(namespace string) string
• type DeleteOpts
  • func (o DeleteOpts) WithDefaults() DeleteOpts
• type ListOpts
  • func (o ListOpts) WithDefaults() ListOpts
• type ReadOpts
  • func (o ReadOpts) WithDefaults() ReadOpts
• type ResourceClient
• type ResourceClients
  • func (r ResourceClients) Add(rcs ...ResourceClient)
  • func (r ResourceClients) ForKind(kind string) (ResourceClient, error)
  • func (r ResourceClients) ForResource(resource resources.Resource) (ResourceClient, error)
• type ResourceWatch
• type ResourceWatcher
• type StorageWriteOpts
• type WatchOpts
  • func (o WatchOpts) WithDefaults() WatchOpts
• type WriteOpts
  • func (o WriteOpts) WithDefaults() WriteOpts

Constants

const DefaultNamespace = "default"

Variables

var DefaultRefreshRate = time.Second * 30

Functions

func DefaultNamespaceIfEmpty

func DefaultNamespaceIfEmpty(namespace string) string

Types

type DeleteOpts

type DeleteOpts struct {
	Ctx            context.Context
	IgnoreNotExist bool
	Cluster        string
}

func (DeleteOpts) WithDefaults

func (o DeleteOpts) WithDefaults() DeleteOpts

type ListOpts

type ListOpts struct {
	Ctx      context.Context
	Selector map[string]string
	Cluster  string
}

func (ListOpts) WithDefaults

func (o ListOpts) WithDefaults() ListOpts

type ReadOpts

type ReadOpts struct {
	Ctx     context.Context
	Cluster string
}

func (ReadOpts) WithDefaults

func (o ReadOpts) WithDefaults() ReadOpts

type ResourceClient

type ResourceClient interface {
	Kind() string
	NewResource() resources.Resource
	// Deprecated: implemented only by the kubernetes resource client. Will be removed from the interface.
	Register() error
	Read(namespace, name string, opts ReadOpts) (resources.Resource, error)
	Write(resource resources.Resource, opts WriteOpts) (resources.Resource, error)
	Delete(namespace, name string, opts DeleteOpts) error
	List(namespace string, opts ListOpts) (resources.ResourceList, error)
	ResourceWatcher
}

type ResourceClients

type ResourceClients map[string]ResourceClient

func (ResourceClients) Add

func (r ResourceClients) Add(rcs ...ResourceClient)

func (ResourceClients) ForKind

func (r ResourceClients) ForKind(kind string) (ResourceClient, error)

func (ResourceClients) ForResource

func (r ResourceClients) ForResource(resource resources.Resource) (ResourceClient, error)

type ResourceWatch

type ResourceWatch func(ctx context.Context) (<-chan resources.ResourceList, <-chan error, error)

type ResourceWatcher

type ResourceWatcher interface {
	Watch(namespace string, opts WatchOpts) (<-chan resources.ResourceList, <-chan error, error)
}

type StorageWriteOpts

type StorageWriteOpts interface {
	StorageWriteOptsTag()
}

type WatchOpts

type WatchOpts struct {
	Ctx         context.Context
	Selector    map[string]string
	RefreshRate time.Duration
	// Cluster is ignored by aggregated watches, but is respected by multi cluster clients.
	Cluster string
}

RefreshRate is currently ignored by the Kubernetes ResourceClient implementation. To achieve a similar behavior you can use the KubeResourceClientFactory.ResyncPeriod field. The difference is that it will apply to all the watches started by clients built with the factory.

func (WatchOpts) WithDefaults

func (o WatchOpts) WithDefaults() WatchOpts

type WriteOpts

type WriteOpts struct {
	Ctx               context.Context
	OverwriteExisting bool

	// Implementation dependant write opts
	StorageWriteOpts StorageWriteOpts
}

func (WriteOpts) WithDefaults

func (o WriteOpts) WithDefaults() WriteOpts