Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_container_cluster – Создает кластер GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования его в книге задач укажите: google.cloud.gcp_container_cluster.

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

Описание

  • Кластер Google Container Engine.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип аутентификации accesstoken.

addons_config

словарь

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

horizontal_pod_autoscaling

словарь

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

disabled

логическое

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

Выбор:

  • false
  • true

http_load_balancing

словарь

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

disabled

логическое

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

Выбор:

  • false
  • true

network_policy_config

словарь

Настройка NetworkPolicy. Отслеживает только включен ли аддон на Мастер-узле, а не включение политики сети для узлов.

disabled

логическое

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

Выбор:

  • false
  • true

auth_kind

строка / обязательно

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

Выбор:

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

binary_authorization

словарь

Настройка функции BinaryAuthorization.

enabled

логическое

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

Выбор:

  • false
  • true

cluster_ipv4_cidr

строка

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

database_encryption

словарь

Настройка шифрования etcd.

key_name

строка

Имя ключа CloudKMS для шифрования секретов в etcd. Пример:

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

state

строка

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

Некоторые допустимые значения: «ENCRYPTED», «DECRYPTED»

default_max_pods_constraint

словарь

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

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

max_pods_per_node

строка

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

description

строка

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

enable_kubernetes_alpha

логическое

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

Выбор:

  • false
  • true

enable_tpu

логическое

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

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

Выбор:

  • false
  • true

env_type

string

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

Это поле следует устанавливать только в случае необходимости.

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

initial_cluster_version

string

Версия программного обеспечения для узла-мастера и kubelets в кластере на момент его создания. Версию можно обновлять со временем.

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

Это поле применимо только при useIpAliases = true.

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

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

cluster_secondary_range_name

string

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

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

create_subnetwork

boolean

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

Выбор:

  • false
  • true

node_ipv4_cidr_block

string

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

Это применимо только если createSubnetwork = true.

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

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

services_ipv4_cidr_block

string

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

Это поле применимо только при useIpAliases = true.

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

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

services_secondary_range_name

string

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

stack_type

string

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

subnetwork_name

string

Настраиваемое имя подсети, которое будет использоваться, если createSubnetwork = true.

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

tpu_ipv4_cidr_block

string

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

Это поле применимо только при useIpAliases = true.

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

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

use_ip_aliases

boolean

Указывает, будут ли использоваться алиасы IP для адресов под узлов в кластере.

Выбор:

  • false
  • true

kubectl_context

string

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

kubectl_path

string

Путь к файлу конфигурации kubectl.

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

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

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

legacy_abac

dictionary

Конфигурация для режима авторизации ABAC legacy.

enabled

boolean

Включить ли ABAC авторизатор для данного кластера. При включении, идентификаторам в системе, включая учетные записи сервисов, узлы и контроллеры, будут статически предоставлены права помимо тех, которые предоставляются настройками RBAC или IAM.

Выбор:

  • false
  • true

местоположение

псевдонимы: зона

строка / обязательно

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

местоположения

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

список / элементы=строка

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

logging_service

строка

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

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

Если оставлено пустым, будет использоваться logging.googleapis.com.

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

master_auth

словарь

Информация об авторизации для доступа к мастер-узлу.

client_certificate_config

словарь

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

issue_client_certificate

логическое

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

Варианты:

  • false
  • true

пароль

строка

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

имя_пользователя

строка

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

master_authorized_networks_config

словарь

Настройка управления распределением IP-адресов в кластере.

cidr_blocks

список / элементы=словарь

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

cidr_block

строка

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

display_name

строка

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

enabled

логическое

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

Варианты:

  • false
  • true

monitoring_service

строка

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

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

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

Если оставлено пустым, будет использоваться monitoring.googleapis.com.

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

имя

строка

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

сеть

строка

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

network_config

словарь

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

datapath_provider

строка

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

default_snat_status

логическое

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

Варианты:

  • false
  • true

enable_intra_node_visibility

логическое

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

Варианты:

  • false
  • true

network_policy

dictionary

Настройки для функции NetworkPolicy.

enabled

boolean

Включена ли функция Network Policy в кластере.

Варианты:

  • false
  • true

provider

string

Выбранный поставщик Network Policy.

Некоторые допустимые варианты: “PROVIDER_UNSPECIFIED”, “CALICO”

node_config

dictionary

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

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

accelerators

list / elements=dictionary

