Skip to content

Commit da2ae22

Browse files
lexfreiclaude
andcommitted
docs(mongodb): update documentation with images section and fixes
- Add full README content (deployment modes, notes sections) - Add Image configuration section (pmm, backup images) - Add configServerSize sharding parameter - Fix S3 credential defaults (empty instead of placeholder) Co-Authored-By: Claude <[email protected]> Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent e0c8929 commit da2ae22

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

content/en/docs/applications/mongodb.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,41 @@ metadata: https://github.com/cozystack/website/blob/main/content/en/docs/applica
1212
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/mongodb/README.md
1313
-->
1414

15-
Managed MongoDB service
15+
16+
MongoDB is a popular document-oriented NoSQL database known for its flexibility and scalability.
17+
The Managed MongoDB Service provides a self-healing replicated cluster managed by the Percona Operator for MongoDB.
18+
19+
## Deployment Details
20+
21+
This managed service is controlled by the Percona Operator for MongoDB, ensuring efficient management and seamless operation.
22+
23+
- Docs: <https://docs.percona.com/percona-operator-for-mongodb/>
24+
- Github: <https://github.com/percona/percona-server-mongodb-operator>
25+
26+
## Deployment Modes
27+
28+
### Replica Set Mode (default)
29+
30+
By default, MongoDB deploys as a replica set with the specified number of replicas.
31+
This mode is suitable for most use cases requiring high availability.
32+
33+
### Sharded Cluster Mode
34+
35+
Enable `sharding: true` for horizontal scaling across multiple shards.
36+
Each shard is a replica set, and mongos routers handle query routing.
37+
38+
## Notes
39+
40+
### External Access
41+
42+
When `external: true` is enabled:
43+
- **Replica Set mode**: Traffic is load-balanced across all replica set members. This works well for read operations, but write operations require connecting to the primary. MongoDB drivers handle primary discovery automatically using the replica set connection string.
44+
- **Sharded mode**: Traffic is routed through mongos routers, which handle both reads and writes correctly.
45+
46+
### Credentials
47+
48+
On first install, the credentials secret will be empty until the Percona operator initializes the cluster.
49+
Run `helm upgrade` after MongoDB is ready to populate the credentials secret with the actual password.
1650

1751
## Parameters
1852

@@ -31,13 +65,23 @@ Managed MongoDB service
3165
| `version` | MongoDB major version to deploy. | `string` | `v8` |
3266

3367

68+
### Image configuration
69+
70+
| Name | Description | Type | Value |
71+
| --------------- | -------------------------------------- | -------- | -------------------------------------- |
72+
| `images` | Container images used by the operator. | `object` | `{}` |
73+
| `images.pmm` | PMM client image for monitoring. | `string` | `percona/pmm-client:2.44.0` |
74+
| `images.backup` | Percona Backup for MongoDB image. | `string` | `percona/percona-backup-mongodb:2.8.0` |
75+
76+
3477
### Sharding configuration
3578

3679
| Name | Description | Type | Value |
3780
| ----------------------------------- | ------------------------------------------------------------------ | ---------- | ------- |
3881
| `sharding` | Enable sharded cluster mode. When disabled, deploys a replica set. | `bool` | `false` |
3982
| `shardingConfig` | Configuration for sharded cluster mode. | `object` | `{}` |
4083
| `shardingConfig.configServers` | Number of config server replicas. | `int` | `3` |
84+
| `shardingConfig.configServerSize` | PVC size for config servers. | `quantity` | `3Gi` |
4185
| `shardingConfig.mongos` | Number of mongos router replicas. | `int` | `2` |
4286
| `shardingConfig.shards` | List of shard configurations. | `[]object` | `[...]` |
4387
| `shardingConfig.shards[i].name` | Shard name. | `string` | `""` |
@@ -67,8 +111,8 @@ Managed MongoDB service
67111
| `backup.retentionPolicy` | Retention policy (e.g. "30d"). | `string` | `30d` |
68112
| `backup.destinationPath` | Destination path for backups (e.g. s3://bucket/path/). | `string` | `s3://bucket/path/to/folder/` |
69113
| `backup.endpointURL` | S3 endpoint URL for uploads. | `string` | `http://minio-gateway-service:9000` |
70-
| `backup.s3AccessKey` | Access key for S3 authentication. | `string` | `<your-access-key>` |
71-
| `backup.s3SecretKey` | Secret key for S3 authentication. | `string` | `<your-secret-key>` |
114+
| `backup.s3AccessKey` | Access key for S3 authentication. | `string` | `""` |
115+
| `backup.s3SecretKey` | Secret key for S3 authentication. | `string` | `""` |
72116

73117

74118
### Bootstrap (recovery) parameters
@@ -79,3 +123,4 @@ Managed MongoDB service
79123
| `bootstrap.enabled` | Whether to restore from a backup. | `bool` | `false` |
80124
| `bootstrap.recoveryTime` | Timestamp for point-in-time recovery; empty means latest. | `string` | `""` |
81125
| `bootstrap.backupName` | Name of backup to restore from. | `string` | `""` |
126+

0 commit comments

Comments
 (0)