ivorycluster

Documentation

Index

• Constants
• type Instance
  • func (i Instance) IsAvailable() (available bool, known bool)
  • func (i Instance) IsPrimary() (primary bool, known bool)
  • func (i Instance) IsReady() (ready bool, known bool)
  • func (i Instance) IsRunning(container string) (running bool, known bool)
  • func (i Instance) IsTerminating() (terminating bool, known bool)
  • func (i Instance) IsWritable() (writable, known bool)
  • func (i Instance) PodMatchesPodTemplate() (matches bool, known bool)
• type Reconciler
  • func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)
  • func (r *Reconciler) SetupWithManager(mgr manager.Manager) error
• type RepoResources

Constants

const (
	// ConditionIvoryDataInitialized is the type used in a condition to indicate whether or not the
	// IvoryCluster's IvorySQL data directory has been initialized (e.g. via a restore)
	ConditionIvoryDataInitialized = "IvoryDataInitialized"

	// ConditionManualBackupSuccessful is the type used in a condition to indicate whether or not
	// the manual backup for the current backup ID (as provided via annotation) was successful
	ConditionManualBackupSuccessful = "PGBackRestManualBackupSuccessful"

	// ConditionReplicaCreate is the type used in a condition to indicate whether or not
	// pgBackRest can be utilized for replica creation
	ConditionReplicaCreate = "PGBackRestReplicaCreate"

	// ConditionReplicaRepoReady is the type used in a condition to indicate whether or not
	// the pgBackRest repository for creating replicas is ready
	ConditionReplicaRepoReady = "PGBackRestReplicaRepoReady"

	// ConditionRepoHostReady is the type used in a condition to indicate whether or not a
	// pgBackRest repository host IvoryCluster is ready
	ConditionRepoHostReady = "PGBackRestRepoHostReady"

	// ConditionPGBackRestRestoreProgressing is the type used in a condition to indicate that
	// and in-place pgBackRest restore is in progress
	ConditionPGBackRestRestoreProgressing = "PGBackRestoreProgressing"

	// EventRepoHostNotFound is used to indicate that a pgBackRest repository was not
	// found when reconciling
	EventRepoHostNotFound = "RepoDeploymentNotFound"

	// EventRepoHostCreated is the event reason utilized when a pgBackRest repository host is
	// created
	EventRepoHostCreated = "RepoHostCreated"

	// EventUnableToCreateStanzas is the event reason utilized when pgBackRest is unable to create
	// stanzas for the repositories in a IvorySQL cluster
	EventUnableToCreateStanzas = "UnableToCreateStanzas"

	// EventStanzasCreated is the event reason utilized when a pgBackRest stanza create command
	// completes successfully
	EventStanzasCreated = "StanzasCreated"

	// EventUnableToCreatePGBackRestCronJob is the event reason utilized when a pgBackRest backup
	// CronJob fails to create successfully
	EventUnableToCreatePGBackRestCronJob = "UnableToCreatePGBackRestCronJob"

	// ReasonReadyForRestore is the reason utilized within ConditionPGBackRestRestoreProgressing
	// to indicate that the restore Job can proceed because the cluster is now ready to be
	// restored (i.e. it has been properly prepared for a restore).
	ReasonReadyForRestore = "ReadyForRestore"
)

const (
	// ControllerName is the name of the IvoryCluster controller
	ControllerName = "ivorycluster-controller"
)

Types

type Instance

type Instance struct {
	Name   string
	Pods   []*corev1.Pod
	Runner *appsv1.StatefulSet
	Spec   *v1beta1.IvoryInstanceSetSpec
}

Instance represents a single IvorySQL instance of a IvoryCluster.

func (Instance) IsAvailable

func (i Instance) IsAvailable() (available bool, known bool)

IsAvailable is used to choose which instances to redeploy during rolling update. It combines information from metadata and status similar to the notion of "available" in corev1.Deployment and "healthy" in appsv1.StatefulSet.

func (Instance) IsPrimary

func (i Instance) IsPrimary() (primary bool, known bool)

IsPrimary returns whether or not this instance is the Patroni leader.

func (Instance) IsReady

func (i Instance) IsReady() (ready bool, known bool)

IsReady returns whether or not this instance is ready to receive IvorySQL connections.

func (Instance) IsRunning

func (i Instance) IsRunning(container string) (running bool, known bool)

IsRunning returns whether or not container is running.

func (Instance) IsTerminating

func (i Instance) IsTerminating() (terminating bool, known bool)

IsTerminating returns whether or not this instance is in the process of not running.

func (Instance) IsWritable

func (i Instance) IsWritable() (writable, known bool)

IsWritable returns whether or not a IvorySQL connection could write to its database.

func (Instance) PodMatchesPodTemplate

func (i Instance) PodMatchesPodTemplate() (matches bool, known bool)

PodMatchesPodTemplate returns whether or not the Pod for this instance matches its specified PodTemplate. When it does not match, the Pod needs to be redeployed.

type Reconciler

type Reconciler struct {
	Client      client.Client
	Owner       client.FieldOwner
	Recorder    record.EventRecorder
	Tracer      trace.Tracer
	IsOpenShift bool

	PodExec func(
		namespace, pod, container string,
		stdin io.Reader, stdout, stderr io.Writer, command ...string,
	) error
}

Reconciler holds resources for the IvoryCluster reconciler

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(
	ctx context.Context, request reconcile.Request) (reconcile.Result, error,
)

Reconcile reconciles a ConfigMap in a namespace managed by the IvorySQL Operator

func (*Reconciler) SetupWithManager

func (r *Reconciler) SetupWithManager(mgr manager.Manager) error

SetupWithManager adds the IvoryCluster controller to the provided runtime manager

type RepoResources

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

RepoResources is used to store various resources for pgBackRest repositories and repository hosts