Модуль google.cloud.gcp_cloudfunctions_cloud_function_info – Сбор информации о GCP CloudFunction
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: google.cloud.gcp_cloudfunctions_cloud_function_info.
Обзор
- Сбор информации о GCP CloudFunction
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации – accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это влияет только на строку User-Agent для запросов к API. |
location строка / обязательно | Расположение этой функции облака. |
project строка | Используемый проект Google Cloud Platform. |
scopes список / элементы=строка | Массив используемых областей |
| ... (rest of the table) ... |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить access_token, используя переменную среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения книги задач не заданы.
- параметры 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 complex | Список ресурсов Возвращается: всегда |
|
availableMemoryMb integer |
Объём памяти в МБ, доступный для функции. Возвращается: успех |
|
description string |
Описание функции, предоставленное пользователем. Возвращается: успех |
|
entryPoint string |
Имя функции (как определено в исходном коде), которая будет выполнена. По умолчанию используется суффикс имени ресурса, если не указано иное. Для обратной совместимости, если функция с заданным именем не найдена, система попытается использовать функцию с именем «function». Для Node.js это имя функции, экспортируемой модулем, указанным в source_location. Возвращается: успех |
|
environmentVariables dictionary |
Переменные среды, которые должны быть доступны во время выполнения функции. Возвращается: успех |
|
eventTrigger complex |
Источник типа HTTPS-конечной точки, который может быть вызван через URL. Возвращается: успех |
|
eventType string |
Тип события для наблюдения. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`. Возвращается: успех |
|
resource string |
Ресурс(ы), за событиями которых нужно наблюдать, например, `projects/_/buckets/myBucket.`. Возвращается: успех |
|
service string |
Имя хоста службы, за которой следует наблюдать. Возвращается: успех |
|
httpsTrigger complex |
Источник типа HTTPS-конечной точки, который может быть вызван через URL. Возвращается: успех |
|
url string |
Развёрнутый URL для функции. Возвращается: успех |
|
labels dictionary |
Набор пар «ключ/значение» меток, связанных с этой функцией Cloud. Возвращается: успех |
|
location string |
Расположение этой функции облака. Возвращается: успех |
|
name string |
Заданное пользователем имя функции. Имена функций должны быть уникальными глобально и соответствовать шаблону `projects/*/locations/*/functions/*`. Возвращается: успех |
|
runtime string |
Среда выполнения, в которой будет выполняться функция. Если пусто, по умолчанию используется Node.js 6. Возвращается: успех |
|
serviceAccountEmail string |
Электронная почта учётной записи службы для этой функции. Возвращается: успех |
|
sourceArchiveUrl string |
URL-адрес Google Cloud Storage, начинающийся с gs://, указывающий на ZIP-архив, содержащий функцию. Возвращается: успех |
|
sourceRepository complex |
Репозиторий исходного кода, где размещена функция. Возвращается: успех |
|
deployedUrl string |
URL-адрес, указывающий на размещённый репозиторий, где функция была определена во время развертывания. Возвращается: успех |
|
url string |
URL, указывающий на размещённый репозиторий, где определена функция. Возвращаемое значение: success |
|
sourceUploadUrl string |
Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода. Возвращаемое значение: success |
|
status string |
Статус развертывания функции. Возвращаемое значение: success |
|
timeout string |
Таймаут выполнения функции. Выполнение считается неудачным и может быть прервано, если функция не завершится в течение установленного таймаута. По умолчанию составляет 60 секунд. Возвращаемое значение: success |
|
trigger_http boolean |
Использовать HTTP для запуска этой функции. Возвращаемое значение: success |
|
updateTime string |
Последняя отметка времени обновления функции Cloud Function. Возвращаемое значение: success |
|
versionId string |
Идентификатор версии функции Cloud Function. Каждая попытка развертывания приводит к созданию новой версии функции. Возвращаемое значение: success |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_cloudfunctions_cloud_function_info_module.html
