Skip to content

Commit 105f016

Browse files
authored
CLOUD-820 Added links to docs to README (#1424)
modified: README.md
1 parent ae7dd09 commit 105f016

File tree

1 file changed

+23
-31
lines changed

1 file changed

+23
-31
lines changed

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,69 +9,59 @@
99
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/percona/percona-server-mongodb-operator)
1010
[![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)
1111

12-
[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.
12+
[Percona Operator for MongoDB](https://github.com/percona/percona-server-mongodb-operator) automates the creation, modification, or deletion of items in your Percona Server for MongoDB environment. The Operator contains the necessary Kubernetes settings to maintain a consistent Percona Server for MongoDB instance, be it a replica set or a sharded cluster.
1313

14-
Based on our best practices for deployment and configuration, [Percona Operator for MongoDB](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:
14+
Based on our best practices for deployment and configuration, Percona Operator for MongoDB 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 features to keep your Percona Server for MongoDB deployment healthy:
1515

1616
- Easy deployment with no single point of failure
1717
- Sharding support
1818
- Scheduled and manual backups
1919
- 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
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
2222
- Private container image registries
2323

24-
# Architecture
25-
26-
Percona Operators are based on the [Operator SDK](https://github.com/operator-framework/operator-sdk) and leverage Kubernetes primitives to follow best CNCF practices.
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).
2725

28-
Please read more about architecture and design decisions [here](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/architecture.html).
29-
30-
# Quickstart installation
26+
# Architecture
3127

32-
## Helm
28+
Percona Operators are based on the [Operator SDK](https://github.com/operator-framework/operator-sdk) and leverage Kubernetes primitives to follow best [CNCF](https://www.cncf.io/) practices.
3329

34-
Install the Operator:
30+
Learn more about [architecture and design decisions](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/architecture.html).
3531

36-
```bash
37-
helm install my-op percona/psmdb-operator
38-
```
32+
## Documentation
3933

40-
Install Percona Server for MongoDB:
34+
To learn more about the Operator, check the [Percona Operator for MongoDB documentation](https://docs.percona.com/percona-operator-for-mongodb/index.html).
4135

42-
```bash
43-
helm install my-db percona/psmdb-db
44-
```
36+
# Quickstart installation
4537

46-
See more details in:
38+
Ready to try out the Operator? Check the [Quickstart tutorial](https://docs.percona.com/percona-operator-for-mongodb/quickstart.html) for easy-to follow steps.
4739

48-
- [Helm installation documentation](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/helm.html)
49-
- [Operator helm chart parameter reference](https://github.com/percona/percona-helm-charts/blob/main/charts/psmdb-operator)
50-
- [Percona Server for MongoDB helm chart parameters reference](https://github.com/percona/percona-helm-charts/blob/main/charts/psmdb-db)
40+
Below is one of the ways to deploy the Operator using `kubectl`.
5141

5242
## kubectl
5343

54-
It usually takes two steps to deploy Percona Server for MongoDB on Kubernetes:
55-
56-
Deploy the operator from `deploy/bundle.yaml`:
44+
1. Deploy the operator from `deploy/bundle.yaml`:
5745

5846
```sh
5947
kubectl apply --server-side -f https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/main/deploy/bundle.yaml
6048
```
6149

62-
Deploy the database cluster itself from `deploy/cr.yaml
50+
2. Deploy the database cluster itself from `deploy/cr.yaml
6351

6452
```sh
6553
kubectl apply -f https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/main/deploy/cr-minimal.yaml
6654
```
6755

68-
See full documentation with examples and various advanced cases on [percona.com](https://www.percona.com/doc/kubernetes-operator-for-psmongodb/index.html).
69-
7056
# Contributing
7157

7258
Percona welcomes and encourages community contributions to help improve Percona Kubernetes Operator for Percona Server for MongoDB.
7359

74-
See the [Contribution Guide](CONTRIBUTING.md) and [Building and Testing Guide](e2e-tests/README.md) for more information.
60+
See the [Contribution Guide](CONTRIBUTING.md) and [Building and Testing Guide](e2e-tests/README.md) for more information on how you can contribute.
61+
62+
## Communication
63+
64+
We would love to hear from you! Reach out to us on [Forum](https://forums.percona.com/c/mongodb/percona-kubernetes-operator-for-mongodb/29) with your questions, feedback and ideas
7565

7666
# Join Percona Kubernetes Squad!
7767
```
@@ -99,4 +89,6 @@ We have an experimental public roadmap which can be found [here](https://github.
9989

10090
# Submitting Bug Reports
10191

102-
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/projects/K8SPSMDB/issues/K8SPSMDB-555?filter=allopenissues) issue tracker. Learn more about submitting bugs, new features ideas and improvements in the [Contribution Guide](CONTRIBUTING.md).
92+
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/projects/K8SPSMDB/issues/K8SPSMDB-555?filter=allopenissues) 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.
93+
94+
Learn more about submitting bugs, new features ideas and improvements in the [Contribution Guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)