resources

Documentation

Overview

Package resources contains a set of Kubernetes generic utilities that are used by the operator

Index

• func RetryAlways(_ error) bool
• func RetryWithRefreshedResource(ctx context.Context, cli client.Client, resource client.Object, ...) error
• type PersistentVolumeClaimBuilder
  • func NewPersistentVolumeClaimBuilder() *PersistentVolumeClaimBuilder
  • func NewPersistentVolumeClaimBuilderFromPVC(pvc *corev1.PersistentVolumeClaim) *PersistentVolumeClaimBuilder
  • func (b *PersistentVolumeClaimBuilder) BeginMetadata() *ResourceMetadataBuilder[*PersistentVolumeClaimBuilder]
  • func (b *PersistentVolumeClaimBuilder) Build() *corev1.PersistentVolumeClaim
  • func (b *PersistentVolumeClaimBuilder) WithAccessModes(accessModes ...corev1.PersistentVolumeAccessMode) *PersistentVolumeClaimBuilder
  • func (b *PersistentVolumeClaimBuilder) WithRequests(rl corev1.ResourceList) *PersistentVolumeClaimBuilder
  • func (b *PersistentVolumeClaimBuilder) WithSource(source *corev1.TypedLocalObjectReference) *PersistentVolumeClaimBuilder
  • func (b *PersistentVolumeClaimBuilder) WithSpec(spec *corev1.PersistentVolumeClaimSpec) *PersistentVolumeClaimBuilder
  • func (b *PersistentVolumeClaimBuilder) WithStorageClass(storageClass *string) *PersistentVolumeClaimBuilder
• type ResourceMetadataBuilder
  • func NewResourceMetadataBuilder[T any](objectMeta *metav1.ObjectMeta, parentBuilder T) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) EndMetadata() T
  • func (builder *ResourceMetadataBuilder[T]) WithAnnotations(maps ...map[string]string) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) WithClusterInheritance(cluster *apiv1.Cluster) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) WithHash(hashValue string) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) WithLabels(maps ...map[string]string) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) WithNamespacedName(name, namespace string) *ResourceMetadataBuilder[T]
  • func (builder *ResourceMetadataBuilder[T]) WithOwnership(controller metav1.ObjectMeta, controllerTypeMeta metav1.TypeMeta) *ResourceMetadataBuilder[T]

Functions

func RetryAlways

func RetryAlways(_ error) bool

RetryAlways is a function that always returns true on any error encountered

func RetryWithRefreshedResource

func RetryWithRefreshedResource(
	ctx context.Context,
	cli client.Client,
	resource client.Object,
	cb func() error,
) error

RetryWithRefreshedResource updates the resource before invoking the cb

Types

type PersistentVolumeClaimBuilder

type PersistentVolumeClaimBuilder struct {
	// contains filtered or unexported fields
}

PersistentVolumeClaimBuilder creates a fluent abstraction to interact with the kubernetes resources

func NewPersistentVolumeClaimBuilder

func NewPersistentVolumeClaimBuilder() *PersistentVolumeClaimBuilder

NewPersistentVolumeClaimBuilder instantiates an empty PersistentVolumeClaimBuilder

func NewPersistentVolumeClaimBuilderFromPVC

func NewPersistentVolumeClaimBuilderFromPVC(pvc *corev1.PersistentVolumeClaim) *PersistentVolumeClaimBuilder

NewPersistentVolumeClaimBuilderFromPVC instantiates a builder with an existing object

func (*PersistentVolumeClaimBuilder) BeginMetadata

func (b *PersistentVolumeClaimBuilder) BeginMetadata() *ResourceMetadataBuilder[*PersistentVolumeClaimBuilder]

BeginMetadata gets the metadata builder

func (*PersistentVolumeClaimBuilder) Build

func (b *PersistentVolumeClaimBuilder) Build() *corev1.PersistentVolumeClaim

Build returns the underlying object

func (*PersistentVolumeClaimBuilder) WithAccessModes

func (b *PersistentVolumeClaimBuilder) WithAccessModes(
	accessModes ...corev1.PersistentVolumeAccessMode,
) *PersistentVolumeClaimBuilder

WithAccessModes adds the access modes to the object being build

func (*PersistentVolumeClaimBuilder) WithRequests

func (b *PersistentVolumeClaimBuilder) WithRequests(rl corev1.ResourceList) *PersistentVolumeClaimBuilder

WithRequests adds the requests to the object being build

func (*PersistentVolumeClaimBuilder) WithSource

func (b *PersistentVolumeClaimBuilder) WithSource(
	source *corev1.TypedLocalObjectReference,
) *PersistentVolumeClaimBuilder

WithSource assigns the currently source to the underlying object

func (*PersistentVolumeClaimBuilder) WithSpec

func (b *PersistentVolumeClaimBuilder) WithSpec(spec *corev1.PersistentVolumeClaimSpec) *PersistentVolumeClaimBuilder

WithSpec assigns the currently passed specs to the underlying object

func (*PersistentVolumeClaimBuilder) WithStorageClass

func (b *PersistentVolumeClaimBuilder) WithStorageClass(storageClass *string) *PersistentVolumeClaimBuilder

WithStorageClass adds the storageClass to the object being build

type ResourceMetadataBuilder

type ResourceMetadataBuilder[T any] struct {
	// contains filtered or unexported fields
}

ResourceMetadataBuilder creates a fluent abstraction to interact with the kubernetes resources

func NewResourceMetadataBuilder

func NewResourceMetadataBuilder[T any](objectMeta *metav1.ObjectMeta, parentBuilder T) *ResourceMetadataBuilder[T]

NewResourceMetadataBuilder makes a ResourceMetadataBuilder starting from the object metadata

func (*ResourceMetadataBuilder[T]) EndMetadata

func (builder *ResourceMetadataBuilder[T]) EndMetadata() T

EndMetadata ends the metadata building framework

func (*ResourceMetadataBuilder[T]) WithAnnotations

func (builder *ResourceMetadataBuilder[T]) WithAnnotations(maps ...map[string]string) *ResourceMetadataBuilder[T]

WithAnnotations adds annotations to the resource being built

func (*ResourceMetadataBuilder[T]) WithClusterInheritance

func (builder *ResourceMetadataBuilder[T]) WithClusterInheritance(cluster *apiv1.Cluster) *ResourceMetadataBuilder[T]

WithClusterInheritance adds the cluster inherited data and ownership to the object

func (*ResourceMetadataBuilder[T]) WithHash

func (builder *ResourceMetadataBuilder[T]) WithHash(hashValue string) *ResourceMetadataBuilder[T]

WithHash adds the hash to the resource being built

func (*ResourceMetadataBuilder[T]) WithLabels

func (builder *ResourceMetadataBuilder[T]) WithLabels(maps ...map[string]string) *ResourceMetadataBuilder[T]

WithLabels adds labels to the resource being built

func (*ResourceMetadataBuilder[T]) WithNamespacedName

func (builder *ResourceMetadataBuilder[T]) WithNamespacedName(name, namespace string) *ResourceMetadataBuilder[T]

WithNamespacedName adds a namespace and a name to the resource being built

func (*ResourceMetadataBuilder[T]) WithOwnership

func (builder *ResourceMetadataBuilder[T]) WithOwnership(
	controller metav1.ObjectMeta,
	controllerTypeMeta metav1.TypeMeta,
) *ResourceMetadataBuilder[T]

WithOwnership adds ownership to the resource being built