|
| 1 | +--- |
| 2 | +title: "Managed MongoDB Service" |
| 3 | +linkTitle: "MongoDB" |
| 4 | +weight: 65 |
| 5 | +aliases: |
| 6 | + - /docs/reference/applications/mongodb |
| 7 | +--- |
| 8 | + |
| 9 | +<!-- |
| 10 | +Autogenerated content. Don't edit this file directly; edit sources instead. |
| 11 | +metadata: https://github.com/cozystack/website/blob/main/content/en/docs/applications/_include/mongodb.md |
| 12 | +source: https://github.com/cozystack/cozystack/blob/main/packages/apps/mongodb/README.md |
| 13 | +--> |
| 14 | + |
| 15 | +Managed MongoDB service |
| 16 | + |
| 17 | +## Parameters |
| 18 | + |
| 19 | +### Common parameters |
| 20 | + |
| 21 | +| Name | Description | Type | Value | |
| 22 | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------- | |
| 23 | +| `replicas` | Number of MongoDB replicas in replica set. | `int` | `3` | |
| 24 | +| `resources` | Explicit CPU and memory configuration for each MongoDB replica. When omitted, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | |
| 25 | +| `resources.cpu` | CPU available to each replica. | `quantity` | `""` | |
| 26 | +| `resources.memory` | Memory (RAM) available to each replica. | `quantity` | `""` | |
| 27 | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. | `string` | `small` | |
| 28 | +| `size` | Persistent Volume Claim size available for application data. | `quantity` | `10Gi` | |
| 29 | +| `storageClass` | StorageClass used to store the data. | `string` | `""` | |
| 30 | +| `external` | Enable external access from outside the cluster. | `bool` | `false` | |
| 31 | +| `version` | MongoDB major version to deploy. | `string` | `v8` | |
| 32 | + |
| 33 | + |
| 34 | +### Sharding configuration |
| 35 | + |
| 36 | +| Name | Description | Type | Value | |
| 37 | +| ----------------------------------- | ------------------------------------------------------------------ | ---------- | ------- | |
| 38 | +| `sharding` | Enable sharded cluster mode. When disabled, deploys a replica set. | `bool` | `false` | |
| 39 | +| `shardingConfig` | Configuration for sharded cluster mode. | `object` | `{}` | |
| 40 | +| `shardingConfig.configServers` | Number of config server replicas. | `int` | `3` | |
| 41 | +| `shardingConfig.mongos` | Number of mongos router replicas. | `int` | `2` | |
| 42 | +| `shardingConfig.shards` | List of shard configurations. | `[]object` | `[...]` | |
| 43 | +| `shardingConfig.shards[i].name` | Shard name. | `string` | `""` | |
| 44 | +| `shardingConfig.shards[i].replicas` | Number of replicas in this shard. | `int` | `0` | |
| 45 | +| `shardingConfig.shards[i].size` | PVC size for this shard. | `quantity` | `""` | |
| 46 | + |
| 47 | + |
| 48 | +### Users configuration |
| 49 | + |
| 50 | +| Name | Description | Type | Value | |
| 51 | +| --------------------------- | --------------------------------------------------- | ------------------- | ----- | |
| 52 | +| `users` | Custom MongoDB users configuration map. | `map[string]object` | `{}` | |
| 53 | +| `users[name].password` | Password for the user (auto-generated if omitted). | `string` | `""` | |
| 54 | +| `users[name].db` | Database to authenticate against. | `string` | `""` | |
| 55 | +| `users[name].roles` | List of MongoDB roles with database scope. | `[]object` | `[]` | |
| 56 | +| `users[name].roles[i].name` | Role name (e.g., readWrite, dbAdmin, clusterAdmin). | `string` | `""` | |
| 57 | +| `users[name].roles[i].db` | Database the role applies to. | `string` | `""` | |
| 58 | + |
| 59 | + |
| 60 | +### Backup parameters |
| 61 | + |
| 62 | +| Name | Description | Type | Value | |
| 63 | +| ------------------------ | ------------------------------------------------------ | -------- | ----------------------------------- | |
| 64 | +| `backup` | Backup configuration. | `object` | `{}` | |
| 65 | +| `backup.enabled` | Enable regular backups. | `bool` | `false` | |
| 66 | +| `backup.schedule` | Cron schedule for automated backups. | `string` | `0 2 * * *` | |
| 67 | +| `backup.retentionPolicy` | Retention policy (e.g. "30d"). | `string` | `30d` | |
| 68 | +| `backup.destinationPath` | Destination path for backups (e.g. s3://bucket/path/). | `string` | `s3://bucket/path/to/folder/` | |
| 69 | +| `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>` | |
| 72 | + |
| 73 | + |
| 74 | +### Bootstrap (recovery) parameters |
| 75 | + |
| 76 | +| Name | Description | Type | Value | |
| 77 | +| ------------------------ | --------------------------------------------------------- | -------- | ------- | |
| 78 | +| `bootstrap` | Bootstrap configuration. | `object` | `{}` | |
| 79 | +| `bootstrap.enabled` | Whether to restore from a backup. | `bool` | `false` | |
| 80 | +| `bootstrap.recoveryTime` | Timestamp for point-in-time recovery; empty means latest. | `string` | `""` | |
| 81 | +| `bootstrap.backupName` | Name of backup to restore from. | `string` | `""` | |
0 commit comments