PolarDB-X Operator is a Kubernetes extension that aims to create and manage PolarDB-X cluster on Kubernetes. It follows the operator pattern and automates the management tasks.
Follow the [Quick Start / 快速开始] guide to start a testing Kubernetes cluster and play with PolarDB-X Operator.
NOTE: v1.2.0 introduces a breaking change to support the new xpaxos galaxyengine. Please refer to the CHANGELOG for upgrade guidance.
Refer to the documentations for more details, such as CRD definitions and operation guides.
There are many aspects of management activities. For now, only some are implemented. Here's a roadmap describing what features we have implemented and what we are going to implement and their (possible) priorities.
Implemented:
- ✅ Basic Lifetime Management
- ✅ Liveness/Readiness Probing & Self Healing
- ✅ Metrics Export and Grafana/Prometheus Integration
- ✅ Dynamic Configuration
- ✅ Scale and Upgrade
- ✅ Automated Data Rebalance
- ✅ Automated Failover
- ✅ Security and TLS
- ✅ Multiple Architecture Support: linux/amd64, linux/arm64
- ✅ Backup and Restore
- ✅ Log(Audit, Error) Collection
- ✅ Readonly instance
- ✅ Parameter Template and Configuration
- ✅ XStore Node Rebuild
Working in progress:
- [T0] Backup Plan
- [T1] Point in Time Recovery
- [T2] Dashboard
- ...
PolarDB-X operator is distributed under the Apache License (Version 2.0). See the LICENSE file for details.
This product contains various third-party components under other open source licenses. See the NOTICE file for more information.