Модуль google.cloud.gcp_compute_region_autoscaler_info — сбор сведений о GCP RegionAutoscaler
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_region_autoscaler_info.
Обзор
- Сбор сведений о GCP RegionAutoscaler
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учётных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
region string / обязательный | URL региона, в котором находится группа экземпляров. |
scopes list / элементы=string | Массив областей действия, которые следует использовать |
service_account_contents jsonarg | Содержимое JSON-файла сервисного аккаунта — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать 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 region autoscaler
gcp_compute_region_autoscaler_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
autoscalingPolicy complex |
Параметры конфигурации алгоритма автомасштабирования. Для автомасштабировщика можно определить одну или несколько политик: cpuUtilization, customMetricUtilizations и loadBalancingUtilization. Если ни одна из них не указана, по умолчанию автомасштабирование выполняется на основе cpuUtilization со значением 0.6, или 60%. Возвращается: при успешном выполнении |
|
coolDownPeriodSec integer |
Количество секунд, которое автомасштабировщик должен выждать перед началом сбора данных с нового экземпляра. Это предотвращает сбор данных во время инициализации экземпляра, когда собранные сведения об использовании ресурсов ненадёжны. По умолчанию автомасштабировщик ожидает 60 секунд. Время инициализации виртуальной машины может различаться по многим причинам. Рекомендуем проверить, сколько времени требуется экземпляру для инициализации. Для этого создайте экземпляр и замерьте время запуска. Возвращается: при успешном выполнении |
|
cpuUtilization complex |
Определяет политику использования ЦП, которая позволяет автомасштабировщику масштабировать группу управляемых экземпляров на основе среднего использования ЦП. Возвращается: при успешном выполнении |
|
predictiveMethod string |
Указывает, включено ли прогнозное автомасштабирование на основе метрики ЦП. Допустимые значения: - NONE (по умолчанию). Прогнозный метод не используется. Автомасштабировщик масштабирует группу в соответствии с текущей нагрузкой на основе метрик в реальном времени. - OPTIMIZE_AVAILABILITY. Прогнозное автомасштабирование повышает доступность: отслеживает ежедневные и еженедельные шаблоны нагрузки и заранее масштабирует группу при ожидаемом росте спроса. Возвращается: при успешном выполнении |
|
utilizationTarget string |
Целевое использование ЦП, которое должен поддерживать автомасштабировщик. Должно быть числом с плавающей точкой в диапазоне (0, 1]. Если значение не указано, по умолчанию используется 0.6. Если загрузка ЦП ниже целевого значения, автомасштабировщик уменьшает количество экземпляров, пока оно не достигнет указанного минимального значения или средняя загрузка ЦП экземпляров не достигнет целевого значения. Если средняя загрузка ЦП выше целевого значения, автомасштабировщик увеличивает количество экземпляров, пока оно не достигнет указанного максимального значения или средняя загрузка не достигнет целевого значения. Возвращается: при успешном выполнении |
|
customMetricUtilizations complex |
Параметры конфигурации автомасштабирования на основе пользовательской метрики. Возвращается: при успешном выполнении |
|
metric string |
Идентификатор (тип) метрики Stackdriver Monitoring. Значение метрики не может быть отрицательным. Тип значения метрики должен быть INT64 или DOUBLE. Возвращается: при успешном выполнении |
|
utilizationTarget string |
Целевое значение метрики, которое должен поддерживать автомасштабировщик. Оно должно быть положительным. Метрика использования масштабирует количество виртуальных машин, обрабатывающих запросы, пропорционально увеличивая или уменьшая его в зависимости от значения метрики. Например, в качестве utilizationTarget можно использовать метрику www.googleapis.com/compute/instance/network/received_bytes_count. Автомасштабировщик будет поддерживать постоянное значение этой метрики для каждого экземпляра. Возвращается: при успешном выполнении |
|
utilizationTargetType string |
Определяет способ представления целевого значения использования для метрики Stackdriver Monitoring. Возвращается: при успешном выполнении |
|
loadBalancingUtilization complex |
Параметры конфигурации автомасштабирования на основе балансировщика нагрузки. Возвращается: при успешном выполнении |
|
utilizationTarget string |
Доля использования пропускной способности бэкенда (задаётся в конфигурации балансировки нагрузки HTTP(S)), которую должен поддерживать автомасштабировщик. Должно быть положительным числом с плавающей точкой. Если значение не задано, по умолчанию используется 0.8. Возвращается: при успешном выполнении |
|
maxNumReplicas integer |
Максимальное количество экземпляров, до которого автомасштабировщик может увеличить их число. Этот параметр необходимо задать при создании или обновлении автомасштабировщика. Максимальное количество реплик не должно быть меньше минимального. Возвращается: при успешном выполнении |
|
minNumReplicas integer |
Минимальное количество реплик, до которого автомасштабировщик может уменьшить их число. Значение не может быть меньше 0. Если оно не указано, автомасштабировщик выберет значение по умолчанию в зависимости от максимально допустимого количества экземпляров. Возвращается: при успешном выполнении |
|
mode string |
Определяет режим работы этой политики. Возвращается: при успешном выполнении |
|
scaleInControl complex |
Определяет параметры уменьшения масштаба, снижающие риск задержек ответа и сбоев из-за резкого уменьшения масштаба. Возвращается: при успешном выполнении |
|
maxScaledInReplicas complex |
Вложенный объект ресурса. Возвращается: при успешном выполнении |
|
fixed integer |
Задаёт фиксированное количество экземпляров ВМ. Значение должно быть положительным целым числом. Возвращается: при успешном выполнении |
|
percent integer |
Задаёт процент экземпляров в диапазоне от 0 до 100% включительно. Например, укажите 80 для значения 80%. Возвращается: при успешном выполнении |
|
timeWindowSec integer |
Период времени в прошлом, который автомасштабировщик учитывает при расчёте рекомендаций, включая приведённые выше указания по более медленному уменьшению масштаба. Возвращается: при успешном выполнении |
|
creationTimestamp string |
Время создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успешном выполнении |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса. Имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной латинской буквой, а все последующие символы — дефисом, строчной латинской буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
region string |
URL региона, в котором находится группа экземпляров. Возвращается: при успешном выполнении |
|
target string |
URL группы управляемых экземпляров, масштабирование которой будет выполнять этот автомасштабировщик. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_region_autoscaler_info_module.html