Список аппаратных ускорителей, которые будут подключены к каждому узлу. Дополнительную информацию об ускорителях графических процессоров см. на странице 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 Объект, содержащий список пар «ключ»: значение.

Пример: { «имя»: «ключ», «масса»: «1,3 кг», «количество»: «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-стандартный-1). Если не указано, тип виртуальной машины по умолчанию — n1-стандартный-1.

metadata

dictionary

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

Ключи должны соответствовать регулярному выражению [a-zA-Z0-9-_]+ и иметь длину менее 128 байтов. Они отражаются в URL-адресе в сервере метаданных. Кроме того, для избежания неоднозначностей ключи не должны конфликтовать с другими ключами метаданных для проекта или быть одним из четырех зарезервированных ключей: «instance-template», «kube-env», «startup-script» и «user-data». Значения — свободные строки, и они имеют смысл только в интерпретации образа, работающего в экземпляре. Единственное ограничение, которое на них накладывается, заключается в том, что размер каждого значения должен быть меньше или равен 32 КБ.

Общая длина всех ключей и значений должна быть меньше 512 КБ.

Объект, содержащий список пар «ключ»: значение.

Пример: { «имя»: «ключ», «масса»: «1,3 кг», «количество»: «3» }.

min_cpu_platform

string

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

oauth_scopes

list / elements=string

Набор облачных API-скопов Google, которые должны быть доступны на всех виртуальных машинах узлов в рамках учетной записи службы «по умолчанию».

Рекомендуются следующие области, но они не являются обязательными и по умолчанию не включены: 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.

Варианты:

  • false
  • true

service_account

string

Учетная запись сервиса Google Cloud Platform, которая будет использоваться виртуальными машинами узлов. Если учетная запись сервиса не указана, используется учетная запись «по умолчанию».

shielded_instance_config

dictionary

Параметры защищенного виртуального экземпляра.

enable_integrity_monitoring

boolean

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

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

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

Варианты:

  • false
  • true

enable_secure_boot

boolean

Определяет, включен ли на экземпляре Secure Boot.

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

Варианты:

  • false
  • true

tags

list / elements=string

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

taints

list / elements=dictionary

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

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

effect

string

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

Некоторые допустимые значения включают: «EFFECT_UNSPECIFIED», «NO_SCHEDULE», «PREFER_NO_SCHEDULE», «NO_EXECUTE»

key

string

Ключ метки.

value

string

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

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-адресов мастеру или набору мастеров, а также VIP-адресу 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, к которой подключен кластер.

Примеры

- name: create a cluster
  google.cloud.gcp_container_cluster:
    name: my-cluster
    initial_node_count: 2
    node_config:
      machine_type: n1-standard-4
      disk_size_gb: 500
    location: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ

Описание

addonsConfig

complex

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

Возвращаемое значение: успех

horizontalPodAutoscaling

complex

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

Возвращаемое значение: успех

disabled

boolean

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

Возвращаемое значение: успех

httpLoadBalancing

complex

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

Возвращаемое значение: успех

disabled

boolean

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

Возвращаемое значение: успех

networkPolicyConfig

complex

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

Возвращаемое значение: успех

disabled

boolean

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

Возвращаемое значение: успех

binaryAuthorization

complex

Настройка функции BinaryAuthorization.

Возвращаемое значение: успех

enabled

boolean

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

Возвращаемое значение: успех

clusterIpv4Cidr

string

Диапазон IP-адресов контейнерных Pods в этом кластере в 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.

Возвращаемое значение: success

maxPodsPerNode

string

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

Возвращаемое значение: success

description

string

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

Возвращаемое значение: success

enableKubernetesAlpha

boolean

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

Возвращаемое значение: success

enableTpu

boolean

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

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

Возвращаемое значение: success

endpoint

string

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

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

Возвращаемое значение: success

expireTime

string

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

Возвращаемое значение: success

initialClusterVersion

string

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

Возвращаемое значение: success

initialNodeCount

integer

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

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

Возвращаемое значение: success

ipAllocationPolicy

complex

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

Возвращаемое значение: success

clusterIpv4CidrBlock

string

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

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

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

Установите /netmask (например, /14), чтобы выбрать диапазон со специфическим маской сети.

Возвращаемое значение: success

clusterSecondaryRangeName

string

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

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

Возвращаемое значение: success

createSubnetwork

boolean

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

Возвращаемое значение: success

nodeIpv4CidrBlock

string

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

Это применимо только если createSubnetwork равно true.

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

