providerperconaxtradbcluster

README

Percona XtraDB Cluster Provider

[!WARNING] Pre-alpha. OpenEverest v2 and this provider are under active development. CRD schemas, chart values and defaults change frequently, including in breaking ways, and there is no supported upgrade path between versions yet. Not for production use.

Run MySQL, clustered with Percona XtraDB Cluster, on Kubernetes through OpenEverest, backed by the Percona Operator for MySQL.

What this is

OpenEverest providers translate a single, technology-agnostic Instance custom resource into the native custom resources of an upstream Kubernetes operator — for databases, but equally for caches, message queues, object storage, or model-serving runtimes. This repository is the provider for Percona XtraDB Cluster: it owns the technology-specific knowledge — topologies, versions, parameters, backup wiring — so that users, the API server, and the UI stay technology-agnostic.

[!IMPORTANT] This provider is not standalone. It requires an OpenEverest installation (core CRDs and controller) in the cluster. Installing this chart on its own does nothing. See Install OpenEverest.

flowchart LR
    U([User / API / UI]) -->|creates| I["Instance<br/>core.openeverest.io"]
    I --> P["provider-percona-xtradb-cluster<br/>(this repository)"]
    P -->|reconciles into| O["PerconaXtraDBCluster<br/>pxc.percona.com/v1"]
    O --> W["Percona Operator for MySQL"]
    W --> R[("Workloads, Services,<br/>Secrets, PVCs")]
    P -->|status, endpoints,<br/>credentials| I

The provider watches Instance resources whose spec.providerRef.name is percona-xtradb-cluster, and reports workload health back onto Instance.status. It never manages pods directly — all lifecycle work is delegated to the operator.

Compatibility

provider-percona-xtradb-cluster	OpenEverest	Percona Operator for MySQL	Kubernetes
0.1.x	2.0.0-dev.2	1.20.x	1.30 – 1.34

Capabilities

What you can do to a running instance through the Instance API. Upgrading the provider itself is covered under Installation.

Capability	Status	Notes
Provisioning	✅
Horizontal scaling	✅	spec.components.<name>.replicas
Vertical scaling (CPU / memory)	✅	spec.components.<name>.resources
Version upgrades	✅	of the deployed MySQL version — change spec.version; see Versions
Custom configuration	✅	my.cnf via the engine component's configuration parameter
Monitoring	✅	PMM, via the optional monitoring component
TLS	⚠️	the operator provisions certificates, but the connection string reported on the Instance requests tls=false

Stateful workloads additionally report:

Capability	Status	Notes
Persistent storage	✅	spec.components.engine.storage
Storage expansion	✅	when the StorageClass allows volume expansion
Backups (on demand)	✅	operator-native (executionMode: ProviderManaged) via Percona XtraBackup
Backups (scheduled)	✅	per-storage schedules on spec.backup.storages[].schedules[]
Point-in-time recovery	✅	one storage may enable PITR
Restore	✅	in place, and into a new Instance via spec.dataSource

Installation

[!NOTE] There is no published chart yet. Until the first release, install from a checkout.

git clone https://github.com/openeverest/provider-percona-xtradb-cluster.git
cd provider-percona-xtradb-cluster
helm dependency build charts/provider-percona-xtradb-cluster
helm install provider-percona-xtradb-cluster charts/provider-percona-xtradb-cluster \
  --namespace everest-system

make helm-install does the same thing against your current kube context.

• The Percona Operator for MySQL is bundled as a chart dependency and is installed automatically.

Uninstall:

helm uninstall provider-percona-xtradb-cluster --namespace everest-system

Uninstalling the chart does not delete running Instance resources or their data.

Usage

Verify that the provider registered itself:

kubectl get providers.core.openeverest.io percona-xtradb-cluster

Create an instance:

apiVersion: core.openeverest.io/v1alpha1
kind: Instance
metadata:
  name: my-instance
spec:
  providerRef:
    name: percona-xtradb-cluster
  components:
    engine:
      type: pxc
      replicas: 3
      resources:
        requests:
          cpu: 500m
          memory: 2G
      storage:
        size: 10Gi
    proxy:
      type: haproxy
      replicas: 2

Component names are defined by this provider — see definition/provider.yaml. proxy is required in the cluster topology, with an explicit type (haproxy or proxysql) and at least one replica — unlike monitoring, it is not defaulted. spec.version and spec.topology are optional; the provider defaults apply. More examples live in examples/.

Watch it come up and read the connection details:

kubectl get instance my-instance -w
kubectl get instance my-instance -o jsonpath='{.status.connection}'

Credentials are in the secret named by .status.connection.credentialsSecretRef.

