util

Documentation

Overview

Package util provides various utility functions for Kubernetes resources.

Index

• Constants
• func AddCertificateErrorHandler(fatal bool)
• func BuildRestMapper(restConfig *rest.Config) (meta.RESTMapper, error)
• func ConditionsFromUnstructured(from *unstructured.Unstructured, fields ...string) []metav1.Condition
• func ConditionsToUnstructured(conditions []metav1.Condition, to *unstructured.Unstructured, fields ...string)
• func CopyImmutableMetadata(from, to *unstructured.Unstructured) *unstructured.Unstructured
• func CreateAnew[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, ...) (T, error)
• func DeeplyEmpty(m map[string]interface{}) bool
• func FindGroupVersionResource(from *unstructured.Unstructured, restMapper meta.RESTMapper) (*schema.GroupVersionResource, error)
• func GetMetadata(from *unstructured.Unstructured) map[string]interface{}
• func GetNestedField(obj *unstructured.Unstructured, fields ...string) interface{}
• func GetSpec(obj *unstructured.Unstructured) interface{}
• func MustUpdate[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T]) error
• func SetBackoff(b wait.Backoff) wait.Backoff
• func SetNestedField(to map[string]interface{}, value interface{}, fields ...string)
• func ToUnstructuredResource(from runtime.Object, restMapper meta.RESTMapper) (*unstructured.Unstructured, *schema.GroupVersionResource, error)
• func Update[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T]) error
• type CreateOrUpdateOptions
• type MutateFn
  • func Replace[T runtime.Object](with T) MutateFn[T]
• type OperationResult
  • func CreateOrUpdate[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T]) (OperationResult, error)
  • func CreateOrUpdateWithOptions[T runtime.Object](ctx context.Context, options CreateOrUpdateOptions[T]) (OperationResult, T, error)

Constants

const (
	MetadataField    = "metadata"
	LabelsField      = "labels"
	AnnotationsField = "annotations"
	StatusField      = "status"
)

Functions

func AddCertificateErrorHandler

func AddCertificateErrorHandler(fatal bool)

func BuildRestMapper

func BuildRestMapper(restConfig *rest.Config) (meta.RESTMapper, error)

func ConditionsFromUnstructured

func ConditionsFromUnstructured(from *unstructured.Unstructured, fields ...string) []metav1.Condition

func ConditionsToUnstructured

func ConditionsToUnstructured(conditions []metav1.Condition, to *unstructured.Unstructured, fields ...string)

func CopyImmutableMetadata

func CopyImmutableMetadata(from, to *unstructured.Unstructured) *unstructured.Unstructured

CopyImmutableMetadata copies the static metadata fields (except Labels and Annotations) from one resource to another.

func CreateAnew

func CreateAnew[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T,
	createOptions metav1.CreateOptions,
	deleteOptions metav1.DeleteOptions,
) (T, error)

CreateAnew creates a resource, first deleting an existing instance if one exists. If the delete options specify that deletion should be propagated in the foreground, this will wait for the deletion to be complete before creating the new object: with foreground propagation, Get will continue to return the object being deleted and Create will fail with “already exists” until deletion is complete.

func DeeplyEmpty

func DeeplyEmpty(m map[string]interface{}) bool

func FindGroupVersionResource

func FindGroupVersionResource(from *unstructured.Unstructured, restMapper meta.RESTMapper) (*schema.GroupVersionResource, error)

func GetMetadata

func GetMetadata(from *unstructured.Unstructured) map[string]interface{}

func GetNestedField

func GetNestedField(obj *unstructured.Unstructured, fields ...string) interface{}

func GetSpec

func GetSpec(obj *unstructured.Unstructured) interface{}

func MustUpdate

func MustUpdate[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T]) error

Update tries to obtain an existing resource and, if found, updates it. If not found, a NotFound error is returned.

func SetBackoff

func SetBackoff(b wait.Backoff) wait.Backoff

func SetNestedField

func SetNestedField(to map[string]interface{}, value interface{}, fields ...string)

func ToUnstructuredResource

func ToUnstructuredResource(from runtime.Object, restMapper meta.RESTMapper,
) (*unstructured.Unstructured, *schema.GroupVersionResource, error)

func Update

func Update[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T]) error

Update tries to obtain an existing resource and, if found, updates it. If not found, no error is returned.

Types

type CreateOrUpdateOptions

type CreateOrUpdateOptions[T runtime.Object] struct {
	Client         resource.Interface[T]
	Obj            T
	MutateOnUpdate MutateFn[T]
	MutateOnCreate MutateFn[T]
	// IdentifyingLabels is used to find an existing resource if GenerateName is set in the target resource.
	IdentifyingLabels map[string]string
}

type MutateFn

type MutateFn[T runtime.Object] func(existing T) (T, error)

func Replace

func Replace[T runtime.Object](with T) MutateFn[T]

type OperationResult

type OperationResult string

const (
	OperationResultNone    OperationResult = "unchanged"
	OperationResultCreated OperationResult = "created"
	OperationResultUpdated OperationResult = "updated"
)

func CreateOrUpdate

func CreateOrUpdate[T runtime.Object](ctx context.Context, client resource.Interface[T], obj T, mutate MutateFn[T],
) (OperationResult, error)

CreateOrUpdate tries to obtain an existing resource and, if not found, creates 'obj' otherwise updates it. The existing resource is normally retrieved via 'obj's Name field but if it's empty and the GenerateName field is non-empty, it will try to retrieve it via the List method using 'obj's Labels. This assumes that the labels uniquely identify the resource. If more than one resource is found, an error is returned.

func CreateOrUpdateWithOptions

func CreateOrUpdateWithOptions[T runtime.Object](ctx context.Context, options CreateOrUpdateOptions[T]) (OperationResult, T, error)