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	Тип используемых учетных данных.
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 строка		Строка, представляющая содержимое JSON-файла учётной записи службы. Это не должно передаваться в виде словаря, а в виде строки с точным содержимым файла JSON учётной записи службы (валидный JSON).
service_account_email строка		Дополнительный адрес электронной почты учётной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учётной записи службы, если в качестве типа выбран serviceaccount.
state -	Варианты: present ← absent	Требуется ли существование данного объекта в GCP

Примечания

Примечание

Для проверки подлинности можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для проверки подлинности можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для проверки подлинности можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для проверки подлинности можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для проверки подлинности можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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. [community]

Авторы

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