Модуль google.cloud.gcp_kms_key_ring – Создает GCP KeyRing
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: google.cloud.gcp_kms_key_ring.
Краткое описание
- A `KeyRing` is a toplevel logical grouping of `CryptoKeys`.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / required | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API. |
location string / required | Расположение для KeyRing. Полный список допустимых расположений можно найти, выполнив команду `gcloud kms locations list`. |
name string / required | Имя ресурса для KeyRing. |
project string | Используемый проект Google Cloud Platform. |
scopes list / elements=string | Массив областей, которые будут использоваться |
service_account_contents jsonarg | Содержимое файла Service Account JSON, либо в виде словаря, либо в виде JSON-строки, которая его представляет. |
service_account_email string | Необязательный адрес электронной почты учетной записи сервисного обслуживания, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к файлу Service Account 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. - Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
- Параметры 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 строка | Время создания этого ресурса на сервере. Формат — RFC3339. Возвращено: успешно |
location строка | Расположение KeyRing. Полный список допустимых расположений можно найти, выполнив команду `gcloud kms locations list`. Возвращено: успешно |
name строка | Имя ресурса KeyRing. Возвращено: успешно |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_kms_key_ring_module.html
