Skip to content

Commit 594c829

Browse files
fiowrodelgod
authored andcommitted
K8SPSMDB-417 update readme file
1 parent 637cbf4 commit 594c829

File tree

2 files changed

+31
-20
lines changed

2 files changed

+31
-20
lines changed

README.md

+31-20
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,43 @@
1-
# Percona Server for MongoDB Operator
1+
![Percona Kubernetes Operator for Percona Server for MongoDB](operator.png)
22

3-
[![Build Status](https://travis-ci.org/percona/percona-server-mongodb-operator.svg?branch=main)](https://travis-ci.org/percona/percona-server-mongodb-operator)
4-
[![Go Report Card](https://goreportcard.com/badge/github.com/percona/percona-server-mongodb-operator)](https://goreportcard.com/report/github.com/percona/percona-server-mongodb-operator)
3+
[Percona Server for MongoDB](https://www.percona.com/software/mongodb/percona-server-for-mongodb) (PSMDB) is an open-source enterprise MongoDB 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.
54

6-
A Kubernetes operator for [Percona Server for MongoDB](https://www.percona.com/software/mongo-database/percona-server-for-mongodb) based on the [Operator SDK](https://github.com/operator-framework/operator-sdk).
5+
Based on our best practices for deployment and configuration, [Percona Kubernetes Operator for PSMDB](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/index.html) contains everything you need to quickly and consistently deploy and scale Percona Server for MongoDB instances into a Kubernetes cluster on-premises or in the cloud. It provides the following capabilities:
76

8-
# Documentation
9-
See the [Official Documentation](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/) for more information.
7+
* Easy deployment with no single point of failure
8+
* Sharding support
9+
* Scheduled and manual backups
10+
* Integrated monitoring with [Percona Monitoring and Management](https://www.percona.com/software/database-tools/percona-monitoring-and-management)
11+
* Smart Update to keep your database software up to date automatically
12+
* Automated Password Rotation – use the standard Kubernetes API to enforce password rotation policies for system user
13+
* Private container image registries
1014

11-
[![Official Documentation](https://via.placeholder.com/260x60/419bdc/FFFFFF/?text=Documentation)](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/)
15+
# Architecture
1216

13-
## Submitting Bug Reports
17+
Percona Operators are based on the [Operator SDK](https://github.com/operator-framework/operator-sdk) and leverage Kubernetes primitives to follow best CNCF practices.
1418

15-
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.
19+
Please read more about architecture and design decisions [here](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/architecture.html).
1620

17-
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.
21+
# Installation
1822

19-
If there is no existing report, submit a report following these steps:
23+
It usually takes two steps to deploy Percona Server for MongoDB on Kubernetes:
2024

21-
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.
22-
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)
23-
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.
25+
* Deploy the operator from `deploy/bundle.yaml`
26+
* Deploy the database cluster itself from `deploy/cr.yaml`
2427

25-
An excellent resource is [Elika Etemad's article on filing good bug reports.](http://fantasai.inkedblade.net/style/talks/filing-good-bugs/).
28+
See full documentation with examples and various advanced cases on [percona.com](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/index.html).
2629

27-
As a general rule of thumb, please try to create bug reports that are:
30+
# Contributing
31+
32+
Percona welcomes and encourages community contributions to help improve Percona Kubernetes Operator for Percona XtraDB Cluster.
33+
34+
See the [Contribution Guide](CONTRIBUTING.md) and [Building and Testing Guide](e2e-tests/README.md) for more information.
35+
36+
# Roadmap
37+
38+
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).
39+
40+
# Submitting Bug Reports
41+
42+
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. Learn more about submitting bugs, new features ideas and improvements in the [Contribution Guide](CONTRIBUTING.md).
2843

29-
- *Reproducible.* Include steps to reproduce the problem.
30-
- *Specific.* Include as much detail as possible: which version, what environment, etc.
31-
- *Unique.* Do not duplicate existing tickets.
32-
- *Scoped to a Single Bug.* One bug per report.

operator.png

25.7 KB
Loading

0 commit comments

Comments
 (0)