google.cloud.gcp_runtimeconfig_variable_info – Сбор информации о переменной GCP

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_runtimeconfig_variable_info.

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

Обзор

Сбор информации о переменной GCP

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
config строка / обязательно		Имя конфигурации runtime, к которой относится эта переменная.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Изменяет только строку User Agent для всех запросов к API.
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка		Массив используемых областей доступа.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо в виде строки JSON, его представляющей.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.

Примечания

Примечание

для аутентификации можно задать service_account_file, используя переменную среды gcp_service_account_file.
для аутентификации можно задать service_account_contents, используя переменную среды 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: get info on a variable
  gcp_runtimeconfig_variable_info:
    config: my-config
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources сложная структура		всегда	Список ресурсов
	config строка	успех	Имя конфигурации runtime, к которой относится эта переменная.
	name строка	успех	Имя ресурса переменной.
	text строка	успех	Строковое значение переменной. Либо это, либо `value` могут быть установлены.
	value строка	успех	Двоичное значение переменной. Либо это, либо `text` могут быть установлены.

Авторы

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.10/collections/google/cloud/gcp_runtimeconfig_variable_info_module.html