community.mongodb.mongodb_balancer – Управляет балансировщиком MongoDB Sharded Cluster.
Примечание
Этот плагин входит в коллекцию community.mongodb (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.mongodb
Чтобы использовать его в книге задач, укажите: community.mongodb.mongodb_balancer
Новое в версии 1.0.0: коллекции community.mongodb
Описание
- Управляет балансировщиком MongoDB Sharded Cluster.
- Запуск или остановка балансировщика.
- Настройка размера фрагмента кластера.
- Включение или отключение автоматического разделения.
- Добавление или удаление окна балансировщика.
Требования
Ниже перечислены требования, которые необходимы на хосте, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| autosplit булево |
| Отключение или включение флага autosplit в коллекции config.settings. |
| chunksize целое число | Управление размером фрагментов в фрагментированном кластере. Значение должно быть указано в МБ. | |
| 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. Большинство пользователей могут проигнорировать этот параметр. |
| ssl булево |
| Использовать ли SSL-соединение при подключении к базе данных. |
| ssl_ca_certs строка | Параметр ssl_ca_certs принимает путь к файлу CA. | |
| ssl_cert_reqs строка |
| Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. |
| ssl_certfile строка | При необходимости предоставьте клиентский сертификат с помощью параметра ssl_certfile. | |
| ssl_crlfile строка | Параметр ssl_crlfile принимает путь к файлу CRL. | |
| ssl_keyfile строка | Приватный ключ для клиентского сертификата. | |
| ssl_pem_passphrase строка | Пароль для расшифровки зашифрованных приватных ключей. | |
| state строка |
| Управление балансировщиком для кластера |
| window сырые данные | Планирование окна балансировщика. Предоставьте следующие ключи словаря: start, stop, state Ключ state должен быть "present" или "absent". Ключи start и stop игнорируются, когда state равен "absent". start и stop должны быть строками в формате "HH:MM", указывающими временные границы окна. |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. См. http://api.mongodb.org/python/current/installation.html
Примеры
- 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 булево | success | Изменилось ли состояние балансировщика или autosplit. |
| failed булево | failed | Если что-то пошло не так |
| msg строка | failure | Краткое описание произошедшего. |
| new_autosplit строка | При изменении autosplit. | Новое состояние autosplit. |
| new_balancer_state строка | При изменении состояния балансировщика | Новое состояние балансировщика. |
| new_chunksize целое число | При изменении chunksize. | Новое значение для chunksize. |
| old_autosplit строка | При изменении autosplit. | Предыдущее состояние autosplit. |
| old_balancer_state строка | При изменении состояния балансировщика | Предыдущее состояние балансировщика |
| old_chunksize целое число | При изменении chunksize. | Предыдущее значение для chunksize. |
Авторы
- 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_balancer_module.html
