Skip to content

Commit f168a57

Browse files
committed
Reworked the index page to add more cards
1 parent ee6123e commit f168a57

8 files changed

Lines changed: 114 additions & 117 deletions

File tree

docs/app-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Get credentials for your app
22

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.
44

55
## Create one application user via Custom Resource
66

docs/architecture.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,13 @@ By default, the Operator creates Percona Server for MongoDB replica set with thr
4040

4141
## High availability
4242

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.
4446

4547
### Pod distribution
4648

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.
4850

4951
### Automatic recovery
5052

@@ -63,10 +65,7 @@ Applications should use a **mongodb+srv** connection URI. MongoDB drivers (4.2 a
6365

6466
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).
6567

66-
## What to read next
68+
## Next step
6769

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}

docs/compare.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,5 @@ Finally, let’s compare various features that are not a good fit for other cate
8181
| Helm | Yes | Yes | Yes, for operator only | Yes, for operator only | Yes, for operator only |
8282
| SSL/TLS | Yes | Yes | Enterprise only | Yes | Yes |
8383
| Create users/roles| Yes | Yes | No | Yes | Yes |
84+
85+
[Get started with the Operator](quickstart.md){.md-button}

docs/everest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Install Percona Server for MongoDB cluster using Everest
1+
# Install Percona Server for MongoDB cluster using Open Everest
22

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.
44

55
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.
77

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.
99

docs/features.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Protect your data with [Percona Backup for MongoDB (PBM)](backups.md), which run
2424
* **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.
2525
* **On-demand backups**[Create a backup](backups-ondemand.md) at any time for critical operations.
2626
* **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.
2728
* **Point-in-time recovery**[Store oplog and restore to a point in time](backups-pitr.md).
2829
* **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.
2930

@@ -40,7 +41,7 @@ Scale your database infrastructure as demand grows:
4041

4142
Keep your data and backups secure with built-in options:
4243

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).
4445
* **Data-at-rest encryption**[Encrypt MongoDB data on disk](encryption.md).
4546
* **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.
4647
* **Backup encryption**[Encrypt backups](backups-encryption.md) in object storage.
@@ -70,12 +71,10 @@ Here is what happens under the hood:
7071
This declarative approach means you describe what you want, and the Operator handles the orchestration so your database cluster matches your specification.
7172

7273
[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}
7475

75-
## What's next?
76+
## Next steps
7677

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.
79+
80+
[Get started](quickstart.md){.md-button}

docs/how-it-works.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# How the Operator works
22

3-
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.
44

55
## Extending the Kubernetes API
66

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:
88

99
* **PerconaServerMongoDB** for the database cluster
1010
* **PerconaServerMongoDBBackup** for backups
@@ -15,20 +15,29 @@ These Custom Resources are defined by the Custom Resource Definitions (CRD), whi
1515
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:
1616

1717
* Creates and manages the necessary Kubernetes resources (StatefulSets, Services, Pods)
18-
* Ensures your cluster matches the desired state youve defined
18+
* Ensures your cluster matches the desired state you've defined
1919
* Monitors the cluster health and automatically recovers from failures
2020
* Coordinates upgrades and scaling operations
2121

2222
These operations ensure that your actual database environment always matches your request.
2323

2424
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.
2525

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
2731

2832
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).
2933

3034
## Next steps
3135

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)

docs/index.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,41 +21,64 @@ Choose how you want to use the Operator:
2121

2222
---
2323

24-
## Featured topics
24+
<div data-grid markdown>
25+
<div data-banner markdown>
2526

26-
Pick the topic that matches what you need to do:
27+
## :fontawesome-solid-magnifying-glass: Understand the Operator { .title }
2728

28-
<div data-grid markdown><div data-banner markdown>
29+
Understand how the Operator works, how it’s designed, and how it compares to other ways to run MongoDB on Kubernetes.
2930

30-
## :fontawesome-solid-magnifying-glass: Discover the Operator { .title }
31+
* [How the Operator works](how-it-works.md)
32+
* [Features](features.md)
33+
* [Architecture](architecture.md)
34+
* [Compare with other solutions](compare.md)
3135

32-
Understand how the Operator works, how it’s designed, and how it compares to other ways to run MongoDB on Kubernetes.
36+
</div><div data-banner markdown>
3337

34-
[How the Operator works :material-arrow-right:](how-it-works.md){ .md-button }
38+
## :material-progress-download: Set up the Operator and the database { .title }
39+
40+
Ready to run robust, production-grade Percona Server for MongoDB on Kubernetes? Install the Operator and learn how to easily manage daily operations.
41+
42+
* [Installation](install-overview.md)
43+
* [Manage users](users.md)
44+
* [Configure backups](backups.md)
45+
* [Scale your cluster](scaling.md)
46+
* [Monitor database health](monitoring.md)
47+
* [Upgrade](update.md)
3548

3649
</div><div data-banner markdown>
3750

38-
## :material-file-document-multiple: User guides { .title }
51+
## :material-file-document-multiple: User guides {.title}
3952

4053
Optimize your Kubernetes and database workflows with the Operator.
4154

42-
[User guides :material-arrow-right:](.md){ .md-button }
55+
* [Configure external access to the cluster](expose.md)
56+
* [Configure TLS](TLS.md)
57+
* [Encrypt data at rest](encryption.md)
58+
* [Set up disaster recovery with multi-cluster deployment](replication.md)
59+
4360

4461
</div><div data-banner markdown>
4562

46-
### :material-frequently-asked-questions: Troubleshooting { .title }
63+
### :fontawesome-solid-user-tie: Manage cluster lifecycle {.title}
4764

48-
Diagnose and fix issues with the Operator, the cluster, storage, or logs.
65+
Take control of your cluster's lifecycle. Follow these guides to keep your environment running smoothly with minimal downtime.
4966

50-
[Troubleshooting :material-arrow-right:](debug.md){.md-button}
67+
* [Upgrade](update.md)
68+
* [Pause and resume](pause.md)
69+
* [Migrate data using backups](backups-move-from-external-db.md)
5170

5271
</div><div data-banner markdown>
5372

54-
### :material-book-education: Reference { .title }
73+
### :material-book-education: Look up reference materials { .title }
5574

5675
Explore Custom Resource, backup and restore options, certified images and version compatibility.
5776

58-
[Custom Resource options :material-arrow-right:](operator.md){ .md-button }
77+
* [Custom Resource options :material-arrow-right:](operator.md)
78+
* [Backup Resource options](backup-resource-options.md.)
79+
* [Restore Resource options](restore-options.md.)
80+
* [Percona certified images](images.md)
81+
* [Version compatibility matrix](versions.md)
5982

6083
</div>
6184
</div>

0 commit comments

Comments
 (0)