google.cloud.gcp_compute_autoscaler_info – Сбор информации для автомасштабирования GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 с помощью переменной среды
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 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 | успешно | Определяет политику использования процессора, которая позволяет автомасштабировщику масштабироваться на основе среднего использования процессора группой управляемых экземпляров. | ||||
| 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 зоны, в которой находится группа экземпляров. | ||||
Авторы
- 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_autoscaler_info_module.html
