controller

Documentation

Index

• Constants
• func CreateDefaultConfigurationConfigMap(ctx context.Context, c client.Client, namespace string) error
• func GetConfigurationData(ctx context.Context, c client.Client, namespace string) (map[string]string, error)
• type ClusterDeploymentReconciler
  • func (r *ClusterDeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ClusterDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ClusterInstanceReconciler
  • func (r *ClusterInstanceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ClusterInstanceReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ConfigurationMonitor
  • func (r *ConfigurationMonitor) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ConfigurationMonitor) SetupWithManager(mgr ctrl.Manager) error

Constants

const (
	DefaultDeletionRequeueDelay        = 1 * time.Minute
	DefaultValidationErrorDelay        = 30 * time.Second
	DefaultTemplateRenderingErrorDelay = 30 * time.Second
)

Default Requeue delays

const (
	// SiteConfigOperatorConfigMap defines the name of the ConfigMap used to manage
	// the SiteConfig Operator's runtime configuration.
	SiteConfigOperatorConfigMap = "siteconfig-operator-configuration"

	// RequeueDelay defines the default requeue delay on transient errors.
	RequeueDelay = 30 * time.Second
)

const ClusterInstanceFieldManager = "siteconfig-controller"

ClusterInstanceFieldManager is the field manager name used for Server-Side Apply operations

Functions

func CreateDefaultConfigurationConfigMap

func CreateDefaultConfigurationConfigMap(ctx context.Context, c client.Client, namespace string) error

CreateDefaultConfigurationConfigMap creates a ConfigMap with default configuration values in the given namespace.

func GetConfigurationData

func GetConfigurationData(ctx context.Context, c client.Client, namespace string) (map[string]string, error)

GetConfigurationData retrieves the data field of the specified ConfigMap.

Types

type ClusterDeploymentReconciler

type ClusterDeploymentReconciler struct {
	client.Client
	Log    *zap.Logger
	Scheme *runtime.Scheme
}

ClusterDeploymentReconciler reconciles a ClusterDeployment object to update the ClusterInstance cluster deployment status conditions

func (*ClusterDeploymentReconciler) Reconcile

func (r *ClusterDeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (*ClusterDeploymentReconciler) SetupWithManager

func (r *ClusterDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type ClusterInstanceReconciler

type ClusterInstanceReconciler struct {
	client.Client
	Scheme           *runtime.Scheme
	Recorder         record.EventRecorder
	Log              *zap.Logger
	TmplEngine       *ci.TemplateEngine
	ConfigStore      *configuration.ConfigurationStore
	DeletionHandler  *deletion.DeletionHandler
	ReinstallHandler *reinstall.ReinstallHandler
}

ClusterInstanceReconciler reconciles a ClusterInstance object

func (*ClusterInstanceReconciler) Reconcile

func (r *ClusterInstanceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state.

func (*ClusterInstanceReconciler) SetupWithManager

func (r *ClusterInstanceReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type ConfigurationMonitor

type ConfigurationMonitor struct {
	client.Client
	Log    *zap.Logger
	Scheme *runtime.Scheme

	// Namespace containing the ConfigMap
	Namespace string

	// Store for runtime configuration
	ConfigStore *configuration.ConfigurationStore
}

ConfigurationMonitor watches for changes to a specific ConfigMap and updates the SiteConfig Operator's runtime configuration accordingly.

func (*ConfigurationMonitor) Reconcile

func (r *ConfigurationMonitor) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile processes events for the SiteConfig Configuration ConfigMap, ensuring the runtime configuration remains synchronized. Creates a default Configuration ConfigMap if one does not exist.

func (*ConfigurationMonitor) SetupWithManager

func (r *ConfigurationMonitor) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager configures the controller to watch the SiteConfig configuration ConfigMap and process relevant events.