google.cloud.gcp_compute_region_autoscaler_info – Сбор информации о GCP RegionAutoscaler

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: 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 строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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 целое число		успех	Количество секунд, которое автомасштабировщик должен ждать, прежде чем начать сбор информации с нового экземпляра. Это предотвращает сбор информации автомасштабировщиком во время инициализации экземпляра, когда собранные данные использования могут быть ненадежными. По умолчанию автомасштабировщик ждет 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.
		loadBalancingUtilization complex		успех	Параметры конфигурации автомасштабирования на основе балансировщика нагрузки.
			utilizationTarget строка	успех	Доля использования ресурсов бэкенда (установленная в конфигурации HTTP(s) балансировщика нагрузки), которую автомасштабировщик должен поддерживать. Должно быть положительным числом с плавающей точкой. Если не определено, значение по умолчанию — 0,8.
		maxNumReplicas целое число		успех	Максимальное количество экземпляров, до которого автомасштабировщик может масштабироваться. Это требуется при создании или обновлении автомасштабировщика. Максимальное количество реплик не должно быть меньше минимального количества реплик.
		minNumReplicas целое число		успех	Минимальное количество реплик, до которого автомасштабировщик может уменьшить масштаб. Не может быть меньше 0. Если не указано, автомасштабировщик выберет значение по умолчанию, в зависимости от максимального разрешенного количества экземпляров.
		mode строка		успех	Определяет режим работы данной политики.
	creationTimestamp строка			успех	Дата и время создания в формате RFC3339.
	description строка			успех	Необязательное описание этого ресурса.
	id целое число			успех	Уникальный идентификатор ресурса.
	name строка			успех	Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
	region строка			успех	URL региона, в котором находится группа экземпляров.
	target строка			успех	URL управляемой группы экземпляров, которую будет масштабировать этот автомасштабировщик.

Авторы

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.10/collections/google/cloud/gcp_compute_region_autoscaler_info_module.html