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

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

Для его установки используйте: 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 выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User-Agent для всех запросов к 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 в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «name» и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_iam_service_account, а затем установить это поле service_account на "{{ name-of-resource }}"
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 строка	success	Указывает алгоритм для ключа.
keyType строка	success	Указывает тип ключа. Возможные значения включают KEY_TYPE_UNSPECIFIED, USER_MANAGED и SYSTEM_MANAGED.
name строка	success	Имя ключа.
path строка	success	Полное имя файла, который будет содержать закрытый ключ учетной записи службы. Управление этим файлом зависит от значения параметра sync_file. Путь к файлу должен быть абсолютным.
privateKeyData строка	success	Данные закрытого ключа. Кодированы в base-64.
privateKeyType строка	success	Формат вывода ключа учетной записи службы.
publicKeyData строка	success	Данные открытого ключа. Кодированы в base-64.
serviceAccount словарь	success	Имя учетной записи службы.
validAfterTime строка	success	Ключ может быть использован только после этой даты.
validBeforeTime строка	success	Ключ может быть использован только до этой даты.

Авторы

Google Inc. (@googlecloudplatform)

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