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

Примечание

Этот плагин входит в коллекцию community.mongodb (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.mongodb.

Для использования в книге задач укажите: community.mongodb.mongodb_shard.

Новое в версии 1.0.0: of community.mongodb

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

pymongo

Параметры

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

Примечания

Примечание

Требуется пакет pymongo Python на удаленном хосте, версия 2.4.2+.

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/mongodb/mongodb_shard_module.html