Модуль community.general.etcd3 — Установка или удаление пар ключ-значение в кластере etcd3

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.etcd3.

Описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Установка или удаление значений в кластере etcd3 с использованием его API v3.
Требуется библиотека python etcd3.

Требования

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

etcd3

Параметры

Параметр	Комментарии
ca_cert путь	Сертификат центра сертификации (CA), используемый для проверки хоста etcd. Требуется, если определены `client_cert` и `client_key`.
client_cert путь	Файл цепочки сертификатов клиента в формате PEM, используемый для аутентификации клиента по протоколу SSL. Требуется, если определён `client_key`.
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации клиента по протоколу SSL. Требуется, если определен `client_cert`.
host строка	IP-адрес кластера. По умолчанию: `"localhost"`
key строка / обязательно	Ключ, где хранится информация в кластере.
password строка	Пароль для аутентификации. Требуется, если определен `user`.
port целое число	Порт, используемый для подключения к кластеру. По умолчанию: `2379`
state строка / обязательно	Состояние значения для ключа. Может быть присутствующим или отсутствующим. Варианты: `"present"` `"absent"`
timeout целое число	Таймаут уровня сокета в секундах.
user строка	Пользователь etcd для аутентификации.
value строка / обязательно	Хранимые данные.

Атрибуты

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

Примеры

- name: Store a value "bar" under the key "foo" for a cluster located "http://localhost:2379"
  community.general.etcd3:
    key: "foo"
    value: "baz3"
    host: "localhost"
    port: 2379
    state: "present"

- name: Authenticate using user/password combination with a timeout of 10 seconds
  community.general.etcd3:
    key: "foo"
    value: "baz3"
    state: "present"
    user: "someone"
    password: "password123"
    timeout: 10

- name: Authenticate using TLS certificates
  community.general.etcd3:
    key: "foo"
    value: "baz3"
    state: "present"
    ca_cert: "/etc/ssl/certs/CA_CERT.pem"
    client_cert: "/etc/ssl/certs/cert.crt"
    client_key: "/etc/ssl/private/key.pem"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
key строка	Запрашиваемый ключ. Возвращается: всегда
old_value строка	Предыдущее значение в кластере. Возвращается: всегда

Авторы

Jean-Philippe Evrard (@evrardjp)
Victor Fauth (@vfauth)

Ссылки на коллекцию

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