модуль google.cloud.gcp_container_cluster_info — сбор сведений о кластере GCP

access_token

string

Токен доступа OAuth2, если в качестве типа учётных данных выбрано accesstoken.

auth_kind

string / обязательный

Тип используемых учётных данных.

Варианты:

• "application"
• "machineaccount"
• "serviceaccount"
• "accesstoken"

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.

resources

complex

Список ресурсов

Возвращается: всегда

addonsConfig

complex

Конфигурации различных дополнений, доступных для запуска в кластере.

Возвращается: при успехе

horizontalPodAutoscaling

complex

Конфигурация функции горизонтального автомасштабирования подов, которая увеличивает или уменьшает количество реплик подов у контроллера репликации на основе использования ресурсов существующими подами.

Возвращается: при успехе

disabled

boolean

Включена ли в кластере функция горизонтального автомасштабирования подов. Если она включена, в кластере будет работать под Heapster, который также используется службой Cloud Monitoring.

Возвращается: при успехе

httpLoadBalancing

complex

Конфигурация дополнения — контроллера балансировки нагрузки HTTP (L7), упрощающего настройку балансировщиков нагрузки HTTP для служб в кластере.

Возвращается: при успехе

disabled

boolean

Включен ли в кластере контроллер балансировки нагрузки HTTP. Если он включен, в кластере запускается небольшой под, управляющий балансировщиками нагрузки.

Возвращается: при успехе

networkPolicyConfig

complex

Конфигурация NetworkPolicy. Здесь отслеживается только то, включено ли дополнение на главном узле; включена ли сетевая политика для узлов, не отслеживается.

Возвращается: при успехе

disabled

boolean

Включена ли NetworkPolicy для этого кластера.

Возвращается: при успехе

binaryAuthorization

complex

Конфигурация функции BinaryAuthorization.

Возвращается: при успехе

enabled

boolean

Если функция включена, все образы контейнеров будут проверяться с помощью Binary Authorization.

Возвращается: при успехе

clusterIpv4Cidr

string

Диапазон IP-адресов подов контейнеров в этом кластере в нотации CIDR (например, 10.96.0.0/14). Оставьте поле пустым, чтобы диапазон был выбран автоматически, или укажите блок /14 в диапазоне 10.0.0.0/8.

Возвращается: при успехе

conditions

complex

Условия, вызвавшие текущее состояние кластера.

Возвращается: при успехе

code

string

Представление условия, удобное для машинной обработки.

Возвращается: при успехе

message

string

Представление условия, понятное человеку.

Возвращается: при успехе

createTime

string

Время создания кластера в текстовом формате RFC3339.

Возвращается: при успехе

currentMasterVersion

string

Текущая версия программного обеспечения конечной точки главного узла.

Возвращается: при успехе

currentNodeCount

integer

Количество узлов, которые в данный момент находятся в кластере.

Возвращается: при успехе

currentNodeVersion

string

Текущая версия программных компонентов узла. Если на узлах сейчас используются разные версии из-за выполняющегося обновления, здесь указана минимальная версия среди всех узлов.

Возвращается: при успехе

databaseEncryption

complex

Конфигурация шифрования etcd.

Возвращается: при успехе

keyName

string

Имя ключа CloudKMS, используемого для шифрования секретов в etcd. Например:

`projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key` .

Возвращается: при успехе

state

string

Обозначает состояние шифрования etcd.

Возвращается: при успехе

defaultMaxPodsConstraint

complex

Ограничение по умолчанию на максимальное количество подов, которые могут одновременно работать на узле в пуле узлов этого кластера.

Учитывается только в том случае, если кластер создан с поддержкой IP Alias.

Возвращается: при успехе

maxPodsPerNode

string

Ограничение на максимальное количество подов на узел.

Возвращается: при успехе

description

string

Необязательное описание этого кластера.

Возвращается: при успехе

enableKubernetesAlpha

boolean

В кластере включены альфа-функции Kubernetes. Сюда входят альфа-группы API (например, v1alpha1) и функции, которые могут быть не готовы к промышленной эксплуатации в версии Kubernetes главного узла и узлов.

