google.cloud.gcp_compute_autoscaler_info – Сбор информации для GCP Autoscaler

Примечание

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

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 для использования.
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. Метрика не может иметь отрицательные значения. Тип метрики должен быть 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		успешно	Определяет режим работы этой политики.
	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–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_autoscaler_info_module.html