controllers

Documentation

Overview

Package controllers contains a set of controllers for DBaaS

Index

• Constants
• type ClusterType
• type DatabaseClusterBackupReconciler
  • func (r *DatabaseClusterBackupReconciler) Reconcile(ctx context.Context, _ ctrl.Request) (ctrl.Result, error)
  • func (r *DatabaseClusterBackupReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DatabaseClusterRestoreReconciler
  • func (r *DatabaseClusterRestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DatabaseClusterRestoreReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DatabaseEngineReconciler
  • func (r *DatabaseEngineReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DatabaseEngineReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DatabaseReconciler
  • func (r *DatabaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DatabaseReconciler) SetupWithManager(mgr ctrl.Manager) error
• type Matrix
• type Version
  • func NewVersion(v string) (*Version, error)
  • func (v *Version) String() string
  • func (v *Version) ToAPIVersion(apiRoot string) string
  • func (v *Version) ToCRVersion() string
  • func (v *Version) ToSemver() string
• type VersionResponse
• type VersionService
  • func NewVersionService() *VersionService
  • func (v *VersionService) GetVersions(engineType dbaasv1.EngineType, operatorVersion string) (*Matrix, error)

Constants

const (
	// PerconaXtraDBClusterKind represents pxc kind.
	PerconaXtraDBClusterKind = "PerconaXtraDBCluster"
	// PerconaServerMongoDBKind represents psmdb kind.
	PerconaServerMongoDBKind = "PerconaServerMongoDB"
	// PerconaPGClusterKind represents postgresql kind.
	PerconaPGClusterKind = "PerconaPGCluster"

	// ClusterTypeEKS represents EKS cluster type.
	ClusterTypeEKS ClusterType = "eks"
	// ClusterTypeMinikube represents minikube cluster type.
	ClusterTypeMinikube ClusterType = "minikube"
)

Types

type ClusterType

type ClusterType string

ClusterType used to understand the underlying platform of k8s cluster.

type DatabaseClusterBackupReconciler

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

DatabaseClusterBackupReconciler reconciles a DatabaseClusterBackup object.

func (*DatabaseClusterBackupReconciler) Reconcile

func (r *DatabaseClusterBackupReconciler) Reconcile(ctx context.Context, _ 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. Modify the Reconcile function to compare the state specified by the DatabaseClusterBackup object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

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

func (*DatabaseClusterBackupReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DatabaseClusterRestoreReconciler

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

DatabaseClusterRestoreReconciler reconciles a DatabaseClusterRestore object.

func (*DatabaseClusterRestoreReconciler) Reconcile

func (r *DatabaseClusterRestoreReconciler) 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 (*DatabaseClusterRestoreReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DatabaseEngineReconciler

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

DatabaseEngineReconciler reconciles a DatabaseEngine object.

func (*DatabaseEngineReconciler) Reconcile

func (r *DatabaseEngineReconciler) 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. For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.13.0/pkg/reconcile

func (*DatabaseEngineReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type DatabaseReconciler

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

DatabaseReconciler reconciles a Database object.

func (*DatabaseReconciler) Reconcile

func (r *DatabaseReconciler) 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. For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.12.2/pkg/reconcile

func (*DatabaseReconciler) SetupWithManager

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

SetupWithManager sets up the controller with the Manager.

type Matrix

type Matrix struct {
	Backup       map[string]*dbaasv1.Component `json:"backup"`
	Mongod       map[string]*dbaasv1.Component `json:"mongod"`
	PXC          map[string]*dbaasv1.Component `json:"pxc"`
	ProxySQL     map[string]*dbaasv1.Component `json:"proxysql"`
	HAProxy      map[string]*dbaasv1.Component `json:"haproxy"`
	LogCollector map[string]*dbaasv1.Component `json:"logCollector"`
	Postgresql   map[string]*dbaasv1.Component `json:"postgresql"`
	PGBackRest   map[string]*dbaasv1.Component `json:"pgbackrest"`
	PGBouncer    map[string]*dbaasv1.Component `json:"pgbouncer"`
}

Matrix represents the response from the version service.

type Version

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

Version is a wrapper around github.com/hashicorp/go-version that adds additional functions for developer's usability.

func NewVersion

func NewVersion(v string) (*Version, error)

NewVersion creates a new version from given string.

func (*Version) String

func (v *Version) String() string

String returns version string.

func (*Version) ToAPIVersion

func (v *Version) ToAPIVersion(apiRoot string) string

ToAPIVersion returns version that can be used as K8s APIVersion parameter.

func (*Version) ToCRVersion

func (v *Version) ToCRVersion() string

ToCRVersion returns version usable as CRversion parameter.

func (*Version) ToSemver

func (v *Version) ToSemver() string

ToSemver returns version is semver format.

type VersionResponse

type VersionResponse struct {
	Versions []struct {
		Matrix Matrix `json:"matrix"`
	} `json:"versions"`
}

VersionResponse is a response model for version service response parsing.

type VersionService

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

VersionService used for the integration with Percona Version Service.

func NewVersionService

func NewVersionService() *VersionService

NewVersionService creates a version service client.

func (*VersionService) GetVersions

func (v *VersionService) GetVersions(engineType dbaasv1.EngineType, operatorVersion string) (*Matrix, error)

GetVersions returns a matrix of available versions for a database engine.