Модуль community.mongodb.mongodb_balancer — Управление балансировщиком кластера MongoDB Sharded.
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.7).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: community.mongodb.mongodb_balancer.
Новинка в community.mongodb 1.0.0
Описание
- Управляет балансировщиком кластера MongoDB Sharded.
- Запуск или остановка балансировщика.
- Настройка размера фрагмента кластера.
- Включение или отключение автоматического разделения.
- Добавление или удаление окна балансировки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- pymongo
Параметры
Параметр | Комментарии |
|---|---|
atlas_auth boolean | Путь авторизации, предназначенный для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism string | Тип авторизации. Варианты:
|
autosplit boolean | Отключить или включить флаг autosplit в коллекции config.settings. Начиная с MongoDB 6.1, автоматическое разделение фрагментов не выполняется, поэтому этот параметр недействителен в этой и более поздних версиях. Подробнее см. [enableAutoSplit](https://www.mongodb.com/docs/manual/reference/method/sh.enableAutoSplit/). Этот параметр устарел и будет удален в будущей версии. Варианты:
|
chunksize integer | Управление размером фрагментов в фрагментированном кластере. Значение должно быть указано в МБ. |
connection_options list / elements=any | Дополнительные параметры подключения. Указываются в виде списка словарей или строк, содержащих пары ключ-значение, разделенные знаком ‘=’. |
login_database string | База данных, в которой хранятся учетные данные для входа. По умолчанию: |
login_host string | Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: |
login_password string | Пароль, используемый для аутентификации. Требуется, когда указан параметр login_user. |
login_port integer | Порт сервера MongoDB для входа. По умолчанию: |
login_user string | Пользователь MongoDB для входа. Требуется, когда указан параметр login_password. |
mongos_process string | Предоставьте пользовательское имя для процесса mongos. Большинство пользователей могут пропустить этот параметр. По умолчанию: |
ssl aliases: tls boolean | Использовать соединение SSL при подключении к базе данных. Варианты:
|
ssl_ca_certs aliases: tlsCAFile string | Параметр ssl_ca_certs принимает путь к файлу CA. |
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string | Указывает, требуется ли сертификат с другой стороны соединения и будет ли он проверен при предоставлении. Варианты:
|
ssl_certfile aliases: tlsCertificateKeyFile string | Предоставить сертификат клиента с помощью ssl_certfile. |
ssl_crlfile string | Параметр ssl_crlfile принимает путь к файлу CRL. |
ssl_keyfile string | Приватный ключ для сертификата клиента. |
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string | Пароль для расшифровки зашифрованных приватных ключей. |
state string | Управление балансировщиком кластера Варианты:
|
strict_compatibility boolean | Принудительное соблюдение строгих требований к версиям pymongo и MongoDB Варианты:
|
window any | Расписание окна балансировщика. Укажите следующие ключи словаря: start, stop, state Ключ state должен быть «present» или «absent». Ключи start и stop игнорируются, когда state равен «absent». Ключи start и stop должны быть строками в формате «ЧЧ:ММ», указывающими временные границы окна. |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном узле, версия 4+. Его можно установить с помощью pip или менеджера пакетов ОС. @см. 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 | Изменилось ли состояние балансировщика или авторазделения? Возвращаемое значение: success |
failed boolean | Если что-то пошло не так Возвращаемое значение: failed |
msg string | Краткое описание произошедшего. Возвращаемое значение: failure |
new_autosplit string | Новое состояние авторазделения. Возвращаемое значение: При изменении autosplit. |
new_balancer_state string | Новое состояние балансировщика. Возвращаемое значение: При изменении состояния балансировщика |
new_chunksize integer | Новое значение chunksize. Возвращаемое значение: При изменении chunksize. |
old_autosplit string | Предыдущее состояние авторазделения. Возвращаемое значение: При изменении autosplit. |
old_balancer_state string | Предыдущее состояние балансировщика. Возвращаемое значение: При изменении состояния балансировщика |
old_chunksize integer | Предыдущее значение для chunksize. Возвращаемое значение: При изменении chunksize. |
Ссылки на коллекцию
© 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_balancer_module.html
