google.cloud.gcp_cloudfunctions_cloud_function_info – Сбор информации о GCP CloudFunction

Примечание

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

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

Для использования в playbook укажите: google.cloud.gcp_cloudfunctions_cloud_function_info.

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

Обзор

Сбор информации о GCP CloudFunction

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это влияет только на строку User Agent для запросов к API.
location строка / обязательно		Расположение этой функции облака.
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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a cloud function
  gcp_cloudfunctions_cloud_function_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources сложное			всегда	Список ресурсов
	availableMemoryMb целое число		успех	Количество доступной памяти в МБ для функции.
	description строка		успех	Описание функции, заданное пользователем.
	entryPoint строка		успех	Имя функции (определенное в исходном коде), которая будет выполнена. По умолчанию совпадает с суффиксом имени ресурса, если не указано иное. Для обратной совместимости, если функция с указанным именем не найдена, система попытается использовать функцию с именем «function». Для Node.js это имя функции, экспортированной модулем, указанным в source_location.
	environmentVariables словарь		успех	Переменные среды, доступные во время выполнения функции.
	eventTrigger сложное		успех	Источник типа HTTPS-точки входа, который можно активировать через URL.
		eventType строка	успех	Тип события для наблюдения. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`.
		resource строка	успех	Ресурс(ы) для наблюдения за событиями, например, `projects/_/buckets/myBucket.` .
		service строка	успех	Имя хоста службы, которая должна наблюдаться.
	httpsTrigger сложное		успех	Источник типа HTTPS-точки входа, который можно активировать через URL.
		url строка	успех	Развернутый URL функции.
	labels словарь		успех	Набор пар ключ/значение меток, связанных с этой функцией Cloud.
	location строка		успех	Расположение этой функции облака.
	name строка		успех	Определенное пользователем имя функции. Имена функций должны быть уникальными во всем мире и соответствовать шаблону `projects//locations//functions/*`.
	runtime строка		успех	Средство выполнения, в котором будет выполняться функция. Если пусто, по умолчанию используется Node.js 6.
	serviceAccountEmail строка		успех	Адрес электронной почты учетной записи службы для этой функции.
	sourceArchiveUrl строка		успех	URL Google Cloud Storage, начинающийся с gs://, указывающий на zip-архив, содержащий функцию.
	sourceRepository сложное		успех	Репозиторий исходного кода, где размещена функция.
		deployedUrl строка	успех	URL, указывающий на размещенный репозиторий, в котором функция была определена во время развертывания.
		url строка	успех	URL, указывающий на размещенный репозиторий, в котором определена функция.
	sourceUploadUrl строка		успех	Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода.
	status строка		успех	Статус развертывания функции.
	timeout строка		успех	Таймаут выполнения функции. Выполнение считается неудачным и может быть прервано, если функция не завершена в течение установленного таймаута. По умолчанию составляет 60 секунд.
	trigger_http логическое		успех	Использовать HTTP для активации этой функции.
	updateTime строка		успех	Последняя метка времени обновления функции Cloud.
	versionId строка		успех	Идентификатор версии функции Cloud. Каждая попытка развертывания приводит к созданию новой версии функции.

Авторы

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_cloudfunctions_cloud_function_info_module.html