Модуль community.mongodb.mongodb_shard — добавление или удаление шардов из кластера MongoDB

Примечание

Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.mongodb.mongodb_shard.

Добавлено в community.mongodb 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Добавление или удаление шардов из кластера MongoDB.

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

pymongo

Параметры

Параметр	Комментарии
atlas_auth boolean	Способ аутентификации, предназначенный для экземпляров MongoDB Atlas Допустимые значения: `false` ← (по умолчанию) `true`
auth_mechanism string	Тип аутентификации. Допустимые значения: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Укажите список словарей или строк с парами ключ-значение, разделёнными символом «=».
login_database string	База данных, в которой хранятся учётные данные для входа. По умолчанию: `"admin"`
login_host string	Хост с экземпляром MongoDB, к которому выполняется подключение. По умолчанию: `"localhost"`
login_password string	Пароль для аутентификации. Обязателен, если указан login_user.
login_port integer	Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязателен, если указан login_password.
mongos_process string	Укажите пользовательское имя процесса mongos, к которому выполняется подключение. Большинству пользователей можно не менять этот параметр. По умолчанию: `"mongos"`
shard string / обязательный	Строка подключения к шарду. Значение должно иметь формат <replicaset>/host:port, как описано в https://docs.mongodb.com/manual/tutorial/add-shards-to-shard-cluster/. Например: rs0/example1.mongodb.com:27017.
sharded_databases any	Включить шардинг для указанной базы данных. Можно указать строку или список строк. Отключить шардинг для базы данных нельзя. Начиная с MongoDB 6.0, команда enableSharding больше не требуется для шардинга коллекции, поэтому этот параметр игнорируется.
ssl псевдонимы: tls boolean	Использовать ли SSL-подключение при соединении с базой данных. Допустимые значения: `false` ← (по умолчанию) `true`
ssl_ca_certs псевдонимы: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates string	Указывает, требуется ли сертификат от другой стороны подключения и нужно ли проверять его, если он предоставлен. Допустимые значения: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile псевдонимы: tlsCertificateKeyFile string	Предоставьте клиентский сертификат с помощью параметра ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ клиентского сертификата.
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword string	Парольная фраза для расшифровки зашифрованных закрытых ключей.
state string	Должен ли шард присутствовать в кластере или отсутствовать в нём. Допустимые значения: `"absent"` `"present"` ← (по умолчанию)
strict_compatibility boolean	Строго проверять требования к версиям pymongo и MongoDB Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

На удалённом хосте требуется пакет Python pymongo версии 4 или выше.

Примеры

- name: Add a replicaset shard named rs1 with a member running on port 27018 on mongodb0.example.net
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: admin
    shard: "rs1/mongodb0.example.net:27018"
    state: present

- name: Add a standalone mongod shard running on port 27018 of mongodb0.example.net
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: admin
    shard: "mongodb0.example.net:27018"
    state: present

- name: To remove a shard called 'rs1'
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: admin
    shard: rs1
    state: absent

# Single node shard running on localhost
- name: Ensure shard rs0 exists
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: secret
    shard: "rs0/localhost:3001"
    state: present

# Single node shard running on localhost
- name: Ensure shard rs1 exists
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: secret
    shard: "rs1/localhost:3002"
    state: present

# Enable sharding on a few databases when creating the shard
- name: To remove a shard called 'rs1'
  community.mongodb.mongodb_shard:
    login_user: admin
    login_password: admin
    shard: rs1
    sharded_databases:
      - db1
      - db2
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
mongodb_shard string	Имя создаваемого шарда. Возвращается: success
sharded_enabled list / elements=string	Базы данных, для которых во время выполнения модуля был включён шардинг. Возвращается: при успешном включении шардинга

Авторы

Rhys Campbell (@rhysmeister)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/mongodb/mongodb_shard_module.html