Spec-Zone.ru › Ansible 2.11

sensu.sensu_go.secret – Управление секретами Sensu Go

Примечание

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

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

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

Новое в версии 1.6.0: of sensu.sensu_go

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

Описание

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

Требования

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

  • python >= 2.7

Параметры

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

См. также

См. также

sensu.sensu_go.secret_info

Официальная документация по модулю sensu.sensu_go.secret_info.

sensu.sensu_go.secrets_provider_env

Официальная документация по модулю sensu.sensu_go.secrets_provider_env.

sensu.sensu_go.secrets_provider_vault

Официальная документация по модулю sensu.sensu_go.secrets_provider_vault.

sensu.sensu_go.secrets_provider_info

Официальная документация по модулю sensu.sensu_go.secrets_provider_info.

Примеры

- 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
словарь
success
Объект, представляющий секрет 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/secret_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API