модуль google.cloud.gcp_kms_crypto_key — создание CryptoKey в GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: 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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для любых запросов к API.
key_ring string / обязательный	KeyRing, к которому относится этот ключ. Формат: `’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`.
labels dictionary	Метки с метаданными, заданными пользователем, которые нужно применить к этому ресурсу.
name string / обязательный	Имя ресурса CryptoKey.
project string	Проект Google Cloud Platform, который нужно использовать.
purpose string	Неизменяемое назначение CryptoKey. Допустимые значения см. в разделе https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose. Допустимые варианты: “ENCRYPT_DECRYPT”, “ASYMMETRIC_SIGN”, “ASYMMETRIC_DECRYPT” По умолчанию: `"ENCRYPT_DECRYPT"`
rotation_period string	По истечении каждого такого периода создается новая CryptoKeyVersion и назначается основной. Первая ротация произойдет по истечении указанного периода. Период ротации задается десятичным числом, содержащим до 9 знаков после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (то есть 86400).
scopes list / элементы=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы. Используется, если выбран параметр machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
skip_initial_version_creation boolean	Если задано значение true, запрос создаст CryptoKey без CryptoKeyVersions. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`. Варианты: `false` ← (по умолчанию) `true`
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
version_template dictionary	Шаблон, описывающий параметры новых версий криптографического ключа.
algorithm string / обязательный	Алгоритм, используемый при создании версии на основе этого шаблона. Возможные значения см. в [справочнике по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm).
protection_level string	Уровень защиты, используемый при создании версии на основе этого шаблона. Допустимые варианты: “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.
Для аутентификации можно задать access_token с помощью переменной окружения GCP_ACCESS_TOKEN.
Для аутентификации можно задать 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 string	Время создания этого ресурса на сервере. Представлено в текстовом формате RFC3339. Возвращается: success
keyRing string	KeyRing, к которому относится этот ключ. Формат: `’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`. Возвращается: success
labels dictionary	Метки с метаданными, заданными пользователем, которые нужно применить к этому ресурсу. Возвращается: success
name string	Имя ресурса CryptoKey. Возвращается: success
nextRotationTime string	Время, когда KMS создаст новую версию этого криптографического ключа. Возвращается: success
purpose string	Неизменяемое назначение CryptoKey. Допустимые значения см. в разделе https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose. Возвращается: success
rotationPeriod string	По истечении каждого такого периода создается новая CryptoKeyVersion и назначается основной. Первая ротация произойдет по истечении указанного периода. Период ротации задается десятичным числом, содержащим до 9 знаков после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (то есть 86400). Возвращается: success
skipInitialVersionCreation boolean	Если задано значение true, запрос создаст CryptoKey без CryptoKeyVersions. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`. Возвращается: success
versionTemplate complex	Шаблон, описывающий параметры новых версий криптографического ключа. Возвращается: success
algorithm string	Алгоритм, используемый при создании версии на основе этого шаблона. Возможные значения см. в [справочнике по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm). Возвращается: success
protectionLevel string	Уровень защиты, используемый при создании версии на основе этого шаблона. Возвращается: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_kms_crypto_key_module.html