Возвращается: при успехе

enableTpu

boolean

(Необязательно) Включить ли ресурсы Cloud TPU в этом кластере.

См. официальную документацию: https://cloud.google.com/tpu/docs/kubernetes-engine-setup .

Возвращается: при успехе

endpoint

string

IP-адрес конечной точки главного узла этого кластера.

К конечной точке можно обратиться из интернета по адресу https://username:password@endpoint/. Сведения об имени пользователя и пароле см. в свойстве masterAuth этого ресурса.

Возвращается: при успехе

expireTime

string

Время автоматического удаления кластера в текстовом формате RFC3339.

Возвращается: при успехе

initialClusterVersion

string

Версия программного обеспечения конечной точки главного узла и kubelet, используемая в кластере при его создании. Со временем эту версию можно обновить.

Возвращается: при успехе

initialNodeCount

integer

Количество узлов, создаваемых в этом кластере. Убедитесь, что квоты ресурсов Compute Engine достаточно для такого количества экземпляров. Также должны быть доступны квоты брандмауэра и маршрутов. В запросах это поле следует использовать только вместо объекта “nodePool”, поскольку на основе этой конфигурации (вместе с “nodeConfig”) будет создан объект “NodePool” с автоматически сгенерированным именем. Не используйте это поле одновременно с nodePool.

Это поле устарело. Используйте вместо него nodePool.initial_node_count.

Возвращается: при успехе

ipAllocationPolicy

complex

Конфигурация управления распределением IP-адресов в кластере.

Возвращается: при успехе

clusterIpv4CidrBlock

string

Диапазон IP-адресов подов кластера. Если это поле задано, cluster.cluster_ipv4_cidr необходимо оставить пустым.

Это поле применимо только при значении true для useIpAliases.

Оставьте поле пустым, чтобы выбрать диапазон размера по умолчанию.

Укажите /маску_подсети (например, /14), чтобы выбрать диапазон с определенной маской подсети.

Возвращается: при успехе

clusterSecondaryRangeName

string

Имя вторичного диапазона, используемого для блока CIDR кластера. Вторичный диапазон будет использоваться для IP-адресов подов.

Это должен быть существующий вторичный диапазон, связанный с подсетью кластера.

Возвращается: при успехе

createSubnetwork

boolean

Будет ли для кластера автоматически создана новая подсеть.

Возвращается: при успехе

nodeIpv4CidrBlock

string

Диапазон IP-адресов экземпляров в этом кластере.

Применимо только при значении true для createSubnetwork.

Оставьте поле пустым, чтобы выбрать диапазон размера по умолчанию.

Укажите /маску_подсети (например, /14), чтобы выбрать диапазон с определенной маской подсети.

Возвращается: при успехе

servicesIpv4CidrBlock

string

Диапазон IP-адресов служб в этом кластере. Если поле пустое, диапазон размера по умолчанию будет выбран автоматически.

Это поле применимо только при значении true для useIpAliases.

Оставьте поле пустым, чтобы выбрать диапазон размера по умолчанию.

Укажите /маску_подсети (например, /14), чтобы выбрать диапазон с определенной маской подсети.

Возвращается: при успехе

servicesSecondaryRangeName

string

Имя вторичного диапазона, используемого для блока CIDR служб. Вторичный диапазон будет использоваться для ClusterIP служб. Это должен быть существующий вторичный диапазон, связанный с подсетью кластера.

Возвращается: при успехе

subnetworkName

string

Пользовательское имя подсети, используемое при значении true для createSubnetwork.

Если это поле пустое, новой подсети будет автоматически присвоено имя.

Возвращается: при успехе

tpuIpv4CidrBlock

string

Диапазон IP-адресов Cloud TPU в этом кластере. Если диапазон не указан, он будет автоматически выбран с размером по умолчанию.

Это поле применимо только при значении true для useIpAliases.

Если диапазон не указан, будет использоваться размер по умолчанию.

Укажите /маску_подсети (например, /14), чтобы выбрать диапазон с определенной маской подсети.

