google.cloud.gcp_container_node_pool_info – Сбор информации о пуле узлов GCP

Примечание

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

Для его установки используйте: ansible-galaxy collection install google.cloud.

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_container_node_pool_info.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Сбор информации о пуле узлов GCP

Требования

Ниже перечислены требования к хосту, на котором выполняется данный модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
cluster словарь / обязательно		Кластер, к которому относится этот пул узлов. Это поле представляет ссылку на ресурс Кластера в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_container_cluster и затем установить это поле cluster в "{{ name-of-resource }}"
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API.
location строка / обязательно		Расположение, где развернут пул узлов. псевдонимы: region, zone
project строка		Проект Google Cloud Platform, который нужно использовать.
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 node pool
  gcp_container_node_pool_info:
    cluster: "{{ cluster }}"
    location: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:

Ключ				Возвращаемое значение	Описание
resources complex				всегда	Список ресурсов
	autoscaling complex			успех	Настройка автомасштабирования для этого пула узлов. Автомасштабирование включено только в случае наличия корректной конфигурации.
		enabled boolean		успех	Включено ли автомасштабирование для этого пула узлов.
		maxNodeCount integer		успех	Максимальное количество узлов в пуле узлов. Должно быть больше или равно minNodeCount. Для увеличения кластера должно быть достаточно квот.
		minNodeCount integer		успех	Минимальное количество узлов в пуле узлов. Должно быть больше или равно 1 и меньше или равно maxNodeCount.
	cluster dictionary			успех	Кластер, к которому принадлежит этот пул узлов.
	conditions complex			успех	Условиям, которые привели к текущему состоянию пула узлов.
		code string		успех	Представление условия в удобном для машин формате.
	config complex			успех	Конфигурация узлов пула.
		accelerators complex		успех	Список аппаратных ускорителей, которые будут подключены к каждому узлу.
			acceleratorCount integer	успех	Количество карт ускорителей, доступных экземпляру.
			acceleratorType string	успех	Имя ресурса типа ускорителя.
		diskSizeGb integer		успех	Размер диска, подключенного к каждому узлу, в ГБ. Минимальный разрешённый размер диска — 10 ГБ. Если не указано, используется значение по умолчанию — 100 ГБ.
		diskType string		успех	Тип диска, подключенного к каждому узлу (например, 'pd-standard' или 'pd-ssd'). Если не указано, используется тип диска по умолчанию — 'pd-standard'.
		imageType string		успех	Тип образа, который будет использоваться для этого узла. Обратите внимание, что для данного типа образа будет использоваться последняя версия.
		labels dictionary		успех	Отображение меток Kubernetes (пар ключ/значение), которые будут применены к каждому узлу. Они будут добавлены помимо любых стандартных меток, которые Kubernetes может применить к узлу. В случае конфликта ключей меток применённый набор может отличаться в зависимости от версии Kubernetes — лучше считать поведение неопределённым, и конфликты следует избегать. Более подробная информация, включая использование и допустимые значения, доступна по адресу: http://kubernetes.io/v1.1/docs/user-guide/labels.html. Объект, содержащий список пар "ключ": значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }
		localSsdCount integer		успех	Количество локальных SSD-дисков, которые будут подключены к узлу. Предел для этого значения зависит от максимального количества дисков, доступных на машине в зоне. Подробнее см.: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits.
		machineType string		успех	Название типа виртуальной машины Google Compute Engine (например, n1-стандартный-1). Если не указано, используется тип виртуальной машины по умолчанию n1-стандартный-1.
		metadata dictionary		успех	Ключи/значения метаданных, назначенные экземплярам в кластере. Ключи должны соответствовать регулярному выражению [a-zA-Z0-9-_]+ и иметь длину менее 128 байт. Они отображаются как часть URL-адреса в сервере метаданных. Кроме того, чтобы избежать неоднозначности, ключи не должны конфликтовать с другими ключами метаданных для проекта или быть одним из четырёх зарезервированных ключей: «instance-template», «kube-env», «startup-script» и «user-data». Значения — свободные строки, и их смысл интерпретируется выполняемой в экземпляре системой. Единственное ограничение — размер каждого значения не должен превышать 32 КБ. Общий размер всех ключей и значений должен быть меньше 512 КБ. Объект, содержащий список пар «ключ»: значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }
		minCpuPlatform string		успех	Минимальная платформа процессора, используемая этим экземпляром. Экземпляр может быть запланирован на указанную или более новую платформу процессора.
		oauthScopes list / elements=string		успех	Набор облачных API-скопов Google, доступных для всех виртуальных машин узлов в рамках учётной записи "default". Рекомендуются следующие скоупы, но они не обязательны, и по умолчанию не включаются:https://www.googleapis.com/auth/compute требуется для подключения постоянного хранилища к узлам. https://www.googleapis.com/auth/devstorage.read_only требуется для взаимодействия с gcr.io (Google Container Registry). Если не указано, скоупы не добавляются, если не включены Cloud Logging или Cloud Monitoring, в этом случае будут добавлены необходимые скоупы.
		preemptible boolean		успех	Создаются ли узлы как экземпляры предварительно резервируемых виртуальных машин. Подробнее см. https://cloud.google.com/compute/docs/instances/preemptible.
		serviceAccount string		успех	Учётная запись сервиса Google Cloud Platform, которая будет использоваться виртуальными машинами узлов. Если учётная запись сервиса не указана, используется учётная запись "default".
		shieldedInstanceConfig complex		успех	Параметры защищённого экземпляра.
			enableIntegrityMonitoring boolean	успех	Определяет, включена ли проверка целостности экземпляра. Включает мониторинг и подтверждение целостности загрузки экземпляра. Подтверждение выполняется по отношению к эталонному образцу целостности. Этот эталонный образец изначально выводится из предполагаемого надёжного образа загрузки при создании экземпляра.
			enableSecureBoot boolean	успех	Определяет, включён ли Secure Boot для экземпляра. Secure Boot помогает убедиться, что система запускает только аутентифицированное ПО, проверяя цифровую подпись всех компонентов загрузки и останавливая процесс загрузки, если проверка подписи завершается неудачей.
		tags list / elements=string		успех	Список меток экземпляров, применённых ко всем узлам. Метки используются для идентификации допустимых источников или целей для сетевых брандмауэров и задаются клиентом при создании кластера или пула узлов. Каждая метка в списке должна соответствовать RFC1035.
		taints complex		успех	Список меток Kubernetes, которые нужно применить к каждому узлу.
			effect string	успех	Эффект для метки.
			key string	успех	Ключ для метки.
			value string	успех	Значение для метки.

	workloadMetaConfig complex		success	WorkloadMetadataConfig определяет конфигурацию метаданных, которые нужно предоставить рабочим нагрузкам в пуле узлов.
		mode string	success	Режим — это конфигурация того, как предоставить метаданные рабочим нагрузкам, выполняющимся в пуле узлов.
