community.mongodb.mongodb_stepdown – Перевод узла MongoDB в состояние SECONDARY из PRIMARY.
Примечание
Этот плагин входит в состав коллекции community.mongodb (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.mongodb
Для использования в плейбуке укажите: community.mongodb.mongodb_stepdown
Новое в версии 1.0.0: коллекции community.mongodb
Обзор
- Переводит узел MongoDB в состояние SECONDARY, если он находится в состоянии PRIMARY. Если член уже находится в состояниях SECONDARY или ARBITER, то возвращает OK немедленно. Будет ждать, пока состояние члена не достигнет SECONDARY или PRIMARY, если текущее состояние члена STARTUP, RECOVERING, STARTUP2 или ROLLBACK, прежде чем предпринять необходимые действия.
Требования
Ниже приведенные требования необходимы на хосте, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| connection_options список / элементы=необработанные | Дополнительные параметры подключения. Указывайте как список словарей или строк, содержащих пары ключ-значение, разделенные символом «=». | |
| force логический |
| Необязательно. Логическое значение, определяющее, будет ли первичный узел переведен в состояние SECONDARY, если нет вторичного узла, готового и актуального, в течение периода ожидания. |
| interval целое число | Значение по умолчанию: 30 | Количество секунд, ожидаемое между выполнениями опроса. |
| login_database строка | Значение по умолчанию: "admin" | База данных, в которой хранятся учетные данные входа. |
| login_host строка | Значение по умолчанию: "localhost" | Хост, на котором запущен экземпляр MongoDB для входа. |
| login_password строка | Пароль, используемый для аутентификации. Требуется при указании login_user. | |
| login_port целое число | Значение по умолчанию: 27017 | Порт сервера MongoDB для входа. |
| login_user строка | Пользователь MongoDB для входа. Требуется при указании login_password. | |
| poll целое число | Значение по умолчанию: 1 | Максимальное количество попыток запроса состояния члена. |
| secondary_catch_up целое число | Значение по умолчанию: 10 | Параметр secondaryCatchUpPeriodSecs для команды stepDown. Количество секунд, которое mongod будет ждать, пока вторичный узел будет синхронизирован с первичным. |
| 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 строка | Пароль для расшифровки зашифрованных закрытых ключей. | |
| stepdown_seconds целое число | Значение по умолчанию: 60 | Количество секунд для перевода первичного узла, в течение которого узел, переводимый в состояние SECONDARY, не может стать первичным. |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. @см http://api.mongodb.org/python/current/installation.html
Примеры
- name: Step down the current MongoDB member
community.mongodb.mongodb_stepdown:
login_user: admin
login_password: secret
- name: Step down the current MongoDB member, poll a maximum of 5 times if member state is recovering
community.mongodb.mongodb_stepdown:
login_user: admin
login_password: secret
poll: 5
interval: 10
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed логический | всегда | Указывает, произошла ли ошибка в модуле или нет. |
| iteration целое число | всегда | Количество раз, когда модуль запрашивал состояние репликации. |
| msg строка | всегда | Сообщение статуса. |
Авторы
- 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_stepdown_module.html
