Модуль google.cloud.gcp_iam_service_account_key — создание ServiceAccountKey в GCP

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_iam_service_account_key.

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

Краткое описание

Учётная запись службы в API Identity and Access Management.

Требования

Для выполнения этого модуля на хосте необходимы следующие компоненты.

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_algorithm string	Указывает алгоритм ключа. Допустимые варианты, например: “KEY_ALG_UNSPECIFIED”, “KEY_ALG_RSA_1024”, “KEY_ALG_RSA_2048”
path path	Полный путь к файлу, в котором будет храниться закрытый ключ учётной записи службы. Если файл уже существует, будет предпринята попытка его прочитать. Убедитесь, что файл не существует или уже содержит действительный ключ. Путь к файлу должен быть абсолютным.
private_key_type string	Формат выходных данных для ключа учётной записи службы. Допустимые варианты, например: “TYPE_UNSPECIFIED”, “TYPE_PKCS12_FILE”, “TYPE_GOOGLE_CREDENTIALS_FILE”
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / elements=string	Массив используемых областей доступа
service_account dictionary	Имя учётной записи службы. Это поле представляет собой ссылку на ресурс ServiceAccount в GCP. Его можно указать двумя способами. Во-первых, можно передать словарь с ключом ‘name’ и значением, соответствующим имени ресурса. Или же можно добавить `register: name-of-resource` в задачу gcp_iam_service_account, а затем присвоить этому полю service_account значение “{{ name-of-resource }}”
service_account_contents jsonarg	Содержимое JSON-файла учётной записи службы — в виде словаря или JSON-строки, представляющей этот словарь.
service_account_email string	Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примеры

- name: create a service account
  google.cloud.gcp_iam_service_account:
    name: test-ansible@graphite-playground.google.com.iam.gserviceaccount.com
    display_name: My Ansible test key
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: serviceaccount

- name: create a service account key
  google.cloud.gcp_iam_service_account_key:
    service_account: "{{ serviceaccount }}"
    private_key_type: TYPE_GOOGLE_CREDENTIALS_FILE
    path: "~/test_account.json"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
keyAlgorithm string	Указывает алгоритм ключа. Возвращается: при успехе
keyType string	Указывает тип ключа. Возможные значения: KEY_TYPE_UNSPECIFIED, USER_MANAGED и SYSTEM_MANAGED . Возвращается: при успехе
name string	Имя ключа. Возвращается: при успехе
path string	Полный путь к файлу, в котором будет храниться закрытый ключ учётной записи службы. Если файл уже существует, будет предпринята попытка его прочитать. Убедитесь, что файл не существует или уже содержит действительный ключ. Путь к файлу должен быть абсолютным. Возвращается: при успехе
privateKeyData string	Данные закрытого ключа. Закодированы в Base64. Возвращается: при успехе
privateKeyType string	Формат выходных данных для ключа учётной записи службы. Возвращается: при успехе
publicKeyData string	Данные открытого ключа. Закодированы в Base64. Возвращается: при успехе
serviceAccount dictionary	Имя учётной записи службы. Возвращается: при успехе
validAfterTime string	Ключ можно использовать только после этого времени. Возвращается: при успехе
validBeforeTime string	Ключ можно использовать только до этого времени. Возвращается: при успехе

Авторы

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