gcp_container_node_pool_info – Сбор информации о GCP NodePool
Новая в версии 2.8.
Обзор
- Сбор информации о GCP NodePool
- Этот модуль назывался
gcp_container_node_pool_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_container_node_pool_facts
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| cluster словарь / обязательно | Кластер, к которому относится этот пул узлов. Это поле представляет собой ссылку на ресурс Cluster в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` в задачу gcp_container_cluster, а затем установить это поле cluster в "{{ имя-ресурса }}" | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | |
| location строка / обязательно добавлено в 2.8 | Расположение, где развернут пул узлов. псевдонимы: регион, зона | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: get info on a node pool
gcp_container_node_pool_info:
cluster: "{{ cluster }}"
location: us-central1-a
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | |||
| autoscaling complex | успешно | Настройка автомасштабирования для данного NodePool. Автомасштабирование включено только в случае наличия действительной конфигурации. | |||
| enabled boolean | успешно | Включено ли автомасштабирование для этого пула узлов. | |||
| maxNodeCount integer | успешно | Максимальное количество узлов в NodePool. Должно быть больше или равно minNodeCount. Должно быть достаточно квоты для увеличения размера кластера. | |||
| minNodeCount integer | успешно | Минимальное количество узлов в NodePool. Должно быть больше или равно 1 и меньше или равно maxNodeCount. | |||
| cluster dictionary | успешно | Кластер, к которому принадлежит этот пул узлов. | |||
| conditions complex | успешно | Условия, которые привели к текущему состоянию пула узлов. | |||
| code string | успешно | Представление условия в удобном для машины формате. | |||
| config complex | успешно | Конфигурация узлов пула. | |||
| accelerators complex | успешно | Список аппаратных ускорителей, которые будут подключены к каждому узлу. | |||
| acceleratorCount integer | успешно | Количество карт ускорителей, подключенных к экземпляру. | |||
| 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-стандарт-1). Если не указано, используется тип машины по умолчанию n1-стандарт-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 | успешно | Набор облачных 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 для получения дополнительной информации о предварительно прерываемых виртуальных машинах. | |||
| serviceAccount string | успешно | Учётная запись службы Google Cloud Platform, которую следует использовать для виртуальных машин узлов. Если учётная запись службы не указана, используется учётная запись "по умолчанию". | |||
| tags list | успешно | Список меток экземпляров, применяемых ко всем узлам. Метки используются для определения допустимых источников или целей для сетевых брандмауэров и задаются клиентом при создании кластера или пула узлов. Каждая метка в списке должна соответствовать RFC1035. | |||
| taints complex | успешно | Список меток Kubernetes, которые следует применить к каждому узлу. | |||
| effect string | успешно | Эффект метки. | |||
| key string | успешно | Ключ метки. | |||
| value string | успешно | Значение метки. | |||
| initialNodeCount integer | success | Начальное количество узлов для пула. Вы должны убедиться, что квота вашего ресурса Compute Engine достаточна для этого количества экземпляров. Вам также должны быть доступны квоты на брандмауэр и маршруты. | |||
| location string | success | Расположение, где развернут пул узлов. | |||
| management complex | success | Настройка управления для этого NodePool. | |||
| autoRepair boolean | success | Флаг, указывающий, включено ли автоматическое исправление узлов для пула узлов. При включении узлы в этом пуле будут отслеживаться, и если они не пройдут проверки состояния слишком много раз, будет выполнено автоматическое действие по восстановлению. | |||
| autoUpgrade boolean | success | Флаг, указывающий, включено ли автоматическое обновление узлов для пула узлов. Если включено, автоматическое обновление узлов помогает поддерживать узлы в вашем пуле узлов в актуальном состоянии с последней релизной версией Kubernetes. | |||
| upgradeOptions complex | success | Указывает элементы управления автоматическим обновлением для пула узлов. | |||
| autoUpgradeStartTime string | success | Это поле устанавливается при начале обновлений с приблизительным временем начала обновлений в формате RFC3339. | |||
| description string | success | Это поле устанавливается при начале обновлений с описанием обновления. | |||
| maxPodsConstraint complex | success | Ограничение на максимальное количество подкастов, которые могут выполняться одновременно на узле в пуле узлов. | |||
| maxPodsPerNode integer | success | Ограничение, наложенное на максимальное количество подкастов на узел. | |||
| name string | success | Название пула узлов. | |||
| podIpv4CidrSize integer | success | Размер блока CIDR подкастов на узел в этом пуле узлов. | |||
| status string | success | Состояние узлов в этом экземпляре пула. | |||
| statusMessage string | success | Дополнительная информация о текущем состоянии этого экземпляра пула узлов. | |||
| version string | success | Версия Kubernetes этого узла. | |||
Состояние
- Этому модулю не гарантируется обратная совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_container_node_pool_info_module.html
