google.cloud.gcp_iam_service_account_key – Создаёт ключ GCP ServiceAccountKey

Примечание

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

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

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

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

Обзор

Учётная запись службы в API управления идентификацией и доступом.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible вы запускаете этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это поле изменяет только строку имени пользователя для любых запросов к API.
key_algorithm строка		Указывает алгоритм для ключа. Некоторые допустимые значения: "KEY_ALG_UNSPECIFIED", "KEY_ALG_RSA_1024", "KEY_ALG_RSA_2048"
path путь		Полное имя файла, в котором будет храниться закрытый ключ учётной записи службы. Управление этим файлом будет зависеть от значения параметра sync_file. Путь к файлу должен быть абсолютным.
private_key_type строка		Формат вывода ключа учётной записи службы. Некоторые допустимые значения: "TYPE_UNSPECIFIED", "TYPE_PKCS12_FILE", "TYPE_GOOGLE_CREDENTIALS_FILE"
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка		Массив используемых областей.
service_account словарь		Имя serviceAccount. Это поле представляет собой ссылку на ресурс ServiceAccount в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_iam_service_account, а затем установить это поле service_account в "{{ имя-ресурса }}"
service_account_contents jsonarg		Содержимое файла JSON учётной записи службы, представленное либо в виде словаря, либо в виде строки JSON, которая его представляет.
service_account_email строка		Дополнительный адрес электронной почты учётной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учётной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Требуется ли существование данного объекта в GCP.

Примеры

- 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 строка	успех	Указывает алгоритм для ключа.
keyType строка	успех	Указывает тип ключа. Возможные значения включают KEY_TYPE_UNSPECIFIED, USER_MANAGED и SYSTEM_MANAGED.
name строка	успех	Имя ключа.
path строка	успех	Полное имя файла, в котором будет храниться закрытый ключ учётной записи службы. Управление этим файлом будет зависеть от значения параметра sync_file. Путь к файлу должен быть абсолютным.
privateKeyData строка	успех	Данные закрытого ключа. Кодированы в формате Base-64.
privateKeyType строка	успех	Формат вывода ключа учётной записи службы.
publicKeyData строка	успех	Данные открытого ключа. Кодированы в формате Base-64.
serviceAccount словарь	успех	Имя serviceAccount.
validAfterTime строка	успех	Ключ может быть использован только после этого времени.
validBeforeTime строка	успех	Ключ может быть использован только до этого времени.

Авторы

Google Inc. (@googlecloudplatform)

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