Модуль google.cloud.gcp_secret_manager — Доступ и обновление объектов Google Cloud Secrets Manager

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_secret_manager.

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Доступ к секретам, хранящимся в Google Secrets Manager.
Создание новых секретов.
Создание новых значений секретов.
Добавление/удаление версий секретов.
Обратите внимание, что другие функции, такие как etags, репликация, аннотации, предполагается управлять вне Ansible.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
auth_kind строка / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"`
labels словарь	Набор пар ключ-значение для назначения в качестве меток секрету Используется только при создании Обратите внимание, что часть «значение» метки должна содержать только удобочитаемые символы
name псевдонимы: key, secret, secret_id строка / обязательный	Имя секрета для использования
project строка	Проект Google Cloud Platform для использования.
return_value булево	Если true, значение секрета будет возвращено Ansible в виде нешифрованного текста. Если false, значение не будет возвращено или расшифровано. Варианты: `false` `true` ← (по умолчанию)
scopes список / элементы=строка	Массив используемых областей.
service_account_contents jsonarg	Содержание файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка	Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если serviceaccount выбран в качестве типа.
state строка	Нужно ли, чтобы секрет существовал. Варианты: `"absent"` `"present"` ← (по умолчанию)
value строка	Значение секрета, которое должен иметь секрет. Устанавливается при создании. Если значение секрета иное, будет добавлена новая версия с этим значением.
version строка	Метка версии для применения к секрету. По умолчанию «latest» (последняя версия секрета). Также допустима специальная метка «all» для удаления (удалит все версии секрета). По умолчанию: `"latest"`

Примечания

Примечание

Ссылка на API: https://cloud.google.com/secret-manager/docs/reference/rests
Официальная документация: https://cloud.google.com/secret-manager/docs/overview
Для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использованы только если значения в плейбуке не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: Create a new secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: super_secret
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Ensure the secretexists, fail otherwise and return the value
  google.cloud.gcp_secret_manager:
    name: secret_key
    state: present

- name: Ensure secret exists but don't return the value
  google.cloud.gcp_secret_manager:
    name: secret_key
    state: present
    return_value: false

- name: Add a new version of a secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: updated super secret
    state: present

- name: Delete version 1 of a secret (but not the secret itself)
  google.cloud.gcp_secret_manager:
    name: secret_key
    version: 1
    state: absent

- name: Delete all versions of a secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    version: all
    state: absent

- name: Create a secret with labels
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: super_secret
    labels:
      key_name: "ansible_rox"

Авторы

Dave Costakos @RedHat

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

При обработке документации этого плагина возникли ошибки. Пожалуйста, сообщите об ошибке в коллекции google.cloud.

Возникшие ошибки:

Unable to normalize gcp_secret_manager: return due to: 7 validation errors for PluginReturnSchema
return -> resources -> msg
  extra fields not permitted (type=value_error.extra)
return -> resources -> name
  extra fields not permitted (type=value_error.extra)
return -> resources -> payload
  extra fields not permitted (type=value_error.extra)
return -> resources -> status_code
  extra fields not permitted (type=value_error.extra)
return -> resources -> url
  extra fields not permitted (type=value_error.extra)
return -> resources -> value
  extra fields not permitted (type=value_error.extra)
return -> resources -> version
  extra fields not permitted (type=value_error.extra)

© 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/google/cloud/gcp_secret_manager_module.html