gcp_kms_key_ring – Создаёт GCP KeyRing

Новое в версии 2.9.

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

Обзор

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, используя переменную среды c(gcp_service_account_file).
для аутентификации можно задать service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно задать service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно задать auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно задать scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a key ring
  gcp_kms_key_ring:
    name: test_object
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_kms_key_ring_module.html