Модуль google.cloud.gcp_compute_region_autoscaler_info – Сбор информации для GCP RegionAutoscaler

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

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

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

Обзор

Сбор информации для GCP RegionAutoscaler

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
filters список / элементы=строка	Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка	Проект Google Cloud Platform для использования.
region строка / обязательно	URL региона, в котором находится группа экземпляров.
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.
для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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	Определяет параметры управления уменьшением масштаба, чтобы снизить риск задержки отклика и сбоев из-за внезапных событий уменьшения масштаба. Возвращаемое значение: success
maxScaledInReplicas complex	Вложенный ресурс. Возвращаемое значение: success
fixed integer	Устанавливает фиксированное количество виртуальных машин. Должно быть положительным целым числом. Возвращаемое значение: success
percent integer	Устанавливает процент виртуальных машин от 0 до 100%, включительно. Например, укажите 80 для 80%. Возвращаемое значение: success
timeWindowSec integer	Время, за которое автомасштабирование должно анализировать рекомендации, чтобы включить директивы по более медленному уменьшению масштаба, как описано выше. Возвращаемое значение: success
creationTimestamp string	Дата и время создания в формате RFC3339. Возвращаемое значение: success
description string	Необязательное описание этого ресурса. Возвращаемое значение: success
id integer	Уникальный идентификатор ресурса. Возвращаемое значение: success
name string	Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращаемое значение:* success
region string	URL региона, в котором находится группа экземпляров. Возвращаемое значение: success
target string	URL управляемой группы экземпляров, которую будет масштабировать этот автомасштабировщик. Возвращаемое значение: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекции

© 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_compute_region_autoscaler_info_module.html