Модуль community.mongodb.mongodb_balancer — управление балансировщиком шардированного кластера MongoDB.

Примечание

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

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

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

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

Добавлено в 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"`
autosplit boolean	Отключить или включить флаг автоматического разделения в коллекции config.settings. Начиная с MongoDB 6.1 автоматическое разделение чанков не выполняется, поэтому этот параметр недопустим в этой и более поздних версиях. Дополнительные сведения см. в разделе [enableAutoSplit](https://www.mongodb.com/docs/manual/reference/method/sh.enableAutoSplit/). Этот параметр устарел и будет удалён в одном из следующих выпусков. Варианты: `false` `true`
chunksize integer	Задать размер чанков в шардированном кластере. Значение указывается в МБ.
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"`
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	Управление балансировщиком кластера Варианты: `"started"` ← (по умолчанию) `"stopped"`
strict_compatibility boolean	Строго проверять требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (по умолчанию)
window any	Задать временное окно работы балансировщика. Укажите следующие ключи словаря: start, stop, state Значение ключа state должно быть «present» или «absent». Ключи start и stop игнорируются, если state имеет значение «absent». Значения start и stop должны быть строками в формате «HH:MM», обозначающими границы временного окна.

Примечания

Примечание

На удалённом хосте требуется пакет Python pymongo версии 4 или новее. Его можно установить с помощью pip или менеджера пакетов ОС. @see https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/

Примеры

- name: Start the balancer
  community.mongodb.mongodb_balancer:
    state: started

- name: Stop the balancer and disable autosplit
  community.mongodb.mongodb_balancer:
    state: stopped
    autosplit: false

- name: Enable autosplit
  community.mongodb.mongodb_balancer:
    autosplit: true

- name: Change the default chunksize to 128MB
  community.mongodb.mongodb_balancer:
    chunksize: 128

- name: Add or update a balancing window
  community.mongodb.mongodb_balancer:
    window:
      start: "23:00"
      stop: "06:00"
      state: "present"

- name: Remove a balancing window
  community.mongodb.mongodb_balancer:
    window:
      state: "absent"

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

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

Ключ	Описание
changed boolean	Изменилось ли состояние балансировщика или автоматического разделения. Возвращается: при успешном выполнении
failed boolean	Произошла ли ошибка Возвращается: при ошибке
msg string	Краткое описание произошедшего. Возвращается: при сбое
new_autosplit string	Новое состояние автоматического разделения. Возвращается: при изменении состояния автоматического разделения.
new_balancer_state string	Новое состояние балансировщика. Возвращается: при изменении состояния балансировщика
new_chunksize integer	Новое значение размера чанка. Возвращается: при изменении размера чанка.
old_autosplit string	Предыдущее состояние автоматического разделения. Возвращается: при изменении состояния автоматического разделения.
old_balancer_state string	Предыдущее состояние балансировщика Возвращается: при изменении состояния балансировщика
old_chunksize integer	Предыдущее значение размера чанка. Возвращается: при изменении размера чанка.

Авторы

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_balancer_module.html