Модуль google.cloud.gcp_container_node_pool_info – Сбор информации для GCP NodePool
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: google.cloud.gcp_container_node_pool_info.
Краткое описание
- Сбор информации для GCP NodePool
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
cluster словарь / обязательно | Кластер, к которому принадлежит этот пул узлов. Это поле представляет собой ссылку на ресурс кластера в GCP. Его можно указать двумя способами. Во-первых, вы можете разместить словарь с ключом «name» и значением имени вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` к задаче gcp_container_cluster, а затем установить это поле кластера в «{{ name-of-resource }}» |
env_type строка | Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API. |
location псевдонимы: region, zone строка / обязательно | Местоположение, где развернут пул узлов. |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив областей, которые будут использоваться |
service_account_contents jsonarg | Содержание файла Service Account JSON, либо в словаре, либо в виде JSON-строки, которая его представляет. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file путь | Путь к файлу Service Account 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. - Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
- Параметры 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 сложный | Список ресурсов Возвращается: всегда |
|
autoscaling сложный |
Настройка автомасштабирования для данного NodePool. Автомасштабирование включено только при наличии действительной конфигурации. Возвращается: успех |
|
enabled логический |
Включено ли автомасштабирование для данного пула узлов. Возвращается: успех |
|
maxNodeCount целое число |
Максимальное количество узлов в NodePool. Должно быть >= minNodeCount. Должно быть достаточно квоты для масштабирования кластера. Возвращается: успех |
|
minNodeCount целое число |
Минимальное количество узлов в NodePool. Должно быть >= 1 и <= maxNodeCount. Возвращается: успех |
|
cluster словарь |
Кластер, к которому принадлежит этот пул узлов. Возвращается: успех |
|
conditions сложный |
Условия, которые привели к текущему состоянию пула узлов. Возвращается: успех |
|
code строка |
Представление условия в удобном для машинного чтения формате. Возвращается: успех |
|
config сложный |
Конфигурация узлов пула. Возвращается: успех |
|
accelerators сложный |
Список аппаратных ускорителей, подключаемых к каждому узлу. Возвращается: успех |
|
acceleratorCount целое число |
Количество плат ускорителей, подключенных к экземпляру. Возвращается: успех |
|
acceleratorType строка |
Имя ресурса типа ускорителя. Возвращается: успех |
|
diskSizeGb целое число |
Размер диска, подключаемого к каждому узлу, в ГБ. Минимальный разрешенный размер диска — 10 ГБ. Если не указано, используется значение по умолчанию — 100 ГБ. Возвращается: успех |
|
diskType строка |
Тип диска, подключаемого к каждому узлу (например, ‘pd-standard’ или ‘pd-ssd’). Если не указано, используется значение по умолчанию — ‘pd-standard’. Возвращается: успех |
|
imageType строка |
Тип образа, используемого для данного узла. Обратите внимание, что для данного типа образа будет использоваться последняя версия. Возвращается: успех |
|
labels словарь |
Карта меток Kubernetes (пар ключ/значение), применяемых к каждому узлу. Они будут добавлены дополнительно к любым стандартным меткам, которые Kubernetes может применить к узлу. В случае конфликта ключей меток применяемый набор может отличаться в зависимости от версии Kubernetes — лучше всего предположить, что поведение не определено, и конфликты следует избегать. Более подробную информацию, включая использование и допустимые значения, см.: http://kubernetes.io/v1.1/docs/user-guide/labels.html Объект, содержащий список пар «ключ»: значение. Пример: { «имя»: «ключ», «масса»: «1.3кг», «количество»: «3» }. Возвращается: успех |
|
localSsdCount целое число |
Количество локальных SSD-дисков, подключаемых к узлу. Предел для этого значения зависит от максимального количества дисков, доступных на машине в данной зоне. Подробнее см.: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits. Возвращается: успех |
|
machineType строка |
Имя типа машины 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” }. Возвращается: success |
|
minCpuPlatform string |
Минимальная платформа ЦП, которая будет использоваться этим экземпляром. Экземпляр может быть запланирован на указанной или более новой платформе ЦП. Возвращается: success |
|
oauthScopes list / elements=string |
Набор областей API Google, которые будут доступны на всех виртуальных машинах узлов под учетной записью службы «default». Рекомендуются, но не требуются следующие области, и по умолчанию они не включены: https://www.googleapis.com/auth/compute требуется для монтирования постоянного хранилища на ваших узлах. https://www.googleapis.com/auth/devstorage.read_only требуется для связи с gcr.io (реестром контейнеров Google). Если не указано, области не добавляются, если только не включены Cloud Logging или Cloud Monitoring, в этом случае будут добавлены их необходимые области. Возвращается: success |
|
preemptible boolean |
Указывает, создаются ли узлы как прерываемые экземпляры виртуальных машин. Дополнительные сведения о прерываемых экземплярах виртуальных машин см. в разделе: https://cloud.google.com/compute/docs/instances/preemptible. Возвращается: success |
|
serviceAccount string |
Учетная запись службы Google Cloud Platform, которая будет использоваться виртуальными машинами узлов. Если учетная запись службы не указана, используется учетная запись службы «default». Возвращается: success |
|
shieldedInstanceConfig complex |
Параметры защищенного экземпляра. Возвращается: success |
|
enableIntegrityMonitoring boolean |
Определяет, включен ли для экземпляра контроль целостности. Включает мониторинг и подтверждение целостности загрузки экземпляра. Подтверждение выполняется на основе базовой линии политики целостности. Эта базовая линия изначально выводится из неявно заслуживающего доверия загрузочного образа при создании экземпляра. Возвращается: success |
|
enableSecureBoot boolean |
Определяет, включена ли для экземпляра безопасная загрузка. Безопасная загрузка помогает гарантировать, что система запускает только проверенное программное обеспечение, проверяя цифровую подпись всех компонентов загрузки и прекращая процесс загрузки, если проверка подписи завершается неудачей. Возвращается: success |
|
tags list / elements=string |
Список тегов экземпляров, применяемых ко всем узлам. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом во время создания кластера или пула узлов. Каждый тег в списке должен соответствовать RFC1035. Возвращается: success |
|
taints complex |
Список меток Kubernetes, которые будут применены к каждому узлу. Возвращается: success |
|
effect string |
Эффект для метки. Возвращается: success |
|
key string |
Ключ для метки. Возвращается: success |
|
value string |
Значение для метки. Возвращается: success |
|
workloadMetaConfig complex |
WorkloadMetadataConfig определяет конфигурацию метаданных для предоставления рабочим нагрузкам в пуле узлов. Возвращается: success |
|
mode string |
Mode — это конфигурация для того, как предоставлять метаданные рабочим нагрузкам, работающим в пуле узлов. Возвращается: success |
|
initialNodeCount integer |
Начальное количество узлов для пула. Вы должны убедиться, что ваша квота ресурсов Compute Engine достаточна для этого количества экземпляров. Вам также необходима квота доступных брандмауэров и маршрутов. Возвращается: success |
|
location string |
Расположение, где развернут пул узлов. Возвращается: success |
|
management complex |
Настройка управления для данного NodePool. Возвращается: success |
|
autoRepair boolean |
Флаг, указывающий, включена ли автоматическая очистка узлов для пула узлов. Если включено, узлы в этом пуле узлов будут отслеживаться, и если они слишком много раз не пройдут проверки работоспособности, будет выполнено автоматическое действие исправления. Возвращается: success |
|
autoUpgrade boolean |
Флаг, указывающий, включено ли автоматическое обновление узлов для пула узлов. Если включено, автоматическое обновление узлов поможет поддерживать узлы в вашем пуле узлов в актуальном состоянии с последней версией Kubernetes. Возвращается: success |
|
upgradeOptions complex |
Указывает параметры автоматического обновления для пула узлов. Возвращается: success |
|
autoUpgradeStartTime string |
Это поле устанавливается при приближении к началу обновлений с приблизительным временем начала обновлений в формате RFC3339. Возвращается: success |
|
description string |
Это поле устанавливается при приближении к началу обновлений с описанием обновления. Возвращается: success |
|
maxPodsConstraint complex |
Ограничение на максимальное количество подкастов, которые могут выполняться одновременно на узле в пуле узлов. Возвращается: success |
|
maxPodsPerNode integer |
Ограничение, накладываемое на максимальное количество подкастов на узел. Возвращается: success |
| ... (rest of the table) ... |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_container_node_pool_info_module.html