Bitnami/containers
2
0
Fork 0
mirror of https://github.com/bitnami/containers.git synced 2026-03-21 15:29:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/mongodb-sharded] Release 7.0.5-debian-11-r2 (#54779)

Browse Source 
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
This commit is contained in:
Bitnami Bot
2024-01-15 17:52:54 +01:00
committed by GitHub
parent 8098dcfdd2
commit ed7add87f9
2 changed files with 57 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
bitnami/mongodb-sharded/README.md
View File

@@ -110,82 +110,62 @@ services:
### Environment variables
| Name | Description | Default Value | Can be set |
|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|------------|
| `$MONGODB_DISABLE_SERVICE` | Whether to disable the MongoDB service by default. | `no` | &check; |
| `$MONGODB_VOLUME_DIR` | Persistence base directory | `$BITNAMI_VOLUME_DIR/mongodb` | |
| `$MONGODB_BASE_DIR` | MongoDB installation directory | `$BITNAMI_ROOT_DIR/mongodb` | |
| `$MONGODB_CONF_DIR` | MongoDB configuration directory | `$MONGODB_BASE_DIR/conf` | |
| `$MONGODB_LOG_DIR` | MongoDB logs directory | `$MONGODB_BASE_DIR/logs` | |
| `$MONGODB_DATA_DIR` | MongoDB data directory | `${MONGODB_VOLUME_DIR}/data` | |
| `$MONGODB_TMP_DIR` | MongoDB temporary directory | `$MONGODB_BASE_DIR/tmp` | |
| `$MONGODB_BIN_DIR` | MongoDB executables directory | `$MONGODB_BASE_DIR/bin` | |
| `$MONGODB_TEMPLATES_DIR` | Directory where the mongodb.conf template file is stored | `$MONGODB_BASE_DIR/templates` | |
| `$MONGODB_MONGOD_TEMPLATES_FILE` | Path to the mongodb.conf template file | `$MONGODB_TEMPLATES_DIR/mongodb.conf.tpl` | |
| `$MONGODB_CONF_FILE` | Path to MongoDB configuration file | `$MONGODB_CONF_DIR/mongodb.conf` | |
| `$MONGODB_KEY_FILE` | Path to the MongoDB replica set keyfile | `$MONGODB_CONF_DIR/keyfile` | |
| `$MONGODB_DB_SHELL_FILE` | Path to MongoDB dbshell file | `/.dbshell` | |
| `$MONGODB_RC_FILE` | Path to MongoDB rc file | `/.mongorc.js` | |
| `$MONGOSH_DIR` | Path to mongosh directory | `/.mongodb` | |
| `$MONGOSH_RC_FILE` | Path to mongosh rc file | `/.mongoshrc.js` | |
| `$MONGODB_PID_FILE` | Path to the MongoDB PID file | `$MONGODB_TMP_DIR/mongodb.pid` | |
| `$MONGODB_LOG_FILE` | Path to the MongoDB log file | `$MONGODB_LOG_DIR/mongodb.log` | |
| `$MONGODB_INITSCRIPTS_DIR` | Path to the MongoDB container init scripts directory | `/docker-entrypoint-initdb.d` | |
| `$MONGODB_DAEMON_USER` | MongoDB system user | `mongo` | |
| `$MONGODB_DAEMON_GROUP` | MongoDB system group | `mongo` | |
| `$MONGODB_MOUNTED_CONF_DIR` | Directory for including custom configuration files (that override the default generated ones) | `${MONGODB_VOLUME_DIR}/conf` | &check; |
| `$MONGODB_INIT_RETRY_ATTEMPTS` | Maximum retries for checking the service initialization status | `7` | &check; |
| `$MONGODB_INIT_RETRY_DELAY` | Time (in seconds) to wait between retries for checking the service initialization status | `5` | &check; |
| `$MONGODB_DEFAULT_PORT_NUMBER` | MongoDB port set at build time | `27017` | |
| `$MONGODB_PORT_NUMBER` | MongoDB port | `$MONGODB_DEFAULT_PORT_NUMBER` | &check; |
| `$MONGODB_ENABLE_MAJORITY_READ` | Enable majority read in MongoDB operations | `true` | &check; |
| `$MONGODB_DEFAULT_ENABLE_MAJORITY_READ` | Enable majority read in MongoDB operations set at build time | `true` | &check; |
| `$MONGODB_EXTRA_FLAGS` | Extra flags for MongoDB initialization | | &check; |
| `$MONGODB_ENABLE_NUMACTL` | Execute commands using numactl | `false` | &check; |
| `$MONGODB_SHELL_EXTRA_FLAGS` | Extra flags when using the mongodb client during initialization (useful when mounting init scripts) | | &check; |
| `$MONGODB_ADVERTISED_HOSTNAME` | Hostname to use for advertising the MongoDB service | | &check; |
| `$MONGODB_ADVERTISE_IP` | Whether advertised hostname is set to container ip | `false` | &check; |
| `$MONGODB_ADVERTISED_PORT_NUMBER` | MongoDB advertised port number. It is recommended to pass this environment variable if you have a proxy port forwarding requests to container. | | &check; |
| `$MONGODB_DISABLE_JAVASCRIPT` | Disable MongoDB server-side javascript execution | `no` | &check; |
| `$MONGODB_ENABLE_JOURNAL` | Enable MongoDB journal | | &check; |
| `$MONGODB_DEFAULT_ENABLE_JOURNAL` | Enable MongoDB journal at build time | `true` | |
| `$MONGODB_DISABLE_SYSTEM_LOG` | Disable MongoDB daemon system log | | &check; |
| `$MONGODB_DEFAULT_DISABLE_SYSTEM_LOG` | Disable MongoDB daemon system log set at build time | `false` | |
| `$MONGODB_ENABLE_DIRECTORY_PER_DB` | Use a separate folder for storing each database data | | &check; |
| `$MONGODB_DEFAULT_ENABLE_DIRECTORY_PER_DB` | Use a separate folder for storing each database data set at build time | `false` | |
| `$MONGODB_ENABLE_IPV6` | Use IPv6 for database connections | | &check; |
| `$MONGODB_DEFAULT_ENABLE_IPV6` | Use IPv6 for database connections set at build time | `false` | |
| `$MONGODB_SYSTEM_LOG_VERBOSITY` | MongoDB daemon log level | | &check; |
| `$MONGODB_DEFAULT_SYSTEM_LOG_VERBOSITY` | MongoDB daemon log level set at build time | `0` | |
| `$MONGODB_ROOT_USER` | User name for the MongoDB root user | `root` | &check; |
| `$MONGODB_ROOT_PASSWORD` | Password for the MongoDB root user | | &check; |
| `$MONGODB_USERNAME` | User to generate at initialization time | | &check; |
| `$MONGODB_PASSWORD` | Password for the non-root user specified in MONGODB_USERNAME | | &check; |
| `$MONGODB_DATABASE` | Name of the database to create at initialization time | | &check; |
| `$MONGODB_METRICS_USERNAME` | User used for metrics collection, for example with mongodb_exporter | | &check; |
| `$MONGODB_METRICS_PASSWORD` | Password for the non-root user specified in MONGODB_METRICS_USERNAME | | &check; |
| `$MONGODB_EXTRA_USERNAMES` | Comma or semicolon separated list of extra users to be created. | | &check; |
| `$MONGODB_EXTRA_PASSWORDS` | Comma or semicolon separated list of passwords for the users specified in MONGODB_EXTRA_USERNAMES. | | &check; |
| `$MONGODB_EXTRA_DATABASES` | Comma or semicolon separated list of databases to create at initialization time for the users specified in MONGODB_EXTRA_USERNAMES. | | &check; |
| `$ALLOW_EMPTY_PASSWORD` | Permit accessing MongoDB without setting any password | `no` | &check; |
| `$MONGODB_REPLICA_SET_MODE` | MongoDB replica set mode. Can be one of primary, secondary or arbiter | | &check; |
| `$MONGODB_DEFAULT_REPLICA_SET_NAME` | Name of the MongoDB replica set at build time | `replicaset` | |
| `$MONGODB_REPLICA_SET_NAME` | Name of the MongoDB replica set | `$MONGODB_DEFAULT_REPLICA_SET_NAME` | &check; |
| `$MONGODB_REPLICA_SET_KEY` | MongoDB replica set key | | &check; |
| `$MONGODB_INITIAL_PRIMARY_HOST` | Hostname of the replica set primary node (necessary for arbiter and secondary nodes) | | &check; |
| `$MONGODB_INITIAL_PRIMARY_PORT_NUMBER` | Port of the replica set primary node (necessary for arbiter and secondary nodes) | `27017` | &check; |
| `$MONGODB_INITIAL_PRIMARY_ROOT_PASSWORD` | Primary node root user password (necessary for arbiter and secondary nodes) | | &check; |
| `$MONGODB_INITIAL_PRIMARY_ROOT_USER` | Primary node root username (necessary for arbiter and secondary nodes) | `root` | &check; |
| `$MONGODB_SET_SECONDARY_OK` | Mark node as readable. Necessary for cases where the PVC is lost | `no` | &check; |
| `$MONGODB_MONGOS_TEMPLATES_FILE` | Path to MongoDB Sharded template file | `$MONGODB_TEMPLATES_DIR/mongos.conf.tpl` | |
| `$MONGODB_SHARDING_MODE` | MongoDB Sharding mode. Can be one of shardsvr, configsvr or mongos | | &check; |
| `$MONGODB_MONGOS_CONF_FILE` | MongoDB mongos configuration file. Used by mongos node | `$MONGODB_CONF_DIR/mongos.conf` | |
| `$MONGODB_CFG_REPLICA_SET_NAME` | MongoDB config server replica set name. Mandatory for configuring mongos | | &check; |
| `$MONGODB_CFG_PRIMARY_HOST` | MongoDB config server replica set primary host. Mandatory for configuring mongos | | &check; |
| `$MONGODB_CFG_PRIMARY_PORT_NUMBER` | MongoDB config server primary host port. Mandatory for shardsvr mode | `27017` | &check; |
| `$MONGODB_MONGOS_HOST` | MongoDB mongos host. Mandatory for shardsvr mode | | &check; |
| `$MONGODB_MONGOS_PORT_NUMBER` | MongoDB mongos port. Mandatory for shardsvr mode | `27017` | &check; |
#### Customizable environment variables
| Name | Description | Default Value |
|-----------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------|
| `$MONGODB_DISABLE_SERVICE` | Whether to disable the MongoDB service by default. | `no` |
| `$MONGODB_MOUNTED_CONF_DIR` | Directory for including custom configuration files (that override the default generated ones) | `${MONGODB_VOLUME_DIR}/conf` |
| `$MONGODB_INIT_RETRY_ATTEMPTS` | Maximum retries for checking the service initialization status | `7` |
| `$MONGODB_INIT_RETRY_DELAY` | Time (in seconds) to wait between retries for checking the service initialization status | `5` |
| `$MONGODB_PORT_NUMBER` | MongoDB port | `$MONGODB_DEFAULT_PORT_NUMBER` |
| `$MONGODB_ENABLE_MAJORITY_READ` | Enable majority read in MongoDB operations | `true` |
| `$MONGODB_DEFAULT_ENABLE_MAJORITY_READ` | Enable majority read in MongoDB operations set at build time | `true` |
| `$MONGODB_ENABLE_NUMACTL` | Execute commands using numactl | `false` |
| `$MONGODB_ADVERTISE_IP` | Whether advertised hostname is set to container ip | `false` |
| `$MONGODB_DISABLE_JAVASCRIPT` | Disable MongoDB server-side javascript execution | `no` |
| `$MONGODB_ROOT_USER` | User name for the MongoDB root user | `root` |
| `$ALLOW_EMPTY_PASSWORD` | Permit accessing MongoDB without setting any password | `no` |
| `$MONGODB_REPLICA_SET_NAME` | Name of the MongoDB replica set | `$MONGODB_DEFAULT_REPLICA_SET_NAME` |
| `$MONGODB_INITIAL_PRIMARY_PORT_NUMBER` | Port of the replica set primary node (necessary for arbiter and secondary nodes) | `27017` |
| `$MONGODB_INITIAL_PRIMARY_ROOT_USER` | Primary node root username (necessary for arbiter and secondary nodes) | `root` |
| `$MONGODB_SET_SECONDARY_OK` | Mark node as readable. Necessary for cases where the PVC is lost | `no` |
| `$MONGODB_CFG_PRIMARY_PORT_NUMBER` | MongoDB config server primary host port. Mandatory for shardsvr mode | `27017` |
| `$MONGODB_MONGOS_PORT_NUMBER` | MongoDB mongos port. Mandatory for shardsvr mode | `27017` |
#### Read-only environment variables
| Name | Description | Value |
|--------------------------------------------|------------------------------------------------------------------------|-------------------------------------------|
| `$MONGODB_VOLUME_DIR` | Persistence base directory | `$BITNAMI_VOLUME_DIR/mongodb` |
| `$MONGODB_BASE_DIR` | MongoDB installation directory | `$BITNAMI_ROOT_DIR/mongodb` |
| `$MONGODB_CONF_DIR` | MongoDB configuration directory | `$MONGODB_BASE_DIR/conf` |
| `$MONGODB_LOG_DIR` | MongoDB logs directory | `$MONGODB_BASE_DIR/logs` |
| `$MONGODB_DATA_DIR` | MongoDB data directory | `${MONGODB_VOLUME_DIR}/data` |
| `$MONGODB_TMP_DIR` | MongoDB temporary directory | `$MONGODB_BASE_DIR/tmp` |
| `$MONGODB_BIN_DIR` | MongoDB executables directory | `$MONGODB_BASE_DIR/bin` |
| `$MONGODB_TEMPLATES_DIR` | Directory where the mongodb.conf template file is stored | `$MONGODB_BASE_DIR/templates` |
| `$MONGODB_MONGOD_TEMPLATES_FILE` | Path to the mongodb.conf template file | `$MONGODB_TEMPLATES_DIR/mongodb.conf.tpl` |
| `$MONGODB_CONF_FILE` | Path to MongoDB configuration file | `$MONGODB_CONF_DIR/mongodb.conf` |
| `$MONGODB_KEY_FILE` | Path to the MongoDB replica set keyfile | `$MONGODB_CONF_DIR/keyfile` |
| `$MONGODB_DB_SHELL_FILE` | Path to MongoDB dbshell file | `/.dbshell` |
| `$MONGODB_RC_FILE` | Path to MongoDB rc file | `/.mongorc.js` |
| `$MONGOSH_DIR` | Path to mongosh directory | `/.mongodb` |
| `$MONGOSH_RC_FILE` | Path to mongosh rc file | `/.mongoshrc.js` |
| `$MONGODB_PID_FILE` | Path to the MongoDB PID file | `$MONGODB_TMP_DIR/mongodb.pid` |
| `$MONGODB_LOG_FILE` | Path to the MongoDB log file | `$MONGODB_LOG_DIR/mongodb.log` |
| `$MONGODB_INITSCRIPTS_DIR` | Path to the MongoDB container init scripts directory | `/docker-entrypoint-initdb.d` |
| `$MONGODB_DAEMON_USER` | MongoDB system user | `mongo` |
| `$MONGODB_DAEMON_GROUP` | MongoDB system group | `mongo` |
| `$MONGODB_DEFAULT_PORT_NUMBER` | MongoDB port set at build time | `27017` |
| `$MONGODB_DEFAULT_ENABLE_JOURNAL` | Enable MongoDB journal at build time | `true` |
| `$MONGODB_DEFAULT_DISABLE_SYSTEM_LOG` | Disable MongoDB daemon system log set at build time | `false` |
| `$MONGODB_DEFAULT_ENABLE_DIRECTORY_PER_DB` | Use a separate folder for storing each database data set at build time | `false` |
| `$MONGODB_DEFAULT_ENABLE_IPV6` | Use IPv6 for database connections set at build time | `false` |
| `$MONGODB_DEFAULT_SYSTEM_LOG_VERBOSITY` | MongoDB daemon log level set at build time | `0` |
| `$MONGODB_DEFAULT_REPLICA_SET_NAME` | Name of the MongoDB replica set at build time | `replicaset` |
| `$MONGODB_MONGOS_TEMPLATES_FILE` | Path to MongoDB Sharded template file | `$MONGODB_TEMPLATES_DIR/mongos.conf.tpl` |
| `$MONGODB_MONGOS_CONF_FILE` | MongoDB mongos configuration file. Used by mongos node | `$MONGODB_CONF_DIR/mongos.conf` |
### Setting up a sharded cluster