Spec-Zone.ru › Ansible 2.8

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

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

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

Обзор

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

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
display_name
-
Пользовательское описание учетной записи сервиса.
name
-
Имя учетной записи сервиса.
project
строка
Проект Google Cloud Platform, который нужно использовать.
scopes
список
Массив используемых областей.
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: '"{{resource_name}}@{{gcp_project}}.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
строка
success
Пользовательское описание учетной записи сервиса.

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

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

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

projectId
строка
success
Идентификатор проекта, которому принадлежит учетная запись сервиса.

uniqueId
строка
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_module.html

Spec-Zone.ru

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