community.mongodb.mongodb_shard модуль — Добавление или удаление фрагментов из кластера MongoDB

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 aliases: tls boolean	Использовать SSL-соединение при подключении к базе данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs aliases: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string	Определяет, требуется ли сертификат от другой стороны соединения и будет ли он валидирован, если предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile aliases: tlsCertificateKeyFile string	Представьте клиентский сертификат с помощью ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Приватный ключ для клиентского сертификата.
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string	Фраза доступа для расшифровки зашифрованных приватных ключей.
state string	Фрагмент должен присутствовать или отсутствовать в кластере. Варианты: `"absent"` `"present"` ← (по умолчанию)

strict_compatibility

boolean

Принудительное применение строгих требований к версиям pymongo и MongoDB

Варианты:

false
true ← (по умолчанию)

Примечания

Примечание

Требуется пакет pymongo Python версии 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 строка	Имя фрагмента для создания. Возвращаемое значение: успех
sharded_enabled список / элементы=строка	Базы данных, для которых был включен фрагментация во время выполнения модуля. Возвращаемое значение: успех, когда фрагментация включена

Авторы

Rhys Campbell (@rhysmeister)

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

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