Spec-Zone.ru › Ansible 2.9

gcp_iam_service_account – Создаёт учётную запись сервиса GCP

Новая в версии 2.8.

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

Обзор

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

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
display_name
строка
Пользовательское описание учётной записи сервиса.
env_type
строка
Указывает, в какой среде Ansible выполняется этот модуль.
Это не следует устанавливать, если вы не знаете, что делаете.
Это изменяет только строку User Agent для любых запросов к API.
name
строка
Имя учётной записи сервиса.
project
строка
Проект Google Cloud Platform, который нужно использовать.
scopes
список
Массив используемых областей.
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: sa-{{ resource_name.split("-")[-1] }}@graphite-playground.google.com.iam.gserviceaccount.com
    display_name: My Ansible test key
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ Возвращаемое Описание
displayName
строка
успех
Пользовательское описание учётной записи сервиса.

email
строка
успех
Адрес электронной почты учётной записи сервиса.

name
строка
успех
Имя учётной записи сервиса.

oauth2ClientId
строка
успех
Идентификатор клиента OAuth2 для учётной записи сервиса.

projectId
строка
успех
Идентификатор проекта, владеющего учётной записью сервиса.

uniqueId
строка
успех
Уникальный и стабильный идентификатор учётной записи сервиса.



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API