You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/app-credentials.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Get credentials for your app
2
2
3
-
For production and for most applications, you should use a dedicated **application-level (unprivileged) user** instead of the database admin account. The Operator can create this user for you and store the credentials in a Kubernetes Secret that your app can read.
3
+
For production and for most applications, you should use a dedicated **application-level (unprivileged) user** instead of the [database admin account](system-users.md). The Operator can create this user for you and store the credentials in a Kubernetes Secret that your app can read.
4
4
5
5
## Create one application user via Custom Resource
Copy file name to clipboardExpand all lines: docs/architecture.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,11 +40,13 @@ By default, the Operator creates Percona Server for MongoDB replica set with thr
40
40
41
41
## High availability
42
42
43
-
The Operator supports high availability through replica set topology, Pod distribution, automatic recovery, and client connectivity.
43
+
High-availability is natively supported via Percona Server for MongoDB replica set or sharded cluster topology.
44
+
45
+
The Operator adds to it through replica set topology, Pod distribution, automatic recovery, and client connectivity.
44
46
45
47
### Pod distribution
46
48
47
-
The Operator uses [node affinity and anti-affinity](constraints.md) to spread MongoDB Pods across separate worker nodes when possible. That way a single node failure does not take down multiple replica set members. You can tune affinity rules in the PerconaServerMongoDB custom resource.
49
+
The Operator uses [node affinity and anti-affinity](constraints.md) to spread MongoDB Pods across separate worker nodes when possible. That way a single node failure does not take down multiple replica set members. You can [tune affinity](constraints.md) rules in the `PerconaServerMongoDB` custom resource.
48
50
49
51
### Automatic recovery
50
52
@@ -63,10 +65,7 @@ Applications should use a **mongodb+srv** connection URI. MongoDB drivers (4.2 a
63
65
64
66
The Operator applies security settings that are stricter than default Percona Server for MongoDB. The initial configuration includes default passwords for required user accounts; change them in production as described in the [installation instructions](System-Requirements.md#installation-guidelines).
65
67
66
-
## What to read next
68
+
## Next step
67
69
68
-
-[About backups](backups.md) — How backups and restores work with PBM
69
-
-[Scale the cluster](scaling.md) — Scale your cluster vertically or horizontally
70
-
*[Control Pod placement](constraints.md) — Configure anti-affinity and pod distribution
71
-
*[Upgrade the Operator and database](update.md) — Keep your cluster up to date
72
-
*[Custom Resource options](operator.md) — Description of available configuration options
70
+
[Get started with the Operator](quickstart.md){.md-button}
71
+
[Compare with other solutions](compare.md){.md-button}
# Install Percona Server for MongoDB cluster using Everest
1
+
# Install Percona Server for MongoDB cluster using Open Everest
2
2
3
-
[Percona Everest :octicons-link-external-16: :octicons-link-external-16:](https://docs.percona.com/everest/) is an open source cloud-native database platform that helps developers deploy code faster, scale deployments rapidly, and reduce database administration overhead while regaining control over their data, database configuration, and DBaaS costs.
3
+
[Open Everest :octicons-link-external-16:](https://openeverest.io) is an open source cloud-native database platform that helps developers deploy code faster, scale deployments rapidly, and reduce database administration overhead while regaining control over their data, database configuration, and DBaaS costs.
4
4
5
5
It automates day-one and day-two database operations for open source databases on Kubernetes clusters.
6
-
Percona Everest provides API and Web GUI to launch databases with just a few clicks and scale them, do routine maintenance tasks, such as software updates, patch management, backups, and monitoring.
6
+
Open Everest provides API and Web GUI to launch databases with just a few clicks and scale them, do routine maintenance tasks, such as software updates, patch management, backups, and monitoring.
7
7
8
-
You can try it in action by [Installing Percona Everest :octicons-link-external-16: :octicons-link-external-16:](https://docs.percona.com/everest/quickstart-guide/qs-overview.html) and [managing your first cluster :octicons-link-external-16: :octicons-link-external-16:](https://docs.percona.com/everest/use/cluster-management.html).
8
+
Refer to [Open Everest documentation :octicons-link-external-16:](https://openeverest.io/docs/) to try it in action.
Copy file name to clipboardExpand all lines: docs/features.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@ Protect your data with [Percona Backup for MongoDB (PBM)](backups.md), which run
24
24
***Scheduled backups** — [Configure scheduled backups](backups-scheduled.md) with [remote storage](backups-storage.md) (S3, GCS, Azure, MinIO, or a file server) and retention policies.
25
25
***On-demand backups** — [Create a backup](backups-ondemand.md) at any time for critical operations.
26
26
***Logical and physical backups** — Use logical backups for portability or physical backups (including [physical incremental](backups.md#backup-types)) for faster restore on large datasets.
27
+
***PVC snapshots** to boost your backup and restore performance.
27
28
***Point-in-time recovery** — [Store oplog and restore to a point in time](backups-pitr.md).
28
29
***Restore** — [Restore on the same cluster or a new cluster](backups-restore.md); [replica set name remapping](backups-restore-replset-remapping.md) is supported when needed.
29
30
@@ -40,7 +41,7 @@ Scale your database infrastructure as demand grows:
40
41
41
42
Keep your data and backups secure with built-in options:
42
43
43
-
***Transport encryption** — [Enable TLS](TLS.md) for client and server; use [cert-manager](tls-cert-manager.md) or [manual certificates](tls-manual.md).
44
+
***Transport encryption** — [Enable TLS](TLS.md) for client and server; use [cert-manager](tls-cert-manager.md) or [custom certificates](tls-manual.md).
44
45
***Data-at-rest encryption** — [Encrypt MongoDB data on disk](encryption.md).
45
46
***Users and roles** — Manage [application users](app-users.md) and [system users](system-users.md); optionally use [Vault](system-users-vault.md) for system user credentials.
46
47
***Backup encryption** — [Encrypt backups](backups-encryption.md) in object storage.
@@ -70,12 +71,10 @@ Here is what happens under the hood:
70
71
This declarative approach means you describe what you want, and the Operator handles the orchestration so your database cluster matches your specification.
71
72
72
73
[Explore the architecture](architecture.md){.md-button}
73
-
[Comparison with other solutions](compare.md){.md-button}
74
+
[Compare with other solutions](compare.md){.md-button}
74
75
75
-
## What's next?
76
+
## Next steps
76
77
77
-
*[Get started](quickstart.md) — Get up and running in minutes, whether you build and application or need to deploy and operate the database
78
-
*[Single- and multi-namespace deployment](single-namespace-and-multi-namespace-deployment.md) — Understand your required deployment mode
79
-
*[Backups and restores](backups.md) — Protect your data with automated backups
80
-
*[Monitor with PMM](monitoring.md) — Gain visibility into database performance
81
-
*[TLS and security](TLS.md) — Secure client and server communications
78
+
Get up and running in minutes, whether you build and application or need to deploy and operate the database.
The Percona Operator for MongoDB is a custom controller. It automates deployment and management of Percona Server for MongoDB on Kubernetes. This page explains how the Operator fits into Kubernetes and how it keeps your database cluster in the state you define.
3
+
The Percona Operator for MongoDB is a custom controller. It is deployed as a Deployment. The Operator automates deployment and management of Percona Server for MongoDB on Kubernetes. This page explains how the Operator fits into Kubernetes and how it keeps your database cluster in the state you define.
4
4
5
5
## Extending the Kubernetes API
6
6
7
-
The Operator extends the Kubernetes API with a set of custom resources:
7
+
The Operator extends the Kubernetes API with a set of Custom Resources:
8
8
9
9
***PerconaServerMongoDB** for the database cluster
10
10
***PerconaServerMongoDBBackup** for backups
@@ -15,20 +15,29 @@ These Custom Resources are defined by the Custom Resource Definitions (CRD), whi
15
15
Then you describe the database you want by creating or updating a `PerconaServerMongoDB` object in `deploy/cr.yaml`. At this point, the Operator steps in and handles the hard work for you. It automatically does the following:
16
16
17
17
* Creates and manages the necessary Kubernetes resources (StatefulSets, Services, Pods)
18
-
* Ensures your cluster matches the desired state you’ve defined
18
+
* Ensures your cluster matches the desired state you've defined
19
19
* Monitors the cluster health and automatically recovers from failures
20
20
* Coordinates upgrades and scaling operations
21
21
22
22
These operations ensure that your actual database environment always matches your request.
23
23
24
24
Each `PerconaServerMongoDB` object corresponds to a single Percona Server for MongoDB setup - either a replica set or a sharded cluster. The Operator does not manage MongoDB servers that were created without using these custom resources.
25
25
26
-
By default, the Operator creates Percona Server for MongoDB replica set with three members, one primary and the remaining secondaries. This is the minimal recommended configuration and it natively provides high availability. A replica set can have up to 50 members with the maximum of 7 voting members.
26
+
## Default database deployment
27
+
28
+
By default, the Operator creates Percona Server for MongoDB replica set with three members: one primary and the remaining secondaries. This is the minimal recommended configuration and it natively provides high availability. A replica set can have up to 50 members with the maximum of 7 voting members. Read more about these requirements in [MongoDB documentation :octicons-link-external-16:](https://www.mongodb.com/docs/manual/core/replica-set-architectures/#strategies).
29
+
30
+
## Storage
27
31
28
32
To keep your data safe and persistent, the Operator uses Kubernetes storage systems called Persistent Volumes (PVs) and PersistentVolumeClaims (PVCs). When you request storage for your database, a PVC automatically finds and attaches available storage for you. If a node fails, the Kubernetes storage system can move your data to another node, making sure your database remains available and your data stays protected. For local or special storage needs, see [Local Storage](storage.md).
29
33
30
34
## Next steps
31
35
32
-
-[Design and architecture](architecture.md) — Components (mongod, PBM, mongos), replica set and sharding, and high availability.
33
-
-[Features and capabilities](features-and-capabilities.md) — What you can do with the Operator (backups, scaling, TLS, and more).
34
-
-[Custom Resource options](operator.md) — All options you can set in the PerconaServerMongoDB spec.
36
+
Ready to get started? Continue to the [quickstart guide](quickstart.md) to deploy your first cluster. Or, explore the [architecture overview](architecture.md) to understand the inner workings of the Operator.
37
+
38
+
[Quickstart guide](quickstart.md){.md-button}
39
+
40
+
## Useful links
41
+
42
+
-[Design and architecture](architecture.md)
43
+
-[Features and capabilities](features-and-capabilities.md)
0 commit comments