Возвращается: при успехе

useIpAliases

boolean

Будут ли для IP-адресов подов в кластере использоваться псевдонимы IP-адресов.

Возвращается: при успехе

labelFingerprint

string

Отпечаток набора меток этого кластера.

Возвращается: при успехе

legacyAbac

complex

Конфигурация устаревшего режима авторизации ABAC.

Возвращается: при успехе

enabled

boolean

Включен ли в этом кластере механизм авторизации ABAC. Если он включен, субъектам системы, включая учетные записи служб, узлы и контроллеры, будут статически предоставлены разрешения сверх тех, которые определены конфигурацией RBAC или IAM.

Возвращается: при успехе

location

string

Регион или зона, в которой развернут кластер.

Возвращается: при успехе

locations

list / elements=string

Список зон Google Compute Engine, в которых должны находиться узлы кластера.

Возвращается: при успехе

loggingService

string

Служба ведения журналов, которую кластер должен использовать для записи журналов. Сейчас доступны следующие варианты: logging.googleapis.com — служба Google Cloud Logging.

none — журналы из кластера экспортироваться не будут.

Если оставить пустую строку, будет использоваться logging.googleapis.com.

Возвращается: при успехе

masterAuth

complex

Данные аутентификации для доступа к конечной точке главного узла.

Возвращается: при успехе

clientCertificate

string

Закодированный в Base64 открытый сертификат, используемый клиентами для аутентификации при обращении к конечной точке кластера.

Возвращается: при успехе

clientCertificateConfig

complex

Конфигурация аутентификации по сертификату клиента в кластере. Для кластеров до версии v1.12, если конфигурация не указана, выдается сертификат клиента.

Возвращается: при успехе

issueClientCertificate

boolean

Выдать сертификат клиента.

Возвращается: success

clientKey

string

Закрытый ключ в кодировке Base64, используемый клиентами для аутентификации в конечной точке кластера.

Возвращается: success

clusterCaCertificate

string

Открытый сертификат в кодировке Base64, являющийся корнем доверия для кластера.

Возвращается: success

password

string

Пароль для базовой HTTP-аутентификации в конечной точке главного узла. Поскольку конечная точка главного узла доступна из Интернета, следует создать надежный пароль длиной не менее 16 символов.

Возвращается: success

username

string

Имя пользователя для базовой HTTP-аутентификации в конечной точке главного узла.

Возвращается: success

masterAuthorizedNetworksConfig

complex

Настройки, определяющие распределение IP-адресов в кластере.

Возвращается: success

cidrBlocks

complex

Задайте до 50 внешних сетей, которые могут обращаться к главному узлу Kubernetes через HTTPS.

Возвращается: success

cidrBlock

string

Блок, заданный в нотации CIDR.

Возвращается: success

displayName

string

Необязательное поле для идентификации блоков CIDR.

Возвращается: success

enabled

boolean

Включены ли авторизованные сети главного узла.

Возвращается: success

monitoringService

string

Служба мониторинга, которую кластер должен использовать для записи метрик.

Доступные в настоящее время варианты: monitoring.googleapis.com — служба мониторинга Google Cloud.

none — метрики не будут экспортироваться из кластера.

Если оставить пустую строку, будет использоваться monitoring.googleapis.com.

Возвращается: success

name

string

Имя кластера. Имя должно быть уникальным в пределах проекта и региона и может содержать не более 40 символов. Допускаются только строчные латинские буквы, цифры и дефисы. Имя должно начинаться с буквы и заканчиваться цифрой или буквой.

Возвращается: success

network

string

Имя сети Google Compute Engine, к которой подключен кластер. Если не указано, будет использоваться сеть по умолчанию.

Возвращается: success

networkConfig

complex

Настройки сети.

Возвращается: success

defaultSnatStatus

boolean

Отключает ли кластер стандартные правила sNAT внутри узлов. При отключении defaultSnatStatus правила sNAT внутри узлов будут отключены.

Возвращается: success

enableIntraNodeVisibility

boolean

