client

Documentation

Index

• type Client
  • func NewClient(client client.Client) Client
• type ObjectKey

Types

type Client

type Client interface {
	Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error
	Get(ctx context.Context, key ObjectKey, objExisting client.Object, opts ...client.GetOption) error
	Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error
	Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error
	List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
}

Client is a wrapper around the raw kube client provided by operator-sdk. Using the wrapper facilitates mocking of client interactions with the cluster, while using fakeclient during unit testing. TODO(tflannag): Should this be removed entirely in favor of c-r's dynamic client?

func NewClient

func NewClient(client client.Client) Client

NewClient returns a kubeClient that can perform create, get and update operations on a runtime object

type ObjectKey

type ObjectKey = types.NamespacedName

ObjectKey identifies a Kubernetes Object.