Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_autoscaler_info — Сбор информации для GCP Autoscaler

Примечание

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

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

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

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

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

Обзор

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

Требования

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

  • 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 для использования.

scopes

список / элементы=строка

Массив используемых областей видимости

... ...

Примечания

Примечание

  • для аутентификации можно установить 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.

Метрика не может иметь отрицательных значений.

Метрика должна иметь тип значения INT64 или DOUBLE.

Возвращается: успех

utilizationTarget

string

Целевое значение метрики, которое должен поддерживать автомасштабировщик. Это должно быть положительное значение. Метрика использования масштабирует количество виртуальных машин, обрабатывающих запросы, чтобы увеличивать или уменьшать их пропорционально метрике.

Например, хорошей метрикой для использования в качестве utilizationTarget является www.googleapis.com/compute/instance/network/received_bytes_count.

Автомасштабировщик будет стремиться поддерживать это значение постоянным для каждого из экземпляров.

Возвращается: успех

utilizationTargetType

string

Определяет, как выражается целевое значение использования для метрики мониторинга Stackdriver.

Возвращается: успех

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

target

dictionary

URL управляемой группы экземпляров, к которой будет применяться этот автоматический масштабировщик.

Возвращаемое значение: success

zone

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API