Включена ли в кластере видимость трафика внутри узла. Эта настройка позволяет сети VPC видеть трафик между подами на одном узле.

Возвращается: success

network

string

Относительное имя сети Google Compute Engine, к которой подключен кластер.

Пример: projects/my-project/global/networks/my-network .

Возвращается: success

subnetwork

string

Относительное имя подсети Google Compute Engine, к которой подключен кластер.

Пример: projects/my-project/regions/us-central1/subnetworks/my-subnet .

Возвращается: success

networkPolicy

complex

Параметры настройки функции NetworkPolicy.

Возвращается: success

enabled

boolean

Включена ли сетевая политика в кластере.

Возвращается: success

provider

string

Выбранный поставщик сетевых политик.

Возвращается: success

nodeConfig

complex

Параметры, используемые при создании узлов кластера.

В запросах это поле следует использовать только вместо объекта «nodePool», поскольку эта конфигурация вместе с «initialNodeCount» будет применена для создания объекта «NodePool» с автоматически сгенерированным именем. Не используйте это поле одновременно с nodePool. В ответах это поле будет заполнено конфигурацией узлов первого пула узлов. Если значение не указано, используются значения по умолчанию.

Возвращается: success

accelerators

complex

Список аппаратных ускорителей, подключаемых к каждому узлу. Дополнительные сведения о поддержке GPU см. на странице https://cloud.google.com/compute/docs/gpus.

Возвращается: success

acceleratorCount

string

Количество ускорительных карт, доступных экземпляру.

Возвращается: success

acceleratorType

string

Имя ресурса типа ускорителя.

Возвращается: success

diskSizeGb

integer

Размер диска, подключаемого к каждому узлу, в ГБ. Минимальный допустимый размер диска — 10 ГБ. Если значение не указано, размер диска по умолчанию составляет 100 ГБ.

Возвращается: success

diskType

string

Тип диска, подключаемого к каждому узлу (например, «pd-standard» или «pd-ssd»). Если значение не указано, используется тип диска по умолчанию — «pd-standard».

Возвращается: success

imageType

string

Тип образа, используемого для этого узла. Для указанного типа образа будет использоваться последняя версия.

Возвращается: success

labels

dictionary

Словарь меток Kubernetes (пар «ключ/значение»), применяемых к каждому узлу. Они будут добавлены к меткам по умолчанию, которые Kubernetes может назначить узлу. При конфликте ключей меток применяемый набор может различаться в зависимости от версии Kubernetes — лучше считать такое поведение неопределенным и избегать конфликтов. Дополнительные сведения, включая информацию об использовании и допустимых значениях, см. здесь: http://kubernetes.io/v1.1/docs/user-guide/labels.html. Объект, содержащий список пар «ключ»: значение.

Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Возвращается: success

localSsdCount

integer

Количество локальных SSD-дисков, подключаемых к узлу.

Ограничение для этого значения зависит от максимального количества дисков, доступных на машине в соответствующей зоне. Дополнительные сведения см. здесь: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits.

Возвращается: success

machineType

string

Имя типа машины Google Compute Engine (например,

n1-standard-1). Если значение не указано, используется тип машины по умолчанию n1-standard-1.

Возвращается: success

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

Минимальная платформа CPU для этого экземпляра. Экземпляр может быть запланирован на указанной или более новой платформе CPU.

Возвращается: success

oauthScopes

list / elements=string

Набор областей доступа Google API, предоставляемых всем виртуальным машинам узлов в рамках учетной записи службы “default”.

Рекомендуется, но не обязательно, указать следующие области доступа; по умолчанию они не добавляются: для подключения постоянного хранилища к узлам требуется https://www.googleapis.com/auth/compute.

Для взаимодействия с gcr.io (реестром контейнеров Google) требуется https://www.googleapis.com/auth/devstorage.read_only.

Если значение не указано, области доступа не добавляются, кроме случаев, когда включены 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

Параметры Shielded Instance.

Возвращается: success

enableIntegrityMonitoring

boolean

Определяет, включен ли для экземпляра мониторинг целостности.

Включает мониторинг и аттестацию целостности загрузки экземпляра.

