google.cloud.gcp_kms_key_ring – Создаёт GCP KeyRing

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.2).

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

Для использования в плейбуке укажите: google.cloud.gcp_kms_key_ring.

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

Обзор

A KeyRing — это логическая группировка верхнего уровня CryptoKeys.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
location строка / обязательно		Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив команду `gcloud kms locations list`.
name строка / обязательно		Имя ресурса KeyRing.
project строка		Проект Google Cloud Platform, который нужно использовать.
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде строки JSON, его представляющей.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount.
state строка	Варианты: present ← absent	Следует ли создавать данный объект в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings
Создание кольца ключей: https://cloud.google.com/kms/docs/creating-keys#create_a_key_ring
для аутентификации можно установить 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 key ring
  google.cloud.gcp_kms_key_ring:
    name: test_object
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Возвращаемое значение	Описание
createTime строка	успех	Время создания этого ресурса на сервере. Формат RFC3339.
location строка	успех	Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив команду `gcloud kms locations list`.
name строка	успех	Имя ресурса KeyRing.

Авторы

Google Inc. (@googlecloudplatform)

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