controllers

Documentation

Overview

Copyright 2022, ForgeRock AS.

/ Manage Volume Snapshot Creation

Index

• Constants
• Variables
• type DirectoryBackupReconciler
  • func (r *DirectoryBackupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DirectoryBackupReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DirectoryRestoreReconciler
  • func (r *DirectoryRestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DirectoryRestoreReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DirectoryServiceReconciler
  • func (r *DirectoryServiceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DirectoryServiceReconciler) SetupWithManager(mgr ctrl.Manager) error

Constants

const (
	SnapshotApiGroupString = "snapshot.storage.k8s.io"
	// where we mount the PVC on the DS pod
	// TODO: Update when https://bugster.forgerock.org/jira/browse/OPENDJ-8372 is fixed
	DSDataPath = "/opt/opendj/data"
	// The path in the pod where PEM secrets are mounted
	MasterKeyPath     = "/var/run/secrets/ds-master-keypair"
	SSLKeyPath        = "/var/run/secrets/ds-ssl-keypair"
	TruststoreKeyPath = "/var/run/secrets/truststore"
)

const LabelApplicationName = "ds"

LabelApplicationName is the value for app.kubernetes.io/name. See https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/

const LastPasswordCheckAnnotation = "directory.forgerock.io/last-password-check"

annotation we add to the CR to record when we last checked the passwords to see if they are correct in the diretory

const PasswordCheckTimeSeconds = 300

PasswordCheckTimeSeconds is the number of seconds between password checks. This is to avoid overloading the directory with frequent password checks/changes

const PasswordUpdatedStatus = "password-updated-status"

const (
	SnapshotApiGroup = "snapshot.storage.k8s.io"
)

Variables

var DebugContainer = false

If DebugContainer is true, we inject debug init and sidecars into the DS pod. This is needed to chown the hostpath CSI volumes to the forgerock user.

var DevMode = false

DevMode is true if running outside of K8S. Port forward to localhost:1636 in development

var ForgeRockUser int64 = 11111

These need to be vars (not constants) as we use them in templates, and Go wants a pointer to the var, not a const.

var RootGroup int64 = 0

Types

type DirectoryBackupReconciler

type DirectoryBackupReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

DirectoryBackupReconciler reconciles a DirectoryBackup object

func (*DirectoryBackupReconciler) Reconcile

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

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.8.3/pkg/reconcile

func (*DirectoryBackupReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DirectoryRestoreReconciler

type DirectoryRestoreReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

DirectoryRestoreReconciler reconciles a DirectoryRestore object

func (*DirectoryRestoreReconciler) Reconcile

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

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.8.3/pkg/reconcile

func (*DirectoryRestoreReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DirectoryServiceReconciler

type DirectoryServiceReconciler struct {
	client.Client
	Scheme *runtime.Scheme
	// contains filtered or unexported fields
}

DirectoryServiceReconciler reconciles a DirectoryService object

func (*DirectoryServiceReconciler) Reconcile

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

Reconcile loop for DS controller

func (*DirectoryServiceReconciler) SetupWithManager

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

SetupWithManager stuff