Модуль google.cloud.gcp_kms_key_ring — создание KeyRing в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_kms_key_ring.
Обзор
- `KeyRing` — это логическая группа верхнего уровня, объединяющая `CryptoKeys`.
Требования
Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если в качестве типа учётных данных выбрано accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Допустимые значения:
|
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте этот параметр, если не уверены в своих действиях. Он изменяет только строку User Agent для любых запросов к API. |
location string / обязательный | Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив `gcloud kms locations list`. |
name string / обязательный | Имя ресурса KeyRing. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое файла JSON сервисного аккаунта: словарь или JSON-строка, представляющая его. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к файлу JSON сервисного аккаунта, если в качестве типа выбран serviceaccount. |
state string | Должен ли указанный объект существовать в 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 с помощью переменной среды
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: test_object
location: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
createTime string | Время создания этого ресурса на сервере. Формат текстового представления — RFC3339. Возвращается: при успехе |
location string | Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив `gcloud kms locations list`. Возвращается: при успехе |
name string | Имя ресурса KeyRing. Возвращается: при успехе |
Ссылки на коллекцию
© 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_key_ring_module.html
