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

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

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

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

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

Новое в sensu.sensu_go 1.6.0

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

Описание

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

Требования

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

python >= 2.7

Параметры

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

END_OF_DOCUMENT_MARKER

version

string

Версия хранилища Vault key/value.

Дополнительную информацию см. на https://www.vaultproject.io/docs/secrets/kv.

Требуется, если state — present.

Варианты:

"v1"
"v2"

См. также

sensu.sensu_go.secrets_provider_env: Управление поставщиком секретов Sensu Env.
sensu.sensu_go.secrets_provider_info: Список поставщиков секретов Sensu.
sensu.sensu_go.secret: Управление секретами Sensu Go.
sensu.sensu_go.secret_info: Список доступных секретов Sensu Go.

Примеры

- 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"}}`

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/secrets_provider_vault_module.html