gcp_compute_autoscaler_info – Сбор информации для автомасштабирования GCP
Новая в версии 2.9.
Обзор
- Сбор информации для автомасштабирования GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| 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_contents jsonarg | Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо в виде JSON-строки, его представляющей. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если выбран тип serviceaccount. | |
| zone строка / обязательно | URL зоны, где находится группа экземпляров. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить 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 целое число | успех | Количество секунд, которое автомасштабировщик должен ждать, прежде чем начать сбор информации с нового экземпляра. Это предотвращает сбор информации автомасштабировщиком во время инициализации экземпляра, когда собранные данные использования не будут надежными. По умолчанию автомасштабировщик ждет 60 секунд. Время инициализации виртуальных машин может варьироваться из-за множества факторов. Рекомендуется проверить, сколько времени может потребоваться для инициализации экземпляра. Для этого создайте экземпляр и измерьте процесс запуска. | |||
| cpuUtilization complex | успех | Определяет политику использования процессора, которая позволяет автомасштабировщику масштабировать на основе среднего использования процессора группой управляемых экземпляров. | |||
| utilizationTarget строка | успех | Целевое использование процессора, которое должен поддерживать автомасштабировщик. Должно быть число с плавающей точкой в диапазоне (0, 1]. Если не указано, значение по умолчанию равно 0,6. Если уровень использования процессора ниже целевого, автомасштабировщик уменьшает количество экземпляров до минимального значения, указанного вами, или до тех пор, пока среднее использование процессора ваших экземпляров не достигнет целевого значения. Если среднее использование процессора выше целевого, автомасштабировщик увеличивает количество экземпляров до максимального значения, указанного вами, или до тех пор, пока среднее использование не достигнет целевого значения. | |||
| customMetricUtilizations complex | успех | Определяет политику использования процессора, которая позволяет автомасштабировщику масштабировать на основе среднего использования процессора группой управляемых экземпляров. | |||
| metric строка | успех | Идентификатор (тип) метрики мониторинга Stackdriver. Метрика не может иметь отрицательных значений. Метрика должна иметь тип значения INT64 или DOUBLE. | |||
| utilizationTarget строка | успех | Целевое значение метрики, которое должен поддерживать автомасштабировщик. Оно должно быть положительным. Метрика использования масштабирует количество виртуальных машин, обрабатывающих запросы, пропорционально метрике. Например, хорошей метрикой для использования в качестве utilizationTarget является www.googleapis.com/compute/instance/network/received_bytes_count. Автомасштабировщик будет работать над поддержанием этого значения постоянным для каждого из экземпляров. | |||
| utilizationTargetType строка | успех | Определяет, как выражается целевое значение использования для метрики мониторинга Stackdriver. Либо GAUGE, либо DELTA_PER_SECOND, либо DELTA_PER_MINUTE. | |||
| loadBalancingUtilization complex | успех | Параметры конфигурации автомасштабирования на основе балансировщика нагрузки. | |||
| utilizationTarget строка | успех | Доля использования ресурсов бэкенда (установленная в конфигурации HTTP(s) балансировщика нагрузки), которую автомасштабировщик должен поддерживать. Должно быть положительным числом с плавающей точкой. Если не определено, значение по умолчанию равно 0,8. | |||
| maxNumReplicas целое число | успех | Максимальное количество экземпляров, до которого автомасштабировщик может масштабироваться. Это обязательно при создании или обновлении автомасштабировщика. Максимальное количество реплик не должно быть ниже минимального. | |||
| minNumReplicas целое число | успех | Минимальное количество реплик, до которого автомасштабировщик может масштабироваться вниз. Не может быть меньше 0. Если не указано, автомасштабировщик выберет значение по умолчанию в зависимости от максимального допустимого количества экземпляров. | |||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | |||
| description строка | успех | Необязательное описание этого ресурса. | |||
| id целое число | успех | Уникальный идентификатор ресурса. | |||
| name строка | успех | Имя ресурса. Длина имени должна составлять 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||
| target словарь | успех | URL управляемой группы экземпляров, которую будет масштабировать этот автомасштабировщик. | |||
| zone строка | успех | URL зоны, в которой расположена группа экземпляров. | |||
Состояние
- В данном модуле не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_autoscaler_info_module.html
