forked from percona/percona-xtradb-cluster-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
K8SPXC-665 udpate readme file (percona#799)
- Loading branch information
Showing
2 changed files
with
33 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,45 @@ | ||
# Percona XtraDB Cluster Operator | ||
 | ||
|
||
A Kubernetes operator for [Percona XtraDB Cluster](https://www.percona.com/software/mysql-database/percona-xtradb-cluster) based on the [Operator SDK](https://github.com/operator-framework/operator-sdk). | ||
[](https://opensource.org/licenses/Apache-2.0) | ||
|
||
# Documentation | ||
See the [Official Documentation](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html) for more information. | ||
[Percona XtraDB Cluster](https://www.percona.com/software/mysql-database/percona-xtradb-cluster) (PXC) is an open-source enterprise MySQL solution that helps you to ensure data availability for your applications while improving security and simplifying the development of new applications in the most demanding public, private, and hybrid cloud environments. | ||
|
||
[](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html) | ||
Based on our best practices for deployment and configuration, [Percona Kubernetes Operator for PXC](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html) contains everything you need to quickly and consistently deploy and scale Percona XtraDB Cluster instances in a Kubernetes-based environment on-premises or in the cloud. It provides the following capabilities: | ||
|
||
## Submitting Bug Reports | ||
* Easy deployment with no single point of failure | ||
* Load balancing and proxy service with either HA Proxy or ProxySQL | ||
* Scheduled and manual backups | ||
* Integrated monitoring with [Percona Monitoring and Management](https://www.percona.com/software/database-tools/percona-monitoring-and-management) | ||
* Smart Update to keep your database software up to date automatically | ||
* Automated Password Rotation – use the standard Kubernetes API to enforce password rotation policies for system user | ||
* Private container image registries | ||
|
||
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) issue tracker. | ||
# Architecture | ||
|
||
Your first step should be [search](https://jira.percona.com/issues/?jql=project%20%3D%20%22Cloud%20Dev%22) for a similar report in the existing set of open tickets. If someone else has already reported your problem, upvote that report to increase its visibility. | ||
Percona Operators are based on the [Operator SDK](https://github.com/operator-framework/operator-sdk) and leverage Kubernetes primitives to follow best CNCF practices. | ||
|
||
If there is no existing report, submit a report following these steps: | ||
Please read more about architecture and design decisions [here](https://www.percona.com/doc/kubernetes-operator-for-pxc/architecture.html). | ||
|
||
1. [Sign in to Percona JIRA.](https://jira.percona.com/login.jsp) You will need to create an account if you do not have one. | ||
2. [Go to the Create Issue screen and select the relevant project.](https://jira.percona.com/secure/CreateIssueDetails!init.jspa?pid=12500&issuetype=1&priority=3) | ||
3. Fill in the fields of Summary, Description, Steps To Reproduce, and Affects Version to the best you can. If the bug corresponds to a crash, attach the stack trace from the logs. | ||
# Installation | ||
|
||
An excellent resource is [Elika Etemad's article on filing good bug reports.](http://fantasai.inkedblade.net/style/talks/filing-good-bugs/). | ||
It usually takes two steps to deploy Percona XtraDB Cluster on Kubernetes: | ||
|
||
As a general rule of thumb, please try to create bug reports that are: | ||
* Deploy the operator from `deploy/bundle.yaml` | ||
* Deploy the database cluster itself from `deploy/cr.yaml` | ||
|
||
- *Reproducible.* Include steps to reproduce the problem. | ||
- *Specific.* Include as much detail as possible: which version, what environment, etc. | ||
- *Unique.* Do not duplicate existing tickets. | ||
- *Scoped to a Single Bug.* One bug per report. | ||
See full documentation with examples and various advanced cases on [percona.com](https://www.percona.com/doc/kubernetes-operator-for-pxc/index.html). | ||
|
||
# Contributing | ||
|
||
Percona welcomes and encourages community contributions to help improve Percona Kubernetes Operator for Percona XtraDB Cluster. | ||
|
||
See the [Contribution Guide](CONTRIBUTING.md) and [Building and Testing Guide](e2e-tests/README.md) for more information. | ||
|
||
# Roadmap | ||
|
||
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). | ||
|
||
# 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](https://jira.percona.com/browse/K8SPXC) issue tracker. Learn more about submitting bugs, new features ideas and improvements in the [Contribution Guide](CONTRIBUTING.md). | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.