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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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`, но этот параметр не указан, используются сертификаты CA из certifi.
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 целое число	База данных для очистки (используется в режиме DB) [команда flush].
flush_mode строка	Тип очистки (все базы данных экземпляра Redis или одна указанная) [команда flush]. Варианты: `"all"` ← (по умолчанию) `"db"`
login_host строка	Укажите целевой узел, на котором работает база данных. По умолчанию: `"localhost"`
login_password строка	Укажите пароль для аутентификации. Обычно не используется, если целевой узел — localhost.
login_port целое число	Укажите порт для подключения. По умолчанию: `6379`
login_user строка добавлено в community.general 4.6.0	Укажите имя пользователя для аутентификации. Требуется redis версии 3.4.0 или выше.
master_host строка	Узел, на котором работает экземпляр-мастер [команда replica].
master_port целое число	Порт экземпляра-мастера [команда replica].
name строка	Ключ конфигурации Redis.
replica_mode псевдонимы: slave_mode строка	Режим экземпляра Redis [команда replica]. `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	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

На удаленном узле требуется пакет Python redis-py. Его можно установить с помощью pip (pip install redis) или менеджера пакетов. https://github.com/andymccurdy/redis-py.
Если экземпляр Redis-мастера, репликой которого вы хотите сделать узел, защищен паролем, пароль необходимо указать в redis.conf в переменной masterauth.
На удаленном узле требуется пакет Python redis. Его можно установить с помощью 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/redis_module.html