Модуль sensu.sensu_go.secret — Управление секретами Sensu Go

Примечание

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

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

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

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

Добавлен в sensu.sensu_go 1.6.0

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

Обзор

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

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
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` ← (значение по умолчанию)
id строка	Идентификатор секрета в хранилище поставщика. Требуется, если state равно `present`.
name строка / обязательно	Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операцию. Если ресурс с указанным именем уже существует, модуль Ansible обновит его, чтобы соответствовать спецификации в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка	Пространство имен RBAC для работы. Если не задано, будет использоваться значение переменной среды SENSU_NAMESPACE. Значение по умолчанию: `"default"`
provider строка	Имя поставщика секретов, который хранит значение секрета. Требуется, если state равно `present`.
state строка	Целевое состояние объекта Sensu. Доступные значения: `"present"` ← (значение по умолчанию) `"absent"`

См. также

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

Примеры

- name: Create an environment varibale-backed secret
  sensu.sensu_go.secret:
    name: env_secret
    provider: env
    id: MY_ENV_VARIABLE

- name: Create a HashiCorp Vault-backed secret
  sensu.sensu_go.secret:
    name: hashi_valut_secret
    provider: vault
    id: secret/store#name

- name: Delete a secret
  sensu.sensu_go.secret:
    name: my_secret
    state: absent

Значения возврата

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

Ключ	Описание
object словарь	Объект, представляющий секрет Sensu. Возвращено: успех Пример: `{"id": "secret/database#password", "metadata": {"name": "sensu-ansible", "namespace": "default"}, "provider": "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/secret_module.html