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

Примечание

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

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

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

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

Описание

А 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 выбран.
skip_initial_version_creation булево		Варианты: no yes Значение по умолчанию: "false"	Если установлено в true, запрос создаст CryptoKey без каких-либо CryptoKeyVersions. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`.
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).
skipInitialVersionCreation булево		успех	Если установлено в true, запрос создаст CryptoKey без каких-либо CryptoKeyVersions. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`.
versionTemplate сложное		успех	Шаблон, описывающий параметры для новых версий криптоключа.
	algorithm строка	успех	Алгоритм, используемый при создании версии на основе этого шаблона. См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных вариантов.
	protectionLevel строка	успех	Уровень защиты, используемый при создании версии на основе этого шаблона.

Авторы

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