Модуль google.cloud.gcp_compute_autoscaler_info — сбор информации об автомасштабировщике GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте команду: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_autoscaler_info.
Краткое описание
- Сбор информации об автомасштабировщике GCP
Требования
Следующие требования должны быть соблюдены на хосте, выполняющем этот модуль.
- 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 / elements=string | Список пар «фильтр — значение». Список доступных фильтров приведен здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / elements=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы. Используется, если выбрано значение machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
zone string / обязательный | URL зоны, в которой находится группа экземпляров. |
Примечания
Примечание
- Для аутентификации можно задать 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 an autoscaler
gcp_compute_autoscaler_info:
zone: us-central1-a
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])?`, то есть первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
target dictionary |
URL управляемой группы экземпляров, масштаб которой будет изменять этот автомасштабировщик. Возвращается: при успешном выполнении |
|
zone 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_autoscaler_info_module.html