github.com/percona/percona-xtradb-cluster-operator@v1.14.0/README.md (about) 1 # Percona Operator for MySQL based on Percona XtraDB Cluster 2 3  4 5 [](https://opensource.org/licenses/Apache-2.0) 6  7  8  9  10 [](https://goreportcard.com/report/github.com/percona/percona-xtradb-cluster-operator) 11 12 [Percona Operator for MySQL based on Percona XtraDB Cluster](https://docs.percona.com/percona-operator-for-mysql/pxc/index.html) (PXC) automates the creation and management of highly available, enterprise-ready MySQL database clusters on Kubernetes. 13 14 Within the [Percona Operator for MySQL based on Percona XtraDB Cluster](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html) we have implemented our best practices for deployment and configuration Percona XtraDB Cluster instances in a Kubernetes-based environment on-premises or in the cloud. The OPerator provides the following capabilities to keep the cluster healthy: 15 16 * Easy deployment with no single point of failure 17 * Load balancing and proxy service with either HAProxy or ProxySQL 18 * Scheduled and manual backups 19 * Integrated monitoring with [Percona Monitoring and Management](https://www.percona.com/software/database-tools/percona-monitoring-and-management) 20 * Smart Update to keep your database software up to date automatically 21 * Automated Password Rotation – use the standard Kubernetes API to enforce password rotation policies for system user 22 * Private container image registries 23 24 You interact with Percona Operator mostly via the command line tool. If you feel more comfortable with operating the Operator and database clusters via the web interface, there is [Percona Everest](https://docs.percona.com/everest/index.html) - an open-source web-based database provisioning tool available for you. It automates day-to-day database management operations for you, reducing the overall administrative overhead. [Get started with Percona Everest](https://docs.percona.com/everest/quickstart-guide/quick-install.html). 25 26 27 # Architecture 28 29 Percona Operators are based on the [Operator SDK](https://github.com/operator-framework/operator-sdk) and leverage Kubernetes primitives to follow best CNCF practices. 30 31 Please read more about [architecture and design decisions](https://www.percona.com/doc/kubernetes-operator-for-pxc/architecture.html). 32 33 ## Documentation 34 35 To learn more about the Operator, check the [Percona Operator for MySQL based on Percona XtraDB Cluster documentation](https://docs.percona.com/percona-operator-for-mysql/pxc/index.html). 36 37 # Quickstart installation 38 39 Ready to try out the Operator? Check the [Quickstart tutorial](https://docs.percona.com/percona-operator-for-mysql/pxc/quickstart.html) for easy-to follow steps. 40 41 Below is one of the ways to deploy the Operator using `kubectl`. 42 43 ## kubectl 44 45 1. Deploy the Operator from `deploy/bundle.yaml`: 46 47 ```sh 48 kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/main/deploy/bundle.yaml 49 ``` 50 51 2. Deploy the database cluster itself from `deploy/cr.yaml`: 52 53 ```sh 54 kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/main/deploy/cr.yaml 55 56 ``` 57 58 See full documentation with examples and various advanced cases on [percona.com](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html). 59 60 # Contributing 61 62 Percona welcomes and encourages community contributions to help improve Percona Operator for MySQL. 63 64 See the [Contribution Guide](CONTRIBUTING.md) and [Building and Testing Guide](e2e-tests/README.md) for more information on how you can contribute. 65 66 ## Communication 67 68 We would love to hear from you! Reach out to us on [Forum](https://forums.percona.com/c/mysql-mariadb/percona-kubernetes-operator-for-mysql/28) with your questions, feedback and ideas 69 70 # Join Percona Kubernetes Squad! 71 ``` 72 % _____ 73 %%% | __ \ 74 ###%%%%%%%%%%%%* | |__) |__ _ __ ___ ___ _ __ __ _ 75 ### ##%% %%%% | ___/ _ \ '__/ __/ _ \| '_ \ / _` | 76 #### ##% %%%% | | | __/ | | (_| (_) | | | | (_| | 77 ### #### %%% |_| \___|_| \___\___/|_| |_|\__,_| 78 ,((### ### %%% _ _ _____ _ 79 (((( (### #### %%%% | | / _ \ / ____| | | 80 ((( ((# ###### | | _| (_) |___ | (___ __ _ _ _ __ _ __| | 81 (((( (((# #### | |/ /> _ </ __| \___ \ / _` | | | |/ _` |/ _` | 82 /(( ,((( *### | <| (_) \__ \ ____) | (_| | |_| | (_| | (_| | 83 //// ((( #### |_|\_\\___/|___/ |_____/ \__, |\__,_|\__,_|\__,_| 84 /// (((( #### | | 85 /////////////(((((((((((((((((######## |_| Join @ percona.com/k8s 86 ``` 87 88 You can get early access to new product features, invite-only ”ask me anything” sessions with Percona Kubernetes experts, and monthly swag raffles. Interested? Fill in the form at [percona.com/k8s](https://www.percona.com/k8s). 89 90 # Roadmap 91 92 We have an experimental public roadmap which can be found [here](https://github.com/percona/roadmap/projects/1). Please feel free to contribute and propose new features by following the roadmap [guidelines](https://github.com/percona/roadmap). 93 94 # Submitting Bug Reports 95 96 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](https://jira.percona.com/browse/K8SPXC) issue tracker or [create a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository) in this repository. 97 98 Learn more about submitting bugs, new features ideas and improvements in the [Contribution Guide](CONTRIBUTING.md). 99