controller

package

Go to main page

Versions in this module

v0

v0.0.5

May 15, 2026

Changes in this version

+ func DefaultContainerSecurityContext() *corev1.SecurityContext

+ func DefaultPodSecurityContext() *corev1.PodSecurityContext

type VersionProbeConfig

+ CachedRevision string

+ CachedVersion string

type VersionProbeResult

+ Revision string

v0.0.4

Apr 17, 2026

Changes in this version

+ const DefaultProbeCPULimit

+ const DefaultProbeCPURequest

+ const DefaultProbeMemoryLimit

+ const DefaultProbeMemoryRequest

+ const DefaultUser

+ func ApplyContainerTemplateOverrides(container *corev1.Container, t *v1.ContainerTemplateSpec) (corev1.Container, error)

+ func ApplyPodTemplateOverrides(podSpec *corev1.PodSpec, t *v1.PodTemplateSpec) (corev1.PodSpec, error)

+ func ClusterSizeCondition(existing, expected int) metav1.Condition

+ func ConfigSyncCondition(notUpdatedIDs []string) metav1.Condition

+ func HealthyCondition(notReadyIDs []string) metav1.Condition

+ func ReplicaStartupCondition(errorIDs []string) metav1.Condition

+ func RunSteps(ctx context.Context, log controllerutil.Logger, steps []ReconcileStep) (ctrl.Result, error)

+ func SetStatusCondition(conditions *[]metav1.Condition, newCondition metav1.Condition) bool

+ type Controller interface

+ GetClient func() client.Client

+ GetRecorder func() events.EventRecorder

+ GetScheme func() *runtime.Scheme

+ type EventSpec struct

+ Action v1.EventAction

+ Message string

+ Reason v1.EventReason

+ Type string

+ func GetUpgradeCondition(checker upgrade.Checker, probe VersionProbeResult, upgradeChannel string) (metav1.Condition, []EventSpec)

+ func GetVersionSyncCondition(probe VersionProbeResult, replicaVersions map[string]string, isUpdating bool) (metav1.Condition, []EventSpec)

+ type ReconcileStep struct

+ Always bool

+ Fn func(context.Context, controllerutil.Logger) (StepResult, error)

+ Name string

type ReplicaUpdateInput

+ DesiredPVCSpec *corev1.PersistentVolumeClaimSpec

+ ExistingPVC *corev1.PersistentVolumeClaim

+ Revisions RevisionState

+ type ResourceManager struct

+ func NewResourceManager(ctrl Controller, owner interface{ ... }) ResourceManager

+ func (rm *ResourceManager) Create(ctx context.Context, resource client.Object, action v1.EventAction) error

+ func (rm *ResourceManager) Delete(ctx context.Context, resource client.Object, action v1.EventAction, ...) error

+ func (rm *ResourceManager) GetPVCByStatefulSet(ctx context.Context, log util.Logger, sts *appsv1.StatefulSet) (*corev1.PersistentVolumeClaim, error)

+ func (rm *ResourceManager) ReconcileConfigMap(ctx context.Context, log util.Logger, configMap *corev1.ConfigMap, ...) (bool, error)

+ func (rm *ResourceManager) ReconcilePodDisruptionBudget(ctx context.Context, log util.Logger, pdb *policyv1.PodDisruptionBudget, ...) (bool, error)

+ func (rm *ResourceManager) ReconcileReplicaResources(ctx context.Context, log util.Logger, input ReplicaUpdateInput) (*ctrlruntime.Result, error)

+ func (rm *ResourceManager) ReconcileResource(ctx context.Context, log util.Logger, resource client.Object, ...) (bool, error)

+ func (rm *ResourceManager) ReconcileService(ctx context.Context, log util.Logger, service *corev1.Service, ...) (bool, error)

+ func (rm *ResourceManager) Update(ctx context.Context, resource client.Object, action v1.EventAction) error

+ func (rm *ResourceManager) UpdatePVC(ctx context.Context, log util.Logger, input ReplicaUpdateInput) error

+ func (rm *ResourceManager) VersionProbe(ctx context.Context, log controllerutil.Logger, cfg VersionProbeConfig) (VersionProbeResult, error)

+ type RevisionState struct

+ ConfigurationRevision string

+ HasPVCSpec bool

+ PVCRevision string

+ StatefulSetRevision string

+ func (rev RevisionState) ReplicaHasDiff(sts *appsv1.StatefulSet, pvc *corev1.PersistentVolumeClaim) bool

+ type StatusManager struct

+ func NewStatusManager[S any, SP clusterStatus[S], C clusterObject[S, SP]](ctrl Controller, cluster C) StatusManager[S, SP, C]

+ func (r *StatusManager[S, SP, C]) SetCondition(cond metav1.Condition, event ...EventSpec)

+ func (r *StatusManager[S, SP, C]) SetConditions(conditions []metav1.Condition)

+ func (r *StatusManager[S, SP, C]) SetUnknownConditions(cr v1.ConditionReason, m string, cts []v1.ConditionType)

+ func (r *StatusManager[S, SP, C]) UpsertStatus(ctx context.Context, log util.Logger) error

+ type StepResult struct

+ Blocked bool

