await

Documentation

Index

• func Creation(pool dynamic.ClientPool, disco discovery.ServerResourcesInterface, ...) (*unstructured.Unstructured, error)
• func Deletion(pool dynamic.ClientPool, disco discovery.DiscoveryInterface, ...) error
• func Update(pool dynamic.ClientPool, disco discovery.CachedDiscoveryInterface, ...) (*unstructured.Unstructured, error)
• type NotFoundError
  • func (e *NotFoundError) Error() string
• type TimeoutError
  • func (e *TimeoutError) Error() string
• type UnexpectedStateError
  • func (e *UnexpectedStateError) Error() string

Functions

func Creation

func Creation(
	pool dynamic.ClientPool, disco discovery.ServerResourcesInterface, obj *unstructured.Unstructured,
) (*unstructured.Unstructured, error)

Creation (as the usage, `await.Creation`, implies) will block until one of the following is true: (1) the Kubernetes resource is reported to be initialized; (2) the initialization timeout has occurred; or (3) an error has occurred while the resource was being initialized.

func Deletion

func Deletion(
	pool dynamic.ClientPool, disco discovery.DiscoveryInterface, gvk schema.GroupVersionKind,
	namespace, name string,
) error

Deletion (as the usage, `await.Deletion`, implies) will block until one of the following is true: (1) the Kubernetes resource is reported to be deleted; (2) the initialization timeout has occurred; or (3) an error has occurred while the resource was being deleted.

func Update

func Update(
	pool dynamic.ClientPool, disco discovery.CachedDiscoveryInterface,
	lastSubmitted, currentSubmitted *unstructured.Unstructured,
) (*unstructured.Unstructured, error)

Update takes `lastSubmitted` (the last version of a Kubernetes API object submitted to the API server) and `currentSubmitted` (the version of the Kubernetes API object being submitted for an update currently) and blocks until one of the following is true: (1) the Kubernetes resource is reported to be updated; (2) the update timeout has occurred; or (3) an error has occurred while the resource was being updated.

Update updates an existing resource with new values. Currently this client supports the Kubernetes-standard three-way JSON patch. See references here[1] and here[2].

nolint [1]: https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment [2]: https://kubernetes.io/docs/concepts/overview/object-management-kubectl/declarative-config/#how-apply-calculates-differences-and-merges-changes

Types

type NotFoundError

type NotFoundError struct {
	LastError    error
	LastRequest  interface{}
	LastResponse interface{}
	Message      string
	Retries      int
}

NotFoundError is returned when we can't find an API object, potentially after some number of retries.

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

type TimeoutError

type TimeoutError struct {
	LastError     error
	LastState     string
	Timeout       time.Duration
	ExpectedState []string
}

TimeoutError is returned when WaitForState times out

func (*TimeoutError) Error

func (e *TimeoutError) Error() string

type UnexpectedStateError

type UnexpectedStateError struct {
	LastError     error
	State         string
	ExpectedState []string
}

UnexpectedStateError is returned when Refresh returns a state that's neither in Target nor Pending.

func (*UnexpectedStateError) Error

func (e *UnexpectedStateError) Error() string