client

Documentation

Overview

Package client contains an enhanced client.

Index

• Constants
• func ConflictCreateAlreadyExists(err error, resource client.Object) status.Error
• func ConflictUpdateDoesNotExist(err error, resource client.Object) status.Error
• func ConflictUpdateOldVersion(err error, resource client.Object) status.Error
• func NoUpdateNeeded() error
• type Client
  • func New(client client.Client, latencyMetric *prometheus.HistogramVec) *Client
  • func (c *Client) Apply(ctx context.Context, obj client.Object, updateFn update) (client.Object, status.Error)
  • func (c *Client) ApplyStatus(ctx context.Context, obj client.Object, updateFn update) (client.Object, status.Error)
  • func (c *Client) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) status.Error
  • func (c *Client) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) status.Error
  • func (c *Client) Update(ctx context.Context, obj client.Object) status.Error

Constants

const ResourceConflictCode = "2008"

ResourceConflictCode is the code for API Server errors resulting from a mismatch between our cached set of objects and the cluster's..

Functions

func ConflictCreateAlreadyExists

func ConflictCreateAlreadyExists(err error, resource client.Object) status.Error

ConflictCreateAlreadyExists means we tried to create an object which already exists.

func ConflictUpdateDoesNotExist

func ConflictUpdateDoesNotExist(err error, resource client.Object) status.Error

ConflictUpdateDoesNotExist means we tried to update an object which does not exist.

func ConflictUpdateOldVersion

func ConflictUpdateOldVersion(err error, resource client.Object) status.Error

ConflictUpdateOldVersion means we tried to update an object using an old version of the object.

func NoUpdateNeeded

func NoUpdateNeeded() error

NoUpdateNeeded returns an error code for update not required.

Types

type Client

type Client struct {
	client.Client

	MaxTries int
	// contains filtered or unexported fields
}

Client extends the controller-runtime client by exporting prometheus metrics and retrying updates.

func New

func New(client client.Client, latencyMetric *prometheus.HistogramVec) *Client

New returns a new Client.

func (*Client) Apply

func (c *Client) Apply(ctx context.Context, obj client.Object, updateFn update) (client.Object, status.Error)

Apply gets the current object state, modifies it with the provided updateFn, and posts the update to the server. Return the current object state and a NoUpdateNeeded error from the updateFn to skip posting the update if no changes are required.

func (*Client) ApplyStatus

func (c *Client) ApplyStatus(ctx context.Context, obj client.Object, updateFn update) (client.Object, status.Error)

ApplyStatus gets the current object status, modifies it with the provided updateFn, and posts the update to the server. Return the current object state and a NoUpdateNeeded error from the updateFn to skip posting the update if no changes are required.

func (*Client) Create

func (c *Client) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) status.Error

Create saves the object obj in the Kubernetes cluster and records prometheus metrics.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) status.Error

Delete deletes the given obj from Kubernetes cluster and records prometheus metrics. This automatically sets the propagation policy to always be "Background".

func (*Client) Update

func (c *Client) Update(ctx context.Context, obj client.Object) status.Error

Update posts the update to the server and records latency metrics. Specify a ResourceVersion to avoid overwriting asynchronous changes.