+ RequeueAfter time.Duration

+ func StepBlocked(d time.Duration) StepResult

+ func StepContinue() StepResult

+ func StepRequeue(d time.Duration) StepResult

+ func (s StepResult) IsZero() bool

type VersionProbeConfig

+ VersionProbe *v1.VersionProbeTemplate

type VersionProbeResult

+ func (r *VersionProbeResult) Completed() bool

v0.0.3

Mar 11, 2026

Changes in this version

+ const LoadReplicaStateTimeout

+ type ReplicaUpdateInput struct

+ BreakingSTSVersion semver.Version

+ ConfigurationRevision string

+ DataVolumeClaimSpec *corev1.PersistentVolumeClaimSpec

+ DesiredConfigMap *corev1.ConfigMap

+ DesiredSTS *appsv1.StatefulSet

+ ExistingSTS *appsv1.StatefulSet

+ HasError bool

+ StatefulSetRevision string

type ResourceReconcilerBase

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) ReconcileReplicaResources(ctx context.Context, log util.Logger, replicaID ReplicaID, ...) (*ctrlruntime.Result, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpdateUpgradeCondition(ctx context.Context, log controllerutil.Logger, probe VersionProbeResult, ...) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpdateVersionSyncCondition(ctx context.Context, log controllerutil.Logger, probe VersionProbeResult, ...) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) VersionProbe(ctx context.Context, log controllerutil.Logger, cfg VersionProbeConfig) (VersionProbeResult, error)

+ type VersionProbeConfig struct

+ Annotations map[string]string

+ Binary string

+ ContainerTemplate v1.ContainerTemplateSpec

+ Labels map[string]string

+ PodTemplate v1.PodTemplateSpec

+ type VersionProbeResult struct

+ Err error

+ Pending bool

+ Version string

v0.0.2

Feb 16, 2026

Changes in this version

+ const RequeueOnRefreshTimeout

+ const TLSFileMode

+ var DefaultLivenessProbeSettings = corev1.Probe

+ var DefaultReadinessProbeSettings = corev1.Probe

+ func CheckPodError(ctx context.Context, log util.Logger, client client.Client, ...) (bool, error)

+ func ProjectVolumes(volumes []corev1.Volume, volumeMounts []corev1.VolumeMount) ([]corev1.Volume, []corev1.VolumeMount, error)

+ type LoggerConfig struct

+ Console bool

+ Count int64

+ ErrorLog string

+ Formatting struct{ ... }

+ Level string

+ Log string

+ Size string

+ func GenerateLoggerConfig(spec v1.LoggerConfig, basePath string, service string) LoggerConfig

+ type OpenSSLConfig struct

+ Client OpenSSLParams

+ Server OpenSSLParams

+ type OpenSSLParams struct

+ CAConfig string

+ CertificateFile string

+ DisableProtocols string

+ PreferServerCiphers bool

+ PrivateKeyFile string

+ VerificationMode string

+ type PrometheusConfig struct

+ AsynchronousMetrics bool

+ Endpoint string

+ Events bool

+ Metrics bool

+ Port uint16

+ func DefaultPrometheusConfig(port uint16) PrometheusConfig

+ type ReplicaUpdateStage int

+ const StageError

+ const StageHasDiff

+ const StageNotExists

+ const StageNotReadyUpToDate

+ const StageUpToDate

+ const StageUpdating

+ func (s ReplicaUpdateStage) String() string

+ type ResourceReconcilerBase struct

+ Cluster Cluster

+ ReplicaState map[ReplicaID]ReplicaState

+ func NewReconcilerBase[ClusterStatus any, Cluster clusterObject[ClusterStatus], ReplicaID replicaID, ...](ctrl controller, cluster Cluster) ResourceReconcilerBase[ClusterStatus, Cluster, ReplicaID, ReplicaState]

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) Create(ctx context.Context, resource client.Object, action v1.EventAction) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) Delete(ctx context.Context, resource client.Object, action v1.EventAction) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) NewCondition(condType v1.ConditionType, status metav1.ConditionStatus, ...) metav1.Condition

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) ReconcileConfigMap(ctx context.Context, log util.Logger, configMap *corev1.ConfigMap, ...) (bool, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) ReconcilePodDisruptionBudget(ctx context.Context, log util.Logger, pdb *policyv1.PodDisruptionBudget, ...) (bool, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) ReconcileService(ctx context.Context, log util.Logger, service *corev1.Service, ...) (bool, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) Replica(id ReplicaID) S

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) SetCondition(log util.Logger, cond metav1.Condition) bool

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) SetConditions(log util.Logger, conditions []metav1.Condition) bool

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) SetReplica(id ReplicaID, state S) bool

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) Update(ctx context.Context, resource client.Object, action v1.EventAction) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpdatePVC(ctx context.Context, log util.Logger, id ReplicaID, ...) error

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpsertCondition(ctx context.Context, log util.Logger, condition metav1.Condition) (bool, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpsertConditionAndSendEvent(ctx context.Context, log util.Logger, condition metav1.Condition, ...) (bool, error)

+ func (r *ResourceReconcilerBase[Status, T, ReplicaID, S]) UpsertStatus(ctx context.Context, log util.Logger) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL