Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_container_cluster_info – Сбор информации о кластере GCP

Примечание

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

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

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

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

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

Обзор

  • Сбор информации о кластере GCP

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

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

auth_kind

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

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

Варианты:

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

env_type

строка

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

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

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

location

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

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

Местоположение развертывания кластера.

project

строка

Проект Google Cloud Platform для использования.

scopes

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

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

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

Примечания

Примечание

  • для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
  • Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a cluster
  gcp_container_cluster_info:
    location: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ

Описание

resources

complex

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

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

addonsConfig

complex

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

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

horizontalPodAutoscaling

complex

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

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

disabled

boolean

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

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

httpLoadBalancing

complex

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

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

disabled

boolean

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

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

networkPolicyConfig

complex

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

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

disabled

boolean

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

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

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

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

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

currentNodeCount

integer

Количество узлов в настоящее время в кластере.

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

currentNodeVersion

string

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

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

databaseEncryption

complex

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

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

ключ

строка

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

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

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

состояние

строка

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

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

ограничение_по_умолчанию_на_максимальное_количество_под

сложное

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

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

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

maxPodsPerNode

строка

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

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

описание

строка

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

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

включитьKubernetesAlpha

логическое

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

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

включитьTpu

логическое

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

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

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

точка_доступа

строка

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

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

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

время_срабатывания

строка

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

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

начальная_версия_кластера

строка

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

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

начальное_количество_узлов

целое

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

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

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

политика_распределения_IP-адресов

сложное

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

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

диапазон_IP-адресов_кластера

строка

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

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

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

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

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

имя_вторичного_диапазона_кластера

строка

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

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

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

создать_подсеть

логическое

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

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

диапазон_IP-адресов_узлов

строка

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

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

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

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

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

servicesIpv4CidrBlock

string

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

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

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

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

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

servicesSecondaryRangeName

string

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

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

subnetworkName

string

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

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

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

tpuIpv4CidrBlock

string

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

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

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

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

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

useIpAliases

boolean

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

Возвращается: 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

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

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

clientCertificate

string

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

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

clientCertificateConfig

complex

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

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

issueClientCertificate

boolean

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

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

clientKey

string

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

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

clusterCaCertificate

string

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

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

password

string

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

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

username

string

Имя пользователя для использования HTTP-авторизации по методу basic authentication для конечной точки master.

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

masterAuthorizedNetworksConfig

complex

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

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

cidrBlocks

complex

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

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

cidrBlock

string

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

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

displayName

string

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

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

enabled

boolean

Включена ли авторизация сетей master.

Возвращено: 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 по умолчанию в узлах кластера. Правила sNAT в узлах будут отключены, когда defaultSnatStatus отключен.

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

enableIntraNodeVisibility

boolean

Включена ли видимость внутри узла для этого кластера. Это делает трафик pod-to-pod на одном узле видимым для сети 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

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

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

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

oauthScopes

list / elements=string

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

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

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

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

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

preemptible

boolean

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

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

serviceAccount

string

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

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

shieldedInstanceConfig

complex

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

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

enableIntegrityMonitoring

boolean

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

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

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

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

enableSecureBoot

boolean

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

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

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

tags

list / elements=string

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

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

taints

complex

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

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

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

effect

string

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

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

key

string

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

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

value

string

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

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

nodeIpv4CidrSize

integer

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

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

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

nodePools

complex

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

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

name

string

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

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

privateClusterConfig

complex

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

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

enablePrivateEndpoint

boolean

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

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

enablePrivateNodes

boolean

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

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

masterIpv4CidrBlock

string

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

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

privateEndpoint

string

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

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

publicEndpoint

string

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

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

releaseChannel

complex

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

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

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

channel

string

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

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

resourceLabels

dictionary

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

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

servicesIpv4Cidr

string

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

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

shieldedNodes

complex

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

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

enabled

boolean

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

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

status

string

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

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

statusMessage

string

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

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

subnetwork

string

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

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

tpuIpv4CidrBlock

string

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

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

Авторы

  • 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_info_module.html

Spec-Zone.ru

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