client

Documentation

Index

• Constants
• Variables
• func ColouredName(key ObjectKey, color *color.Color) string
• func Name(key ObjectKey) string
• func PatchObject(actual, expected runtime.Object) (runtime.Object, error)
• func WaitForDeletion(ctx context.Context, client Client, object Object) error
• type Client
• type CreateOption
• type DeleteOption
• type GetOption
• type InNamespace
• type ListOption
• type MatchingLabels
• type Object
• type ObjectKey
  • func Key(obj metav1.Object) ObjectKey
• type ObjectList
• type Patch
• type PatchOption
• type PropagationPolicy
• type UpdateOption

Constants

const PollInterval = 50 * time.Millisecond

Variables

var RawPatch = ctrlclient.RawPatch

Functions

func ColouredName

func ColouredName(key ObjectKey, color *color.Color) string

func Name

func Name(key ObjectKey) string

func PatchObject

func PatchObject(actual, expected runtime.Object) (runtime.Object, error)

func WaitForDeletion

func WaitForDeletion(ctx context.Context, client Client, object Object) error

Types

type Client

type Client interface {
	// Get retrieves an obj for the given object key from the Kubernetes Cluster.
	// obj must be a struct pointer so that obj can be updated with the response
	// returned by the Server.
	Get(ctx context.Context, key ObjectKey, obj Object, opts ...GetOption) error

	// List retrieves list of objects for a given namespace and list options. On a
	// successful call, Items field in the list will be populated with the
	// result returned from the server.
	List(ctx context.Context, list ObjectList, opts ...ListOption) error

	// Create saves the object obj in the Kubernetes cluster. obj must be a
	// struct pointer so that obj can be updated with the content returned by the Server.
	Create(ctx context.Context, obj Object, opts ...CreateOption) error

	// Update updates the given obj in the Kubernetes cluster. obj must be a
	// struct pointer so that obj can be updated with the content returned by the Server.
	Update(ctx context.Context, obj Object, opts ...UpdateOption) error

	// Delete deletes the given obj from Kubernetes cluster.
	Delete(ctx context.Context, obj Object, opts ...DeleteOption) error

	// Patch patches the given obj in the Kubernetes cluster. obj must be a
	// struct pointer so that obj can be updated with the content returned by the Server.
	Patch(ctx context.Context, obj Object, patch Patch, opts ...PatchOption) error

	// IsObjectNamespaced returns true if the GroupVersionKind of the object is namespaced.
	IsObjectNamespaced(obj runtime.Object) (bool, error)

	// RESTMapper returns the rest this client is using.
	RESTMapper() meta.RESTMapper
}

type CreateOption

type CreateOption = ctrlclient.CreateOption

type DeleteOption

type DeleteOption = ctrlclient.DeleteOption

type GetOption

type GetOption = ctrlclient.GetOption

type InNamespace

type InNamespace = ctrlclient.InNamespace

type ListOption

type ListOption = ctrlclient.ListOption

type MatchingLabels

type MatchingLabels = ctrlclient.MatchingLabels

type Object

type Object = ctrlclient.Object

type ObjectKey

type ObjectKey = ctrlclient.ObjectKey

func Key

func Key(obj metav1.Object) ObjectKey

type ObjectList

type ObjectList = ctrlclient.ObjectList

type Patch

type Patch = ctrlclient.Patch

type PatchOption

type PatchOption = ctrlclient.PatchOption

type PropagationPolicy

type PropagationPolicy = ctrlclient.PropagationPolicy

type UpdateOption

type UpdateOption = ctrlclient.UpdateOption