sensu.sensu_go.secrets_provider_vault – Управление поставщиками секретов Sensu VaultProvider

Примечание

Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).

Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.

Для использования в книге задач укажите: sensu.sensu_go.secrets_provider_vault.

В версии 1.6.0: модуля sensu.sensu_go

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

Описание

Создание, обновление или удаление поставщика секретов Sensu Go VaultProvider.
Дополнительную информацию см. в документации Sensu Go по адресу https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/.

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
address строка			Адрес сервера Vault. Обязательно, если state равен `present`.
auth словарь			Параметры аутентификации. Можно определить каждый из них с помощью переменной среды.
	api_key строка добавлен в 1.3.0 sensu.sensu_go		Ключ API, который должен использоваться при аутентификации. Если он не задан, будет проверена переменная окружения SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
	ca_path путь добавлен в 1.5.0 sensu.sensu_go		Путь к файлу CA-сертификатов, используемому для проверки сертификата бэкенда. Если параметр не задан, модуль будет использовать CA-сертификаты, используемые Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
	password строка	По умолчанию: "P@ssw0rd!"	Пароль пользователя Sensu. Если не задан, будет проверена переменная среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key.
	url строка	По умолчанию: "http://localhost:8080"	Расположение API бэкенда Sensu. Если не задано, будет проверена переменная окружения SENSU_URL.
	user строка	По умолчанию: "admin"	Имя пользователя для подключения к API Sensu. Если не задано, будет проверена переменная окружения SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key.
	verify булево добавлен в 1.5.0 sensu.sensu_go	Варианты: no да ←	Флаг, контролирующий проверку сертификатов. Если вы используете самоподписанные сертификаты, можно установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в тестовых сценариях! При использовании самоподписанных сертификатов в продакшене, см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY.
burst_limit целое число			Максимальное допустимое количество запросов к секретам в интервале скоростей.
max_retries целое число			Максимальное количество попыток повторной попытки неудачных подключений к серверу Vault.
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где применимо) однозначно идентифицирует ресурс, с которым взаимодействует Ansible. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. Для получения дополнительной информации о допустимых именах и других ограничениях, см. спецификацию атрибута метаданных name в документации верхнего уровня по адресу https://docs.sensu.io/sensu-go/latest/reference/.
rate_limit вещественное число			Максимальное количество запросов к секретам в секунду.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
timeout целое число			Тайм-аут (в секундах) для соединения с сервером Vault.
tls словарь			Настройка TLS для установления соединения с сервером Vault.
	ca_cert строка		Путь к файлу сертификата доверенного центра сертификации.
	client_cert строка		Путь к файлу клиентского сертификата.
	client_key строка		Путь к файлу закрытого ключа клиента.
	cname строка		Каноническое имя клиента.
token строка			Токен аутентификации для использования с Vault. Обязательно, если state равен `present`.
version строка		Варианты: v1 v2	Версия хранилища ключей/значений Vault. Для получения дополнительной информации см. https://www.vaultproject.io/docs/secrets/kv. Обязательно, если state равен `present`.

См. также

sensu.sensu_go.secrets_provider_env: Официальная документация модуля sensu.sensu_go.secrets_provider_env.
sensu.sensu_go.secrets_provider_info: Официальная документация модуля sensu.sensu_go.secrets_provider_info.
sensu.sensu_go.secret: Официальная документация модуля sensu.sensu_go.secret.
sensu.sensu_go.secret_info: Официальная документация модуля sensu.sensu_go.secret_info.

Примеры

- name: Create a vault secrets provider
  sensu.sensu_go.secrets_provider_vault:
    name: my-vault
    address: https://my-vault.com
    token: VAULT_TOKEN
    version: v1

- name: Delete a vault secrets provider
  sensu.sensu_go.secrets_provider_vault:
    name: my-vault
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий поставщика секретов vault Sensu. Пример: {'client': {'address': 'https://vaultserver.example.com:8200', 'max_retries': 2, 'rate_limiter': {'burst': 100, 'limit': 10}, 'timeout': '20s', 'tls': {'ca_cert': '/etc/ssl/certs/vault_ca_cert.pem'}, 'token': 'VAULT_TOKEN', 'version': 'v1'}, 'metadata': {'name': 'vault'}}

Авторы

Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Dolinar (@mdolin)
Tadej Borovsak (@tadeboro)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/secrets_provider_vault_module.html