Установите /netmask (например, /14), чтобы выбрать диапазон со специфическим маской сети.

Возвращаемое значение: success

servicesIpv4CidrBlock

string

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

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

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

Установите /netmask (например, /14), чтобы выбрать диапазон со специфическим маской сети.

Возвращаемое значение: success

servicesSecondaryRangeName

string

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

Возвращаемое значение: success

stackType

string

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

Возвращаемое значение: success

subnetworkName

string

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

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

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

tpuIpv4CidrBlock

string

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

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

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

Установите /netmask (например, /14), чтобы выбрать диапазон со специфической маской сети.

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

useIpAliases

boolean

Использовать ли alias IP-адреса для pod IP-адресов в кластере.

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

kubectlContext

string

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

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

kubectlPath

string

Путь для сохранения файла конфигурации kubectl.

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

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

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

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

labelFingerprint

string

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

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

legacyAbac

complex

Настройка для режима авторизации legacy ABAC.

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

enabled

boolean

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

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

location

string

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

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

locations

list / elements=string

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

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

loggingService

string

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

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

Если оставлено пустым, будет использоваться logging.googleapis.com.

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

masterAuth

complex

Информация об авторизации для доступа к мастер-точке.

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

clientCertificate

string

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

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

clientCertificateConfig

complex

Настройка аутентификации с использованием клиентского сертификата в кластере. Для кластеров до версии 1.12, если нет конфигурации, то будет выдан клиентский сертификат.

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

issueClientCertificate

boolean

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

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

clientKey

string

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

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

clusterCaCertificate

string

Корневой сертификат доверия для кластера в кодировке Base64.

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

password

string

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

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

username

string

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

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

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

Список аппаратных ускорителей, которые будут подключены к каждому узлу. Подробнее о поддержке графических процессоров см. на странице 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”: “ключ”, “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-standard-1). Если не указан, используется тип виртуальной машины по умолчанию n1-standard-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

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

Рекомендуются следующие области доступа, но они не являются обязательными и по умолчанию не включены: 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, которая будет использоваться виртуальными машинами узлов. Если учётная запись службы не указана, используется учётная запись службы «по умолчанию».

Возвращаемое значение: успех

shieldedInstanceConfig

complex

Параметры защищённого экземпляра.

Возвращаемое значение: успех

enableIntegrityMonitoring

boolean

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

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

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

Возвращаемое значение: успех

enableSecureBoot

boolean

Определяет, включена ли защита загрузки (Secure Boot) в экземпляре.

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

Возвращаемое значение: успех

END_OF_DOCUMENT_MARKER

метки

список / элементы=строка

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

Возвращаемое значение: success

пометки

сложная структура

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

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

Возвращаемое значение: success

эффект

строка

Эффект для метки.

Возвращаемое значение: success

ключ

строка

Ключ для метки.

Возвращаемое значение: success

значение

строка

Значение для метки.

Возвращаемое значение: success

размерNodeIpv4Cidr

целое число

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

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

Возвращаемое значение: success

пулы узлов

сложная структура

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

Возвращаемое значение: success

имя

строка

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

Возвращаемое значение: success

настройкиПриватногоКластера

сложная структура

Настройки для приватного кластера.

Возвращаемое значение: success

включитьПриватныйТочкуДоступа

логическое значение

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

Возвращаемое значение: success

включитьПриватныеУзлы

логическое значение

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

Возвращаемое значение: success

masterIpv4CidrBlock

строка

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

Возвращаемое значение: success

privateEndpoint

строка

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

Возвращаемое значение: success

publicEndpoint

строка

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

Возвращаемое значение: success

каналВыпуска

сложная структура

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

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

Возвращаемое значение: success

канал

строка

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

Возвращаемое значение: success

меткиРесурсов

словарь

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

Возвращаемое значение: success

servicesIpv4Cidr

строка

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

Возвращаемое значение: success

Защищенные узлы

сложная структура

Настройки защищенных узлов.

Возвращаемое значение: success

включено

логическое значение

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

Возвращаемое значение: success

статус

строка

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

Возвращено: success

сообщение_о_статусе

строка

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

Возвращено: success

подсеть

строка

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

Возвращено: success

tpuIpv4CidrBlock

строка

Диапазон IP-адресов Cloud TPUs в этом кластере в формате CIDR (например, `1.2.3.4/29`).

Возвращено: success

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекции

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходный код)

© 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_cluster_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API