модуль google.cloud.gcp_container_cluster — Создание кластера GCP

access_token

string

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

addons_config

dictionary

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

horizontal_pod_autoscaling

dictionary

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

disabled

boolean

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

Варианты:

• false
• true

http_load_balancing

dictionary

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

disabled

boolean

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

Варианты:

• false
• true

network_policy_config

dictionary

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

disabled

boolean

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

Варианты:

• false
• true

auth_kind

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

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

Варианты:

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

binary_authorization

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

cluster_ipv4_cidr

string

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

database_encryption

dictionary

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

key_name

string

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

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

state

string

Указывает состояние шифрования etcd.

Допустимые варианты: “ENCRYPTED”, “DECRYPTED”

default_max_pods_constraint

dictionary

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

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

max_pods_per_node

string

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

description

string

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

enable_kubernetes_alpha

boolean

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

Варианты:

• false
• true

enable_tpu

boolean

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

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

Варианты:

• false
• true

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Оно изменяет только строку User Agent для запросов API.

initial_cluster_version

string

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

initial_node_count

integer

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

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

ip_allocation_policy

dictionary

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

cluster_ipv4_cidr_block

string

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

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

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

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

cluster_secondary_range_name

string

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

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

create_subnetwork

boolean

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

Варианты:

• false
• true

node_ipv4_cidr_block

string

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

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

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

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

services_ipv4_cidr_block

string

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

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

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

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

services_secondary_range_name

string

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

stack_type

string

Тип IP-стека кластера; возможные значения: (STACK_TYPE_UNSPECIFIED, IPV4, IPV4_IPV6)

subnetwork_name

string

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

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

tpu_ipv4_cidr_block

string

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

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

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

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

use_ip_aliases

boolean

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

Варианты:

• false
• true

kubectl_context

string

Имя контекста для файла конфигурации kubectl. По умолчанию используется имя кластера.

kubectl_path

string

Путь, по которому будет записан файл конфигурации kubectl.

Если этот путь не задан, файл создан не будет.

Существующий файл по этому пути будет полностью перезаписан.

Требуется библиотека PyYaml.

legacy_abac

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

location

псевдонимы: zone

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

Местоположение, в котором развернут кластер.

locations

псевдонимы: nodeLocations

list / элементы=string

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

logging_service

string

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

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

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

Допустимые варианты: “logging.googleapis.com”, “none”

master_auth

dictionary

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

client_certificate_config

dictionary

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

issue_client_certificate

boolean

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

Варианты:

• false
• true

password

string

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

username

string

Имя пользователя для базовой HTTP-аутентификации на конечной точке главного узла. (Не поддерживается в GKE версии >= 1.19.)

master_authorized_networks_config

dictionary

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

cidr_blocks

list / элементы=dictionary

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

cidr_block

string

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

display_name

string

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

enabled

boolean

Включен ли список разрешенных сетей для главного узла.

Варианты:

• false
• true

monitoring_service

string

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

Доступный вариант: monitoring.googleapis.com — служба Google Cloud Monitoring.

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

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

Допустимые варианты: “monitoring.googleapis.com”, “none”

name

string

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

network

string

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

network_config

dictionary

Конфигурации сети.

datapath_provider

string

Поставщик datapath выбирает реализацию сетевой модели Kubernetes для разрешения служб и применения сетевых политик.

default_snat_status

boolean

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

Варианты:

• false
• true

enable_intra_node_visibility

boolean

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

Варианты:

• false
• true

network_policy

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

provider

string

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

Допустимые варианты: «PROVIDER_UNSPECIFIED», «CALICO»

node_config

dictionary

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

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

accelerators

list / elements=dictionary

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

accelerator_count

string

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

accelerator_type

string

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

disk_size_gb

integer

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

disk_type

string

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

image_type

string

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

labels

dictionary

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

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

local_ssd_count

integer

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

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

machine_type

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” }.

min_cpu_platform

string

Минимальная платформа ЦП, используемая этим экземпляром. Экземпляр может быть запланирован на указанной или более новой платформе ЦП.

oauth_scopes

list / elements=string

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

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

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

Если значение не указано, области действия не добавляются, кроме случаев, когда включены Cloud Logging или Cloud Monitoring: тогда добавляются необходимые для них области действия.

preemptible

boolean

Создаются ли узлы как вытесняемые экземпляры виртуальных машин. Дополнительные сведения о вытесняемых экземплярах виртуальных машин см. на странице https://cloud.google.com/compute/docs/instances/preemptible.

Варианты:

• false
• true

service_account

string

Учетная запись службы Google Cloud Platform, используемая виртуальными машинами узлов. Если учетная запись службы не указана, используется учетная запись службы “default”.

shielded_instance_config

dictionary

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

enable_integrity_monitoring

boolean

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

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

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

