google.cloud.gcp_kms_crypto_key – Создаёт GCP CryptoKey

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_kms_crypto_key

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

Обзор

A CryptoKey представляет собой логический ключ, который может быть использован для криптографических операций.

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка			Указывает, в какой среде Ansible выполняется этот модуль. Следует устанавливать только в случае необходимости. Изменяет только строку User Agent для всех запросов API.
key_ring строка / обязательно			KeyRing, к которому принадлежит этот ключ. Формат: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
labels словарь			Метки с пользовательскими метаданными, применяемые к этому ресурсу.
name строка / обязательно			Имя ресурса CryptoKey.
project строка			Проект Google Cloud Platform, который нужно использовать.
purpose строка		По умолчанию: "ENCRYPT_DECRYPT"	Неизменяемое назначение CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для возможных значений. Некоторые допустимые значения: "ENCRYPT_DECRYPT", "ASYMMETRIC_SIGN", "ASYMMETRIC_DECRYPT"
rotation_period строка			Каждый раз, когда проходит этот период, генерируется новая версия CryptoKeyVersion и устанавливается как основная. Первый цикл обновления произойдет через указанный период. Период обновления имеет формат десятичного числа с до 9 знаками после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400).
scopes список / элементы=строка			Массив используемых областей.
service_account_contents jsonarg			Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, его представляющая.
service_account_email строка			Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка		Варианты: present ← absent	Существование объекта в GCP.
version_template словарь			Шаблон, описывающий параметры для новых версий ключей шифрования.
	algorithm строка / обязательно		Используемый алгоритм при создании версии на основе этого шаблона. См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных значений.
	protection_level строка		Уровень защиты при создании версии на основе этого шаблона. Некоторые допустимые значения: "SOFTWARE", "HSM"

Примечания

Примечание

Ссылка на API: https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys
Создание ключа: https://cloud.google.com/kms/docs/creating-keys#create_a_key
для аутентификации можно установить 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: key-key-ring
    location: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: keyring

- name: create a crypto key
  google.cloud.gcp_kms_crypto_key:
    name: test_object
    key_ring: projects/{{ gcp_project }}/locations/us-central1/keyRings/key-key-ring
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ		Возвращаемое значение	Описание
createTime строка		успех	Время создания этого ресурса на сервере. Формат – RFC3339.
keyRing строка		успех	KeyRing, к которому принадлежит этот ключ. Формат: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
labels словарь		успех	Метки с пользовательскими метаданными, применяемые к этому ресурсу.
name строка		успех	Имя ресурса CryptoKey.
nextRotationTime строка		успех	Время, когда KMS создаст новую версию этого CryptoKey.
purpose строка		успех	Неизменяемое назначение CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для возможных значений.
rotationPeriod строка		успех	Каждый раз, когда проходит этот период, генерируется новая версия CryptoKeyVersion и устанавливается как основная. Первый цикл обновления произойдет через указанный период. Период обновления имеет формат десятичного числа с до 9 знаками после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400).
versionTemplate сложный		успех	Шаблон, описывающий параметры для новых версий ключей шифрования.
	algorithm строка	успех	Используемый алгоритм при создании версии на основе этого шаблона. См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных значений.
	protectionLevel строка	успех	Уровень защиты при создании версии на основе этого шаблона.

Авторы

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.10/collections/google/cloud/gcp_kms_crypto_key_module.html