google.cloud.gcp_compute_region_autoscaler_info – Сбор информации для GCP RegionAutoscaler
Примечание
Этот плагин является частью коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательный |
| Тип используемых учетных данных. |
| 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. - для аутентификации можно установить 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 | успешно | Определяет политику использования ЦП, которая позволяет автомасштабировщику масштабироваться на основе среднего использования ЦП группы управляемых экземпляров. | ||||
| 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 | успешно | Определяет управление масштабированием вниз, чтобы уменьшить риск задержек ответа и сбоев из-за внезапных событий масштабирования вниз. | ||||
| 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 управляемой группы экземпляров, которую будет масштабировать этот автомасштабировщик. | ||||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_region_autoscaler_info_module.html
