Synopsis

Initialises a MongoDB replicaset in a new deployment.

Validates the replicaset name for existing deployments.

Advanced replicaset member configuration possible (see examples).

Requirements

The below requirements are needed on the host that executes this module.

• pymongo

Parameters

replica_set (optional, str, rs0)

Replicaset name.

members (optional, list, None)

Yaml list consisting of the replicaset members.

Csv string will also be accepted i.e. mongodb1:27017,mongodb2:27017,mongodb3:27017.

A dictionary can also be used to specify advanced replicaset member options.

If a port number is not provided then 27017 is assumed.

validate (optional, bool, True)

Performs some basic validation on the provided replicaset config.

arbiter_at_index (optional, int, None)

Identifies the position of the member in the array that is an arbiter.

chaining_allowed (optional, bool, True)

When settings.chaining_allowed=true, the replicaset allows secondary members to replicate from other secondary members.

When settings.chaining_allowed=false, secondaries can replicate only from the primary.

heartbeat_timeout_secs (optional, int, 10)

Number of seconds that the replicaset members wait for a successful heartbeat from each other.

If a member does not respond in time, other members mark the delinquent member as inaccessible.

The setting only applies when using protocol_version=0. When using protocol_version=1 the relevant setting is settings.election_timeout_millis.

election_timeout_millis (optional, int, 10000)

The time limit in milliseconds for detecting when a replicaset's primary is unreachable.

protocol_version (optional, int, 1)

Version of the replicaset election protocol.

reconfigure (optional, bool, False)

This feature is currently experimental. Please test your scenario thoroughly.

