Модуль google.cloud.gcp_container_node_pool_info — сбор сведений о NodePool GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_container_node_pool_info.
Краткое описание
- Сбор сведений о NodePool GCP
Требования
Следующие требования необходимы на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если выбран тип учётных данных accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
cluster dictionary / обязательный | Кластер, к которому относится этот пул узлов. Это поле представляет ссылку на ресурс Cluster в GCP. Его можно задать двумя способами. Во-первых, можно указать словарь с ключом ‘name’ и значением, равным имени ресурса. Кроме того, можно добавить `register: name-of-resource` в задачу gcp_container_cluster, а затем присвоить полю cluster значение “{{ name-of-resource }}” |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это изменяет только строку User Agent для запросов к API. |
location псевдонимы: region, zone string / обязательный | Расположение, в котором развёрнут пул узлов. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учётной записи службы: словарь или JSON-строка, представляющая его. |
service_account_email string | Необязательный адрес электронной почты учётной записи службы. Указывается, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной окружения
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной окружения
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной окружения
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной окружения
GCP_ACCESS_TOKEN. - Для аутентификации можно задать 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 |
Конфигурация автомасштабирования для этого NodePool. Автомасштабирование включено только при наличии допустимой конфигурации. Возвращается: при успешном выполнении |
|
enabled boolean |
Включено ли автомасштабирование для этого пула узлов. Возвращается: при успешном выполнении |
|
maxNodeCount integer |
Максимальное количество узлов в NodePool. Должно быть >= minNodeCount. Для увеличения кластера должна быть доступна достаточная квота. Возвращается: при успешном выполнении |
|
minNodeCount integer |
Минимальное количество узлов в NodePool. Должно быть >= 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”: “wrench”, “mass”: “1.3kg”, “count”: “3” }. Возвращается: при успешном выполнении |
|
localSsdCount integer |
Количество локальных SSD-дисков, подключаемых к узлу. Ограничение для этого значения зависит от максимального количества дисков, доступных на машине в конкретной зоне. Дополнительные сведения см. здесь: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits. Возвращается: при успешном выполнении |
|
machineType string |
Имя типа машины Google Compute Engine (например, n1-standard-1). Если значение не указано, по умолчанию используется тип машины n1-standard-1. Возвращается: при успешном выполнении |
|
metadata dictionary |
Пары ключ/значение метаданных, назначенные экземплярам в кластере. Ключи должны соответствовать регулярному выражению [a-zA-Z0-9-_]+ и иметь длину менее 128 байт. Они отображаются как часть URL на сервере метаданных. Кроме того, во избежание неоднозначности ключи не должны конфликтовать с другими ключами метаданных проекта или совпадать с одним из четырёх зарезервированных ключей: “instance-template”, “kube-env”, “startup-script” и “user-data”. Значения могут быть произвольными строками; их смысл определяется образом, запущенным в экземпляре. Единственное ограничение: размер каждого значения не должен превышать 32 КБ. Общий размер всех ключей и значений должен быть менее 512 КБ. Объект, содержащий список пар «ключ»: значение. Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }. Возвращается: при успешном выполнении |
|
minCpuPlatform string |
Минимальная платформа ЦП, используемая этим экземпляром. Экземпляр может быть запланирован на указанной или более новой платформе ЦП. Возвращается: при успешном выполнении |
|
oauthScopes list / elements=string |
Набор областей действия API Google, доступных всем виртуальным машинам узлов от имени учётной записи службы “default”. Рекомендуется использовать следующие области действия, хотя это и не обязательно; по умолчанию они не включены: для подключения постоянного хранилища к узлам требуется https://www.googleapis.com/auth/compute. Для обмена данными с gcr.io (Google Container Registry) требуется https://www.googleapis.com/auth/devstorage.read_only. Если значение не указано, области действия не добавляются, если только не включены Cloud Logging или Cloud Monitoring; в этом случае будут добавлены необходимые для них области действия. Возвращается: при успешном выполнении |
|
preemptible boolean |
Создаются ли узлы как прерываемые экземпляры виртуальных машин. Дополнительные сведения о прерываемых экземплярах ВМ см. здесь: https://cloud.google.com/compute/docs/instances/preemptible. Возвращается: при успешном выполнении |
|
serviceAccount string |
Учётная запись службы Google Cloud Platform, используемая виртуальными машинами узлов. Если учётная запись службы не указана, используется учётная запись “default”. Возвращается: при успешном выполнении |
|
shieldedInstanceConfig complex |
Параметры Shielded Instance. Возвращается: при успешном выполнении |
|
enableIntegrityMonitoring boolean |
Указывает, включён ли для экземпляра мониторинг целостности. Включает мониторинг и аттестацию целостности загрузки экземпляра. Аттестация выполняется относительно базового уровня политики целостности. Изначально этот базовый уровень определяется на основе неявно доверенного загрузочного образа при создании экземпляра. Возвращается: при успешном выполнении |
|
enableSecureBoot boolean |
Указывает, включена ли для экземпляра функция Secure Boot. Secure Boot помогает обеспечить запуск только подлинного программного обеспечения: функция проверяет цифровую подпись всех компонентов загрузки и останавливает процесс загрузки при неудачной проверке подписи. Возвращается: при успешном выполнении |
|
tags list / elements=string |
Список тегов экземпляров, применяемых ко всем узлам. Теги используются для определения допустимых источников или целей сетевых брандмауэров; они задаются клиентом при создании кластера или пула узлов. Каждый тег в списке должен соответствовать RFC1035. Возвращается: при успешном выполнении |
|
taints complex |
Список меток taint Kubernetes, применяемых к каждому узлу. Возвращается: при успешном выполнении |
|
effect string |
Эффект метки taint. Возвращается: при успешном выполнении |
|
key string |
Ключ метки taint. Возвращается: при успешном выполнении |
|
value string |
Значение метки taint. Возвращается: при успешном выполнении |
|
workloadMetaConfig complex |
WorkloadMetadataConfig определяет конфигурацию метаданных, предоставляемых рабочим нагрузкам в пуле узлов. Возвращается: при успешном выполнении |
|
mode string |
Режим определяет конфигурацию предоставления метаданных рабочим нагрузкам, выполняющимся в пуле узлов. Возвращается: при успешном выполнении |
|
initialNodeCount integer |
Начальное количество узлов в пуле. Убедитесь, что квоты ресурсов Compute Engine достаточно для указанного количества экземпляров. Также должны быть доступны квоты брандмауэра и маршрутов. Возвращается: при успешном выполнении |
|
location string |
Расположение, в котором развёрнут пул узлов. Возвращается: при успешном выполнении |
|
management complex |
Конфигурация управления этим NodePool. Возвращается: при успешном выполнении |
|
autoRepair boolean |
Флаг, указывающий, включено ли автоматическое восстановление узлов для этого пула. Если функция включена, узлы в пуле будут отслеживаться; если они слишком много раз не пройдут проверки работоспособности, будет запущено автоматическое восстановление. Возвращается: при успешном выполнении |
|
autoUpgrade boolean |
Флаг, указывающий, включено ли автоматическое обновление узлов для этого пула. Если функция включена, автоматическое обновление узлов помогает поддерживать их в актуальном состоянии, устанавливая последнюю версию Kubernetes. Возвращается: при успешном выполнении |
|
upgradeOptions complex |
Задаёт параметры автоматического обновления пула узлов. Возвращается: при успешном выполнении |
|
autoUpgradeStartTime string |
Это поле заполняется перед началом обновления и содержит приблизительное время его начала в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description string |
Это поле заполняется перед началом обновления и содержит его описание. Возвращается: при успешном выполнении |
|
maxPodsConstraint complex |
Ограничение на максимальное количество подов, которые могут одновременно выполняться на узле в пуле узлов. Возвращается: при успешном выполнении |
|
maxPodsPerNode integer |
Ограничение на максимальное количество подов на узел. Возвращается: при успешном выполнении |
|
name string |
Имя пула узлов. Возвращается: при успешном выполнении |
|
podIpv4CidrSize integer |
Размер блока CIDR для подов на узел в этом пуле узлов. Возвращается: при успешном выполнении |
|
status string |
Состояние узлов в этом экземпляре пула. Возвращается: при успешном выполнении |
|
statusMessage string |
Дополнительная информация о текущем состоянии этого экземпляра пула узлов. Возвращается: при успешном выполнении |
|
version string |
Версия Kubernetes на этом узле. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_container_node_pool_info_module.html