initialNodeCount integer			success	Начальное количество узлов для пула. Вы должны убедиться, что ваши квоты ресурсов Compute Engine достаточны для этого количества экземпляров. Также вам нужны доступные квоты на брандмауэры и маршруты.
location string			success	Расположение, где развернут пул узлов.
management complex			success	Конфигурация управления для этого пула узлов.
	autoRepair boolean		success	Флаг, указывающий, включено ли автоматическое исправление узлов для пула узлов. Если включено, узлы в этом пуле будут отслеживаться, и если они слишком много раз не пройдут проверки работоспособности, будет выполнено автоматическое действие по ремонту.
	autoUpgrade boolean		success	Флаг, указывающий, включено ли автоматическое обновление узлов для пула узлов. Если включено, автоматическое обновление узлов поможет поддерживать узлы в вашем пуле узлов в актуальном состоянии с последней релизной версией Kubernetes.
	upgradeOptions complex		success	Указывает параметры автоматического обновления для пула узлов.
		autoUpgradeStartTime string	success	Это поле устанавливается, когда обновления вот-вот начнутся, с приблизительным начальным временем обновлений в формате RFC3339.
		description string	success	Это поле устанавливается, когда обновления вот-вот начнутся, с описанием обновления.
maxPodsConstraint complex			success	Ограничение максимального числа поддонов, которые могут выполняться одновременно на узле в пуле узлов.
	maxPodsPerNode integer		success	Ограничение, накладываемое на максимальное количество поддонов на узел.
name string			success	Имя пула узлов.
podIpv4CidrSize integer			success	Размер блока CIDR поддонов на узел в этом пуле узлов.
status string			success	Статус узлов в этом экземпляре пула.
statusMessage string			success	Дополнительная информация о текущем статусе этого экземпляра пула узлов.
version string			success	Версия Kubernetes этого узла.

Авторы

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_container_node_pool_info_module.html