Topologies

Topology	Default	Description
cluster	✅	Galera cluster: 3 engine members by default, fronted by 2 proxy replicas

The proxy component defaults to HAProxy; ProxySQL images are also catalogued. The monitoring component is optional.

Versions

Version bundle	Default	pxc	backup (XtraBackup)	pmm
8.4.8	✅	8.4.8-8.1	8.4.0-5.1	3.8.0
8.4.7		8.4.7-7.1	8.4.0-5.1	3.8.0
8.4.5		8.4.5-5.1	8.4.0-5.1	3.8.0
8.0.45		8.0.45-36.1	8.0.35-35.1	3.8.0
8.0.44		8.0.44-35.1	8.0.35-35.1	3.8.0
8.0.42		8.0.42-33.1	8.0.35-35.1	3.8.0
8.0.41		8.0.41-32.1	8.0.35-35.1	3.8.0
8.0.39		8.0.39-30.1	8.0.35-35.1	3.8.0
5.7.44		5.7.44-31.65	2.4.29	3.8.0
5.7.42		5.7.42-31.65	2.4.29	3.8.0
5.7.39		5.7.39-31.61	2.4.29	3.8.0
5.7.36		5.7.36-31.55	2.4.29	3.8.0
5.7.34		5.7.34-31.51	2.4.29	3.8.0

Source of truth: definition/versions.yaml.

MySQL only supports upgrading one major version at a time (5.7 → 8.0 → 8.4), and the operator must already support the target version — upgrade the provider chart first.

Configuration

• Chart values: charts/provider-percona-xtradb-cluster/values.yaml
• Instance parameters: per-component and per-topology parameters schemas, defined under definition/ and published on the Provider resource (kubectl get provider percona-xtradb-cluster -o yaml). The API server and the UI validate user input against these schemas.

The technology-specific knobs worth knowing about:

Parameter	Applies to	Purpose
configuration	engine	Raw my.cnf configuration passed to the operator
monitoringConfigName	monitoring	PMM configuration to attach the instance to

Development

Requires Go (see go.mod), Docker, Helm, kubectl, and a Kubernetes cluster you can reach. dev/README.md covers the environment end to end: the recommended local k3d setup, running against a cluster you already have, and every dev/.env setting.

make dev-up             # local cluster + Tilt dev environment (see dev/README.md)
make generate           # RBAC, provider spec, Helm chart sync
make run                # run the provider locally against the cluster
make test-unit
make test-integration   # chainsaw suites under test/integration/
make dev-down

make help lists every target. make verify fails when generated files are stale — run make generate and commit the result.

The provider contract (Validate / Sync / Status / Cleanup), RBAC markers, watches, code generation, and the backup/restore interfaces are documented once for all providers in PROVIDER_DEVELOPMENT.md.

Layout

Path	Purpose
cmd/provider/	Entry point
internal/provider/	ProviderInterface implementation, backup interfaces, RBAC markers
internal/common/	Component name constants
definition/	Provider identity, component types, versions, topologies, backup classes
charts/provider-percona-xtradb-cluster/	Helm chart (generated/ is produced by make generate)
config/rbac/role.yaml	Generated ClusterRole — do not edit
examples/	Example Instance resources
dev/	Tilt dev environment, .env configuration, k3d cluster config
.github/workflows/	CI: lint, build, unit and integration tests, release

Testing

• Unit tests — make test-unit.
• Integration tests — make test-integration runs the chainsaw suites; individual suites are also exposed as make targets (make test-integration-core, make test-integration-backup, make test-integration-monitoring-pmm, …).
• CI — .github/workflows/ci.yaml runs lint, build, unit tests, generated-file verification, Helm lint, and each integration suite on every pull request.

Troubleshooting

kubectl logs -n everest-system deploy/provider-percona-xtradb-cluster -f

Symptom	Where to look
Instance stuck in Creating	kubectl describe instance <name> conditions, then the provider logs
No Provider resource in the cluster	Is the chart installed? Check the provider deployment logs
Instance ignored entirely	spec.providerRef.name must be percona-xtradb-cluster
PerconaXtraDBCluster created but no pods	Inspect the PerconaXtraDBCluster status — the failure is upstream in the operator
Backups never complete	Check the Backup resource status and the XtraBackup pod logs

Galera requires an odd number of members; single-node clusters are development-only.

Contributing

Issues and pull requests are welcome. See PROVIDER_DEVELOPMENT.md and the OpenEverest Code of Conduct.

Security

Report vulnerabilities per the OpenEverest security policy. Please do not open public issues for security reports.

License

Apache License 2.0 — see LICENSE for details.