Варианты:

• false
• true

enable_secure_boot

boolean

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

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

Варианты:

• false
• true

tags

list / elements=string

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

taints

list / elements=dictionary

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

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

effect

string

Эффект taint.

Допустимые варианты: “EFFECT_UNSPECIFIED”, “NO_SCHEDULE”, “PREFER_NO_SCHEDULE”, “NO_EXECUTE”

key

string

Ключ taint.

value

string

Значение taint.

private_cluster_config

dictionary

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

enable_private_endpoint

boolean

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

Варианты:

• false
• true

enable_private_nodes

boolean

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

Варианты:

• false
• true

master_ipv4_cidr_block

string

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

project

string

Проект Google Cloud Platform, который следует использовать.

release_channel

dictionary

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

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

channel

string

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

Допустимые варианты: “UNSPECIFIED”, “RAPID”, “REGULAR”, “STABLE”

resource_labels

dictionary

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

scopes

list / elements=string

Массив используемых областей действия

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей этот словарь.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

shielded_nodes

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

state

string

Должен ли указанный объект существовать в GCP

Варианты:

• "present" ← (по умолчанию)
• "absent"

subnetwork

string

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

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 должно оставаться пустым.

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

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

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

Возвращается: при успешном выполнении

clusterSecondaryRangeName

string

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

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

Возвращается: при успешном выполнении

createSubnetwork

boolean

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

Возвращается: при успешном выполнении

nodeIpv4CidrBlock

string

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

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

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

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

Возвращается: при успешном выполнении

servicesIpv4CidrBlock

string

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

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

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

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

Возвращается: при успешном выполнении

servicesSecondaryRangeName

string

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

Возвращается: при успешном выполнении

stackType

string

Тип IP-стека кластера. Возможные значения: (STACK_TYPE_UNSPECIFIED, IPV4, IPV4_IPV6)

Возвращается: при успешном выполнении

subnetworkName

string

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

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

Возвращается: при успешном выполнении

tpuIpv4CidrBlock

string

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

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

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

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

Возвращается: при успешном выполнении

useIpAliases

boolean

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

Возвращается: при успешном выполнении

kubectlContext

string

Имя контекста для файла конфигурации kubectl. По умолчанию используется имя кластера.

Возвращается: при успешном выполнении

kubectlPath

string

Путь, по которому будет записан файл конфигурации kubectl.

Если этот путь не задан, файл не будет создан.

Существующий файл по указанному пути будет полностью перезаписан.

Для этого требуется библиотека PyYaml.

Возвращается: при успешном выполнении

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

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

Возвращается: при успешном выполнении

clientKey

string

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

Возвращается: при успешном выполнении

clusterCaCertificate

string

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

Возвращается: при успешном выполнении

password

string

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

Возвращается: при успешном выполнении

username

string

Имя пользователя для базовой HTTP-аутентификации в конечной точке главного узла. (не поддерживается в GKE >= 1.19).

Возвращается: при успешном выполнении

masterAuthorizedNetworksConfig

complex

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

Возвращается: при успешном выполнении

cidrBlocks

complex

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

Возвращается: при успешном выполнении

cidrBlock

string

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

Возвращается: при успешном выполнении

displayName

string

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

Возвращается: при успешном выполнении

enabled

boolean

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

Возвращается: при успешном выполнении

monitoringService

string

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

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

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

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

network

string

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

Возвращается: при успешном выполнении

networkConfig

complex

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

Возвращается: при успешном выполнении

defaultSnatStatus

boolean

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

Возвращается: при успешном выполнении

enableIntraNodeVisibility

boolean

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

Возвращается: при успешном выполнении

network

string

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

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

Возвращается: при успешном выполнении

subnetwork

string

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

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

Возвращается: при успешном выполнении

networkPolicy

complex

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

Возвращается: при успешном выполнении

enabled

boolean

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

Возвращается: при успешном выполнении

provider

string

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

Возвращается: при успешном выполнении

nodeConfig

complex

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

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

Возвращается: при успешном выполнении

accelerators

complex

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

Возвращается: при успешном выполнении

acceleratorCount

string

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

Возвращается: при успешном выполнении

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

Набор областей доступа Google API, предоставляемых всем виртуальным машинам узлов для учетной записи службы “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

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

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

Возвращается: при успешном выполнении

tags

list / elements=string

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

Возвращается: при успешном выполнении

taints

complex

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

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

Возвращается: при успешном выполнении

effect

string

Эффект ограничения.

Возвращается: при успешном выполнении

key

string

Ключ ограничения.

Возвращается: при успешном выполнении

value

string

Значение ограничения.

Возвращается: при успешном выполнении

nodeIpv4CidrSize

integer

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

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

Возвращается: при успешном выполнении

nodePools

complex

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

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`).

Возвращается: успешно