README
¶
Percona Operator for MongoDB
Percona Operator for MongoDB deploys and manages Percona Server for MongoDB on Kubernetes with ease. Automate deployments, scaling, and day-to-day operations for both replica sets and sharded clusters. Deploy with confidence and focus on your applications, not your database.
- Automated workflows for simplified management
- High availability with no single point of failure
- Easy sharding and scaling
- Integrated backups and monitoring
- Automated updates and password rotation
- Support for private container registries
While the Percona Operator is primarily managed through the command line, you can also use Percona Everest for a web-based user interface. This open-source tool provides a streamlined experience for provisioning and managing your databases, simplifying day-to-day tasks and reducing administrative overhead. Learn more about Percona Everest in the documentation or jump right in with the quickstart guide.
Architecture
Percona Operators are based on the Operator SDK and leverage Kubernetes primitives to follow best CNCF practices.
Learn more about architecture and design decisions.
Documentation
To learn more about the Operator, check the Percona Operator for MongoDB documentation.
Quickstart installation
Ready to try out the Operator? Check the Quickstart tutorial for easy-to follow steps.
Below is one of the ways to deploy the Operator using kubectl.
kubectl
- Deploy the operator from
deploy/bundle.yaml:
kubectl apply --server-side -f https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/main/deploy/bundle.yaml
- Deploy the database cluster itself from
deploy/cr.yaml
kubectl apply -f https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/main/deploy/cr-minimal.yaml
Need help?
| Commercial Support | Community Support |
|---|---|
Enterprise-grade assistance for your mission-critical MongoDB deployments with the Percona Operator for MongoDB. Get expert guidance for complex tasks like multi-cloud replication, database migration and building platforms. |
Connect with our engineers and fellow users for general questions, troubleshooting, and sharing feedback and ideas. |
| Get Percona Support | Visit our Forum |
Contributing
Percona welcomes and encourages community contributions to help improve Percona Kubernetes Operator for Percona Server for MongoDB.
See the Contribution Guide and Building and Testing Guide for more information on how you can contribute.
Roadmap
We have a public roadmap which can be found here. Please feel free to contribute and propose new features by following the roadmap guidelines.
Submitting Bug Reports
If you find a bug in Percona Docker Images or in one of the related projects, please submit a report to that project's JIRA issue tracker or create a GitHub issue in this repository.
Learn more about submitting bugs, new features ideas and improvements in the Contribution Guide.
Directories
¶
| Path | Synopsis |
|---|---|
|
fake
Package fake provides a fake implementation of clientcmd.Client for use in tests.
|
Package fake provides a fake implementation of clientcmd.Client for use in tests. |
|
cmd
|
|
|
manager
command
|
|
|
mongodb-healthcheck
command
|
|
|
pkg
|
|
|
apis/psmdb/v1
Package v1 contains API Schema definitions for the psmdb v1 API group +k8s:deepcopy-gen=package,register +groupName=psmdb.percona.com
|
Package v1 contains API Schema definitions for the psmdb v1 API group +k8s:deepcopy-gen=package,register +groupName=psmdb.percona.com |
|
controller/perconaservermongodbbackup
Package perconaservermongodbbackup is a generated GoMock package.
|
Package perconaservermongodbbackup is a generated GoMock package. |
|
controller/perconaservermongodbrestore
Package perconaservermongodbrestore is a generated GoMock package.
|
Package perconaservermongodbrestore is a generated GoMock package. |