https://github.com/polardb/polardbx-operator

polardbx-operator is a Kubernetes extension that aims to create and manage PolarDB-X cluster on Kubernetes.
https://github.com/polardb/polardbx-operator

cloud-native database k8s kubernetes operator polardb-x

Last synced: 6 days ago
JSON representation

polardbx-operator is a Kubernetes extension that aims to create and manage PolarDB-X cluster on Kubernetes.

• Host: GitHub
• URL: https://github.com/polardb/polardbx-operator
• Owner: polardb
• License: apache-2.0
• Created: 2021-10-16T05:53:07.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-18T08:05:21.000Z (4 months ago)
• Last Synced: 2024-07-21T08:57:08.142Z (4 months ago)
• Topics: cloud-native, database, k8s, kubernetes, operator, polardb-x
• Language: Go
• Homepage:
• Size: 5.36 MB
• Stars: 90
• Watchers: 14
• Forks: 30
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
PolarDB-X Operator

---

PolarDB-X Operator is a Kubernetes extension that aims to create and manage PolarDB-X cluster on Kubernetes. It follows

the [operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) and automates the management

tasks.

## Quick Start

Follow the [快速开始](https://doc.polardbx.com/quickstart/topics/quickstart-k8s.html) guide to start a testing Kubernetes cluster and play with PolarDB-X Operator.

## Documentation

Please refer to the [CHANGELOG](./CHANGELOG.md) for the notable changes for each version.**

Refer to the documentations for more details, such as CRD definitions and operation guides.

+ [简体中文](https://doc.polardbx.com/quickstart/topics/quickstart-k8s.html)

+ [English](https://doc.polardbx.com/en/quickstart/topics/quickstart-k8s.html)

如对文档有疑问，可提Issue或者Pull Request到[文档仓库](https://github.com/polardb/polardbx-operator-docs)

## Roadmap

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] Dashboard

+ ...

## License

PolarDB-X operator is distributed under the Apache License (Version 2.0). See the [LICENSE](./LICENSE) file for details.

This product contains various third-party components under other open source licenses.

See the [NOTICE](./NOTICE.md) file for more information.