community.mongodb.mongodb_balancer – Управляет балансировщиком фрагментированного кластера MongoDB.
Примечание
Этот плагин входит в состав коллекции community.mongodb (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.mongodb.
Для использования в книге задач, укажите: community.mongodb.mongodb_balancer.
Новое в версии 1.0.0: из community.mongodb
Описание
- Управляет балансировщиком фрагментированного кластера MongoDB.
- Запуск или остановка балансировщика.
- Настройка размера фрагмента кластера.
- Включение или отключение автоматического разделения.
- Добавление или удаление окна балансировки.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| 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 булево | успешно | Изменилось ли состояние балансировщика или автоматического разделения. |
| failed булево | неудачно | Если что-то пошло не так |
| msg строка | ошибка | Краткое описание произошедшего. |
| new_autosplit строка | При изменении автоматического разделения. | Новое состояние автоматического разделения. |
| new_balancer_state строка | При изменении состояния балансировщика | Новое состояние балансировщика. |
| new_chunksize целое число | При изменении размера фрагмента. | Новое значение для размера фрагмента. |
| old_autosplit строка | При изменении автоматического разделения. | Предыдущее состояние автоматического разделения. |
| old_balancer_state строка | При изменении состояния балансировщика | Предыдущее состояние балансировщика |
| old_chunksize целое число | При изменении размера фрагмента. | Предыдущее значение для размера фрагмента. |
Авторы
- Rhys Campbell (@rhysmeister)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/mongodb/mongodb_balancer_module.html
