manifests

Documentation

Index

• Variables
• func MutateFuncFor(existing, desired client.Object) controllerutil.MutateFn
• func ObjectIsNotNil(obj client.Object) bool
• type Builder
• type K8sManifestFactory
  • func Factory[T client.Object](f ManifestFactory[T]) K8sManifestFactory
  • func FactoryWithoutError[T client.Object](f SimpleManifestFactory[T]) K8sManifestFactory
• type ManifestFactory
• type Params
• type SimpleManifestFactory

Variables

var (
	ImmutableChangeErr = errors.New("immutable field change attempted")
)

Functions

func MutateFuncFor

func MutateFuncFor(existing, desired client.Object) controllerutil.MutateFn

MutateFuncFor returns a mutate function based on the existing resource's concrete type. It supports currently only the following types or else panics: - ConfigMap - Service - ServiceAccount - ClusterRole - ClusterRoleBinding - Role - RoleBinding - Deployment - DaemonSet - StatefulSet - ServiceMonitor - Ingress - HorizontalPodAutoscaler - Route - Secret In order for the operator to reconcile other types, they must be added here. The function returned takes no arguments but instead uses the existing and desired inputs here. Existing is expected to be set by the controller-runtime package through a client get call.

func ObjectIsNotNil

func ObjectIsNotNil(obj client.Object) bool

ObjectIsNotNil ensures that we only create an object IFF it isn't nil, and it's concrete type isn't nil either. This works around the Go type system by using reflection to verify its concrete type isn't nil.

Types

type Builder

type Builder func(params Params) ([]client.Object, error)

type K8sManifestFactory

type K8sManifestFactory ManifestFactory[client.Object]

func Factory

func Factory[T client.Object](f ManifestFactory[T]) K8sManifestFactory

func FactoryWithoutError

func FactoryWithoutError[T client.Object](f SimpleManifestFactory[T]) K8sManifestFactory

type ManifestFactory

type ManifestFactory[T client.Object] func(params Params) (T, error)

type Params

type Params struct {
	Client    client.Client
	Recorder  record.EventRecorder
	Scheme    *runtime.Scheme
	Log       logr.Logger
	OtelCol   v1alpha1.AmazonCloudWatchAgent
	DcgmExp   v1alpha1.DcgmExporter
	NeuronExp v1alpha1.NeuronMonitor
	Config    config.Config
}

Params holds the reconciliation-specific parameters.

type SimpleManifestFactory

type SimpleManifestFactory[T client.Object] func(params Params) T