Аттестация выполняется относительно базового уровня политики целостности. При создании экземпляра этот базовый уровень изначально формируется на основе неявно доверенного загрузочного образа.

Возвращается: success

enableSecureBoot

boolean

Определяет, включена ли для экземпляра безопасная загрузка.

Безопасная загрузка помогает гарантировать, что система запускает только подлинное программное обеспечение: она проверяет цифровую подпись всех компонентов загрузки и останавливает процесс загрузки в случае сбоя проверки подписи.

Возвращается: success

tags

list / elements=string

Список тегов экземпляров, применяемых ко всем узлам. Теги используются для идентификации допустимых источников или целей правил сетевого экрана и указываются клиентом при создании кластера или пула узлов. Каждый тег в списке должен соответствовать RFC1035.

Возвращается: success

taints

complex

Список меток taint Kubernetes, применяемых к каждому узлу.

Дополнительные сведения, включая информацию об использовании и допустимых значениях, см. здесь: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/.

Возвращается: success

effect

string

Эффект метки taint.

Возвращается: success

key

string

Ключ метки taint.

Возвращается: success

value

string

Значение метки taint.

Возвращается: success

nodeIpv4CidrSize

integer

Размер адресного пространства на каждом узле для размещения контейнеров.

Оно выделяется из диапазона container_ipv4_cidr.

Возвращается: success

nodePools

complex

Пулы узлов, относящиеся к этому кластеру.

Возвращается: success

name

string

Имя пула узлов.

Возвращается: success

privateClusterConfig

complex

Конфигурация частного кластера.

Возвращается: при успехе

enablePrivateEndpoint

boolean

Используется ли внутренний IP-адрес главного узла в качестве конечной точки кластера.

Возвращается: при успехе

enablePrivateNodes

boolean

Имеют ли узлы только внутренние IP-адреса. Если параметр включён, всем узлам назначаются только частные адреса RFC 1918, и они взаимодействуют с главным узлом через частную сеть.

Возвращается: при успехе

masterIpv4CidrBlock

string

Диапазон IP-адресов в нотации CIDR, используемый для размещённой сети главного узла. Этот диапазон используется для назначения внутренних IP-адресов главному узлу или набору главных узлов, а также виртуальному IP-адресу ILB. Этот диапазон не должен пересекаться с другими диапазонами, используемыми в сети кластера.

Возвращается: при успехе

privateEndpoint

string

Внутренний IP-адрес конечной точки главного узла этого кластера.

Возвращается: при успехе

publicEndpoint

string

Внешний IP-адрес конечной точки главного узла этого кластера.

Возвращается: при успехе

releaseChannel

complex

ReleaseChannel указывает, на какой канал обновлений подписан кластер.

Каналы обновлений упорядочены по степени риска и частоте обновлений.

Возвращается: при успехе

channel

string

Канал обновлений, на который подписан кластер.

Возвращается: при успехе

resourceLabels

dictionary

Метки ресурсов кластера, используемые для аннотирования связанных ресурсов Google Compute Engine.

Возвращается: при успехе

servicesIpv4Cidr

string

Диапазон IP-адресов служб Kubernetes в этом кластере в нотации CIDR (например, 1.2.3.4/29). Адреса служб обычно размещаются в последнем блоке /16 диапазона CIDR контейнеров.

Возвращается: при успехе

shieldedNodes

complex

Конфигурация Shielded Nodes.

Возвращается: при успехе

enabled

boolean

Включены ли функции Shielded Nodes на всех узлах этого кластера.

Возвращается: при успехе

status

string

Текущий статус этого кластера.

Возвращается: при успехе

statusMessage

string

Дополнительные сведения о текущем статусе этого кластера, если они доступны.

Возвращается: при успехе

subnetwork

string

Имя подсети Google Compute Engine, к которой подключён кластер.

Возвращается: при успехе

tpuIpv4CidrBlock

string

Диапазон IP-адресов Cloud TPU в этом кластере в нотации [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) (например, `1.2.3.4/29`).

Возвращается: при успехе