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

Новый в версии 2.8.

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

Синопсис

Учетная запись службы в 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

Примечания

Примечание

Для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
Для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

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

Статус

Данному модулю не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/gcp_iam_service_account_key_module.html