resource

Documentation

Index

• type Client
• type Filter
  • func NewUIDFilter(uids ...types.UID) Filter
• type Kind
• type Resource
  • func NewResource(meta metav1.ObjectMeta, kind Kind, client Client) *Resource
• type Type
• type Waiter

Types

type Client

type Client interface {
	// Namespace returns the client namespace
	Namespace() string

	// Config returns the Kubernetes REST client configuration
	Config() *rest.Config

	// Clientset returns the client's Clientset
	Clientset() *kubernetes.Clientset
}

Client is a resource client

type Filter

type Filter func(kind metav1.GroupVersionKind, meta metav1.ObjectMeta) (bool, error)

Filter is a resource filter

var NoFilter Filter = func(kind metav1.GroupVersionKind, meta metav1.ObjectMeta) (bool, error) {
	return true, nil
}

NoFilter is a filter that accepts all resources

func NewUIDFilter

func NewUIDFilter(uids ...types.UID) Filter

NewUIDFilter returns a new filter for the given owner UIDs

type Kind

type Kind struct {
	Group   string
	Version string
	Kind    string
	Scoped  bool
}

Kind is a resource kind

type Resource

type Resource struct {
	Client
	Kind      Kind
	Namespace string
	Name      string
	UID       types.UID
}

Resource is a Kubernetes resource

func NewResource

func NewResource(meta metav1.ObjectMeta, kind Kind, client Client) *Resource

NewResource creates a new resource

type Type

type Type struct {
	Kind Kind
	Name string
}

Type is a resource type

type Waiter

type Waiter interface {
	Wait(time.Duration) error
}

Waiter is an interface for resources that support waiting for readiness