await

Documentation

Index

• func Creation(c CreateConfig) (*unstructured.Unstructured, error)
• func Deletion(c DeleteConfig) error
• func KubectlReplace(c KubectlReplaceConfig) (*unstructured.Unstructured, error)
• func Read(c ReadConfig) (*unstructured.Unstructured, error)
• func ServerVersion(cdi discovery.CachedDiscoveryInterface) serverVersion
• func Update(c UpdateConfig) (*unstructured.Unstructured, error)
• type AggregatedError
• type CreateConfig
• type DeleteConfig
• type KubectlReplaceConfig
• type PartialError
• type ProviderConfig
• type ReadConfig
• type UpdateConfig

Functions

func Creation

func Creation(c CreateConfig) (*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(c DeleteConfig) 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 KubectlReplace

func KubectlReplace(c KubectlReplaceConfig) (*unstructured.Unstructured, error)

KubectlReplace performs a `kubectl replace`, returning as soon as `kubectl` would report success (_i.e._, immediately). NOTE: This is the opposite of the other functions in this package -- it does not await the underlying resources to be awaited.

func Read

func Read(c ReadConfig) (*unstructured.Unstructured, error)

Read checks a resource, returning the object if it was created and initialized successfully.

func ServerVersion

func ServerVersion(cdi discovery.CachedDiscoveryInterface) serverVersion

ServerVersion attempts to retrieve the server version from k8s. Returns the configured default version in case this fails.

func Update

func Update(c UpdateConfig) (*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 AggregatedError

type AggregatedError interface {
	SubErrors() []string
}

AggregatedError represents an error with 0 or more sub-errors.

type CreateConfig

type CreateConfig struct {
	ProviderConfig
	Inputs *unstructured.Unstructured
}

type DeleteConfig

type DeleteConfig struct {
	ProviderConfig
	Inputs *unstructured.Unstructured
	Name   string
}

type KubectlReplaceConfig

type KubectlReplaceConfig struct {
	Context   context.Context
	ClientSet *clients.DynamicClientSet
	Inputs    *unstructured.Unstructured
}

type PartialError

type PartialError interface {
	Object() *unstructured.Unstructured
}

PartialError represents an object that failed to complete its current operation.

type ProviderConfig

type ProviderConfig struct {
	Context context.Context
	Host    *pulumiprovider.HostClient
	URN     resource.URN

	ClientSet   *clients.DynamicClientSet
	DedupLogger *logging.DedupLogger
}

type ReadConfig

type ReadConfig struct {
	ProviderConfig
	Inputs *unstructured.Unstructured
	Name   string
}

type UpdateConfig

type UpdateConfig struct {
	ProviderConfig
	Previous *unstructured.Unstructured
	Inputs   *unstructured.Unstructured
}