gcp_kms_crypto_key – Создаёт GCP CryptoKey

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

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

Обзор

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 строка			При каждом истечении этого периода генерируется новая версия CryptoKey и устанавливается в качестве основной. Первая ротация произойдёт после указанного периода. Период ротации должен иметь формат десятичного числа с максимальной частью дробной части 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 с использованием переменной среды 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: 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
  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

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

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

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

Статус

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

Авторы

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_crypto_key_module.html