Skip to content

tomodo provision

Provision a MongoDB deployment.

tomodo provision --help

Subcommands

tomodo provision standalone

Provision a standalone MongoDB deployment

Usage

tomodo provision standalone

Options and Flags

--port

  • Description: The deployment's start port
  • Type: Integer, between 0 and 65535
  • Required: No (default: 27017)

  • Example:

    tomodo provision standalone --port 27111

--image-repo

  • Description: The MongoDB image name/repo (NOTE: you probably don't want to change it)
  • Type: String
  • Required: No (default: mongo)

  • Example:

    tomodo provision standalone --image-repo "mongo"

--image-tag

  • Description: The MongoDB image tag, which determines the MongoDB version to install
  • Type: String
  • Required: No (default: latest)

  • Example:

    tomodo provision standalone --image-tag "7.0.7"

--name

  • Description: The deployment's name; auto-generated if not provided
  • Type: String
  • Required: No (default: generated randomly)

  • Example:

    tomodo provision standalone --name "mymongodb"

--ephemeral

  • Description: Whether the deployment should be ephemeral and not persist data.
  • Type: Flag
  • Required: No (default: --no-ephemeral)

  • Example:

    tomodo provision standalone --ephemeral

--network-name

  • Description: The Docker network to provision the deployment in; will create a new one or use an existing one with the same name if such network exists
  • Type: String
  • Required: No (default: mongo_network)

  • Example:

    tomodo provision standalone --network-name "my-docker-net"

--username

  • Description: Admin username; no authentication if not provided
  • Type: String
  • Required: No (default: null)

  • Example:

    tomodo provision standalone --username "foo" --password "bar"

--password

  • Description: Admin password; no authentication if not provided
  • Type: String
  • Required: No (default: null)

  • Example:

    tomodo provision standalone --username "foo" --password "bar"

tomodo provision replica-set

Provision a MongoDB replica set deployment

Usage

tomodo provision replica-set

Options and Flags

--port

  • Description: The deployment's start port
  • Type: Integer, between 0 and 65535
  • Required: No (default: 27017)

  • Example:

    tomodo provision replica-set --port 27111

--image-repo

  • Description: The MongoDB image name/repo (NOTE: you probably don't want to change it)
  • Type: String
  • Required: No (default: mongo)

  • Example:

    tomodo provision replica-set --image-repo "mongo"

--image-tag

  • Description: The MongoDB image tag, which determines the MongoDB version to install
  • Type: String
  • Required: No (default: latest)

  • Example:

    tomodo provision replica-set --image-tag "7.0.7"

--name

  • Description: The deployment's name; auto-generated if not provided
  • Type: String
  • Required: No (default: generated randomly)

  • Example:

    tomodo provision replica-set --name "mymongodb"

--ephemeral

  • Description: Whether the deployment should be ephemeral and not persist data.
  • Type: Flag
  • Required: No (default: --no-ephemeral)

  • Example:

    tomodo provision replica-set --ephemeral

--replicas

  • Description: The number of replica set members to provision
  • Type: Integer, Enum: [1, 3, 5, 7]
  • Required: No (default: 3)

  • Example:

    tomodo provision replica-set --replicas 3

--arbiter

  • Description: Add an arbiter node to the replica set
  • Type: Flag
  • Required: No (default: --no-arbiter)

  • Example:

    tomodo provision replica-set --arbiter

--network-name

  • Description: The Docker network to provision the deployment in; will create a new one or use an existing one with the same name if such network exists
  • Type: String
  • Required: No (default: mongo_network)

  • Example:

    tomodo provision replica-set --network-name "my-docker-net"

--username

  • Description: Admin username; no authentication if not provided
  • Type: String
  • Required: No (default: null)

  • Example:

    tomodo provision replica-set --username "foo" --password "bar"

--password

  • Description: Admin password; no authentication if not provided
  • Type: String
  • Required: No (default: null)

  • Example:

    tomodo provision replica-set --username "foo" --password "bar"

tomodo provision sharded

Provision a MongoDB sharded cluster

Usage

tomodo provision sharded

Options and Flags

--port

  • Description: The deployment's start port
  • Type: Integer, between 0 and 65535
  • Required: No (default: 27017)

  • Example:

    tomodo provision sharded --port 27111

--image-repo

  • Description: The MongoDB image name/repo (NOTE: you probably don't want to change it)
  • Type: String
  • Required: No (default: mongo)

  • Example:

    tomodo provision sharded --image-repo "mongo"

--image-tag

  • Description: The MongoDB image tag, which determines the MongoDB version to install
  • Type: String
  • Required: No (default: latest)

  • Example:

    tomodo provision sharded --image-tag "7.0.7"

--name

  • Description: The deployment's name; auto-generated if not provided
  • Type: String
  • Required: No (default: generated randomly)

  • Example:

    tomodo provision sharded --name "mymongodb"

--ephemeral

  • Description: Whether the deployment should be ephemeral and not persist data.
  • Type: Flag
  • Required: No (default: --no-ephemeral)

  • Example:

    tomodo provision sharded --ephemeral

--replicas

  • Description: The number of replica set members to provision in each shard
  • Type: Integer, Enum: [1, 3, 5, 7]
  • Required: No (default: 3)

  • Example:

    tomodo provision sharded --replicas 3

--shards

  • Description: The number of shards to provision
  • Type: Integer
  • Required: No (default: 2)

  • Example:

    tomodo provision sharded --shards 5

--mongos

  • Description: The number of mongos routers
  • Type: Integer
  • Required: No (default: 1)

  • Example:

    tomodo provision sharded --mongos 2

--config-servers

  • Description: The number of config server replica set members
  • Type: Integer, Enum: [1, 3, 5, 7]
  • Required: No (default: 1)

  • Example:

    tomodo provision sharded --config-servers 3

--arbiter

  • Description: Add an arbiter node to each shard
  • Type: Flag
  • Required: No (default: --no-arbiter)

  • Example:

    tomodo provision sharded --arbiter

--network-name

  • Description: The Docker network to provision the deployment in; will create a new one or use an existing one with the same name if such network exists
  • Type: String
  • Required: No (default: mongo_network)

  • Example:

    tomodo provision sharded --network-name "my-docker-net"

tomodo provision atlas

Provision a local MongoDB Atlas deployment

Usage

tomodo provision atlas

Options and Flags

--port

  • Description: The deployment's start port
  • Type: Integer, between 0 and 65535
  • Required: No (default: 27017)

  • Example:

    tomodo provision atlas --port 27111

--image-tag

  • Description: The MongoDB version to install
  • Type: String
  • Required: No (default: latest)

  • Example:

    tomodo provision atlas --image-tag "7"

--image-repo

  • Description: The MongoDB Atlas image name/repo (note: you probably don't want to change it)
  • Type: String
  • Required: No (default: mongodb/mongodb-atlas-local)

  • Example:

    tomodo provision atlas --image-repo "mongodb/mongodb-atlas-local"

--image-tag

  • Description: The MongoDB Atlas image tag (note: you probably don't want to change it)
  • Type: String
  • Required: No (default: main)

  • Example:

    tomodo provision atlas --image-tag "main"

--name

  • Description: The deployment's name; auto-generated if not provided
  • Type: String
  • Required: No (default: generated randomly)

  • Example:

    tomodo provision atlas --name "mymongodb"

--network-name

  • Description: The Docker network to provision the deployment in; will create a new one or use an existing one with the same name if such network exists
  • Type: String
  • Required: No (default: mongo_network)

  • Example:

    tomodo provision atlas --network-name "my-docker-net"

--username

  • Description: Admin username
  • Type: String
  • Required: No (default: "admin")

  • Example:

    tomodo provision atlas --username "foo" --password "bar"

--password

  • Description: Admin password
  • Type: String
  • Required: No (default: "admin")

  • Example:

    tomodo provision standalone --username "foo" --password "bar"