Consult the integration test file for supported scenarios - [Integration tests](https://github.com/ansible-collections/community.mongodb/tree/master/tests/integration/targets/mongodb_replicaset/tasks). See files prefixed with 330.

Whether to perform replicaset reconfiguration actions.

Only relevant when the replicaset already exists.

Only one member should be removed or added per invocation.

Members should be specific as either all strings or all dicts when reconfiguring.

Currently no support for replicaset settings document changes.

force (optional, bool, False)

Only relevant when reconfigure = true.

Specify true to force the available replica set members to accept the new configuration.

Force reconfiguration can result in unexpected or undesired behavior, including rollback of "majority" committed writes.

max_time_ms (optional, int, None)

Specifies a cumulative time limit in milliseconds for processing the replicaset reconfiguration.

debug (optional, bool, False)

Add additonal info for debug.

cluster_cmd (optional, str, hello)

Command the module should use to obtain information about the MongoDB node we are connecting to.

login_user (False, str, None)

The MongoDB user to login with.

Required when login_password is specified.

login_password (False, str, None)

The password used to authenticate with.

Required when login_user is specified.

login_database (False, str, admin)

The database where login credentials are stored.

login_host (False, str, localhost)

The host running MongoDB instance to login to.

login_port (False, int, 27017)

The MongoDB server port to login to.

strict_compatibility (optional, bool, True)

Enforce strict requirements for pymongo and MongoDB software versions

ssl (False, bool, False)

Whether to use an SSL connection when connecting to the database.

ssl_cert_reqs (False, str, CERT_REQUIRED)

Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.

ssl_ca_certs (False, str, None)

The ssl_ca_certs option takes a path to a CA file.

ssl_crlfile (False, str, None)

The ssl_crlfile option takes a path to a CRL file.

ssl_certfile (False, str, None)

Present a client certificate using the ssl_certfile option.

ssl_keyfile (False, str, None)

Private key for the client certificate.

ssl_pem_passphrase (False, str, None)

Passphrase to decrypt encrypted private keys.

auth_mechanism (False, str, None)

Authentication type.

connection_options (False, list, None)

Additional connection options.

Supply as a list of dicts or strings containing key value pairs seperated with '='.

Notes

Examples

# Create a replicaset called 'rs0' with the 3 provided members
- name: Ensure replicaset rs0 exists
  community.mongodb.mongodb_replicaset:
    login_host: localhost
    login_user: admin
    login_password: admin
    replica_set: rs0
    members:
    - mongodb1:27017
    - mongodb2:27017
    - mongodb3:27017
  when: groups.mongod.index(inventory_hostname) == 0

# Create two single-node replicasets on the localhost for testing
- name: Ensure replicaset rs0 exists
  community.mongodb.mongodb_replicaset:
    login_host: localhost
    login_port: 3001
    login_user: admin
    login_password: secret
    login_database: admin
    replica_set: rs0
    members: localhost:3001
    validate: no

- name: Ensure replicaset rs1 exists
  community.mongodb.mongodb_replicaset:
    login_host: localhost
    login_port: 3002
    login_user: admin
    login_password: secret
    login_database: admin
    replica_set: rs1
    members: localhost:3002
    validate: no

- name: Create a replicaset and use a custom priority for each member
  community.mongodb.mongodb_replicaset:
    login_host: localhost
    login_user: admin
    login_password: admin
    replica_set: rs0
    members:
    - host: "localhost:3001"
      priority: 1
    - host: "localhost:3002"
      priority: 0.5
    - host: "localhost:3003"
      priority: 0.5
  when: groups.mongod.index(inventory_hostname) == 0

- name: Create replicaset rs1 with options and member tags
  community.mongodb.mongodb_replicaset:
    login_host: localhost
    login_port: 3001
    login_database: admin
    replica_set: rs1
    members:
    - host: "localhost:3001"
      priority: 1
      tags:
        dc: "east"
        usage: "production"
    - host: "localhost:3002"
      priority: 1
      tags:
        dc: "east"
        usage: "production"
    - host: "localhost:3003"
      priority: 0
      hidden: true
      slaveDelay: 3600
      tags:
        dc: "west"
        usage: "reporting"

- name: Replicaset with one arbiter node (mongodb3 - index is zero-based)
  community.mongodb.mongodb_replicaset:
    login_user: admin
    login_password: admin
    replica_set: rs0
    members:
      - mongodb1:27017
      - mongodb2:27017
      - mongodb3:27017
    arbiter_at_index: 2
  when: groups.mongod.index(inventory_hostname) == 0

- name: Add a new member to a replicaset - Safe for pre-5.0 consult documentation - https://docs.mongodb.com/manual/tutorial/expand-replica-set/
  block:
    - name: Create replicaset with module - with dicts
      community.mongodb.mongodb_replicaset:
        replica_set: "rs0"
        members:
           - host: localhost:3001
           - host: localhost:3002
           - host: localhost:3003

    - name: Wait for the replicaset to stabilise
      community.mongodb.mongodb_status:
        replica_set: "rs0"
        poll: 5
        interval: 10

    - name: Remove a member from the replicaset
      community.mongodb.mongodb_replicaset:
        replica_set: "rs0"
        reconfigure: yes
        members:
           - host: localhost:3001
           - host: localhost:3002

    - name: Wait for the replicaset to stabilise after member removal
      community.mongodb.mongodb_status:
        replica_set: "rs0"
        validate: minimal
        poll: 5
        interval: 10

    - name: Add a member to the replicaset
      community.mongodb.mongodb_replicaset:
        replica_set: "rs0"
        reconfigure: yes
        members:
           - host: localhost:3001
           - host: localhost:3002
           - host: localhost:3004
             hidden: true
             votes: 0
             priority: 0

    - name: Wait for the replicaset to stabilise after member addition
      community.mongodb.mongodb_status:
        replica_set: "rs0"
        validate: minimal
        poll: 5
        interval: 30

    - name: Reconfigure the replicaset - Make member 3004 a normal voting member
      community.mongodb.mongodb_replicaset:
        replica_set: "rs0"
        reconfigure: yes
        members:
           - host: localhost:3001
           - host: localhost:3002
           - host: localhost:3004
             hidden: false
             votes: 1
             priority: 1

    - name: Wait for the replicaset to stabilise
      community.mongodb.mongodb_status:
        replica_set: "rs0"
        poll: 5
        interval: 30

Return Values

mongodb_replicaset (success, str, )

The name of the replicaset that has been created.

reconfigure (On rpelicaset reconfiguration, bool, )

If a replicaset reconfiguration occured.

Status