community.general.redis модуль – Различные команды redis, репликация и очистка

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.redis.

Описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры

Описание

Универсальный инструмент для взаимодействия с экземплярами redis.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

certifi
redis

Параметры

Параметр	Комментарии
ca_certs строка добавлено в community.general 4.6.0	Путь к файлу корневых сертификатов. Если не задан и `tls` установлен в `true`, будет использован certifi ca-certificates.
client_cert_file строка добавлено в community.general 9.3.0	Путь к файлу клиентского сертификата.
client_key_file строка добавлено в community.general 9.3.0	Путь к файлу закрытого ключа клиента.
command строка	Выбранная команда redis `config` гарантирует настройку параметра на экземпляре. `flush` очищает все экземпляры или указанную базу данных. `replica` устанавливает экземпляр redis в режим реплики или мастер. (`slave` - псевдоним для `replica`.) Варианты: `"config"` `"flush"` `"replica"` `"slave"`
db целое число	База данных для очистки (используется в режиме базы данных) [команда очистки]
flush_mode строка	Тип очистки (все БД в экземпляре redis или определенная) [команда очистки] Варианты: `"all"` ← (по умолчанию) `"db"`
login_host строка	Указывает целевой хост, на котором запущена база данных. По умолчанию: `"localhost"`
login_password строка	Укажите пароль для аутентификации. Обычно не используется, когда целевой хост — localhost.
login_port целое число	Укажите порт для подключения. По умолчанию: `6379`
login_user строка добавлено в community.general 4.6.0	Укажите пользователя для аутентификации. Требуется redis >= 3.4.0.
master_host строка	Хост мастер-экземпляра [команда реплики]
master_port целое число	Порт мастер-экземпляра [команда реплики]
name строка	Ключ конфигурации redis.
replica_mode псевдонимы: slave_mode строка	Режим экземпляра redis [команда реплики] `slave` - псевдоним для `replica`. Варианты: `"master"` `"replica"` ← (по умолчанию) `"slave"`
tls булево добавлено в community.general 4.6.0	Указать, использовать ли TLS для подключения. Варианты: `false` ← (по умолчанию) `true`
validate_certs булево добавлено в community.general 4.6.0	Указать, валидировать ли TLS сертификаты. Это следует отключать только для сайтов, находящихся под личным контролем, или когда `localhost` используется в качестве цели. Варианты: `false` `true` ← (по умолчанию)
value строка	Значение конфигурации redis. При необходимости размера памяти можно указать его в обычном формате 1KB, 2M, 400MB, где основание 1024. Единицы измерения нечувствительны к регистру, т.е. 1m = 1mb = 1M = 1MB.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Вернет детали изменений (или, возможно, необходимых изменений в `check_mode`), когда используется режим diff.

Примечания

Примечание

Требуется пакет redis-py для Python на удалённом хосте. Его можно установить с помощью pip (pip install redis) или с помощью менеджера пакетов. https://github.com/andymccurdy/redis-py
Если мастер-инстанс Redis, для которого создаётся репликация, защищён паролем, то этот пароль должен быть указан в файле redis.conf в переменной masterauth
Требуется пакет redis для Python на удалённом хосте. Его можно установить с помощью pip (pip install redis) или с помощью менеджера пакетов. Сведения о библиотеке можно найти по адресу https://github.com/andymccurdy/redis-py.

См. также

community.general.redis_info: Сбор информации о серверах Redis.

Примеры

- name: Set local redis instance to be a replica of melee.island on port 6377
  community.general.redis:
    command: replica
    master_host: melee.island
    master_port: 6377

- name: Deactivate replica mode
  community.general.redis:
    command: replica
    replica_mode: master

- name: Flush all the redis db
  community.general.redis:
    command: flush
    flush_mode: all

- name: Flush only one db in a redis instance
  community.general.redis:
    command: flush
    db: 1
    flush_mode: db

- name: Configure local redis to have 10000 max clients
  community.general.redis:
    command: config
    name: maxclients
    value: 10000

- name: Configure local redis maxmemory to 4GB
  community.general.redis:
    command: config
    name: maxmemory
    value: 4GB

- name: Configure local redis to have lua time limit of 100 ms
  community.general.redis:
    command: config
    name: lua-time-limit
    value: 100

- name: Connect using TLS and certificate authentication
  community.general.redis:
    command: config
    name: lua-time-limit
    value: 100
    tls: true
    ca_certs: /etc/redis/certs/ca.crt
    client_cert_file: /etc/redis/certs/redis.crt
    client_key_file: /etc/redis/certs/redis.key

Авторы

Xabier Larrakoetxea (@slok)

Ссылки на сборку

© 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/general/redis_module.html