gcp_container_node_pool_facts – Сбор фактов для GCP NodePool
Новое в версии 2.8.
Обзор
- Сбор фактов для GCP NodePool
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| cluster - / обязательно | Кластер, к которому принадлежит этот пул узлов. Это поле представляет собой ссылку на ресурс Cluster в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, можно добавить `register: name-of-resource` к задаче gcp_container_cluster, а затем установить это поле cluster в "{{ name-of-resource }}" | |
| location - / обязательно добавлено в 2.8 | Расположение, в котором развернут пул узлов. псевдонимы: region, zone | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи сервиса. Это не должно передаваться как словарь, а как строка с точным содержимым файла json учетной записи сервиса (валидный JSON) | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не установлены.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a node pool facts"
gcp_container_node_pool_facts:
cluster: "{{ cluster }}"
location: us-central1-a
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложный | всегда | Список элементов | |||
| autoscaling сложный | успех | Настройка автомасштабирования для этого NodePool. Автомасштабирование включено только в случае наличия корректной конфигурации. | |||
| enabled булево | успех | Включено ли автомасштабирование для этого пула узлов? | |||
| maxNodeCount целое число | успех | Максимальное количество узлов в NodePool. Должно быть >= minNodeCount. Для масштабирования кластера вверх должно быть достаточно квот. | |||
| minNodeCount целое число | успех | Минимальное количество узлов в NodePool. Должно быть >= 1 и <= maxNodeCount. | |||
| cluster словарь | успех | Кластер, к которому принадлежит этот пул узлов. | |||
| config сложный | успех | Настройка узлов пула. | |||
| diskSizeGb целое число | успех | Размер диска, подключенного к каждому узлу, указанный в ГБ. Минимальный разрешённый размер диска — 10 ГБ. Если не указано, используется значение по умолчанию — 100 ГБ. | |||
| imageType строка | успех | Тип образа, используемого для этого узла. Обратите внимание, что для данного типа образа будет использована последняя версия. | |||
| labels словарь | успех | Карта меток Kubernetes (пар ключ/значение), которые будут применяться к каждому узлу. Они будут добавлены дополнительно к любым меткам по умолчанию, которые Kubernetes может применить к узлу. В случае конфликта ключей меток применённый набор может отличаться в зависимости от версии Kubernetes — лучше предположить, что поведение не определено, и конфликтов следует избегать. Дополнительная информация, включая использование и допустимые значения, находится по адресу: http://kubernetes.io/v1.1/docs/user-guide/labels.html Объект, содержащий список пар «ключ»: значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }. | |||
| localSsdCount целое число | успех | Количество локальных дисков SSD, которые необходимо подключить к узлу. Предел для этого значения зависит от максимального количества дисков, доступных на машине в конкретной зоне. Подробности см. по адресу: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits. | |||
| machineType строка | успех | Имя типа виртуальной машины Google Compute Engine (например, n1-стандарт-1). Если не указано, используется тип виртуальной машины по умолчанию — n1-стандарт-1. | |||
| metadata словарь | успех | Ключи/значения метаданных, назначаемые экземплярам в кластере. Ключи должны соответствовать регулярному выражению [a-zA-Z0-9-_]+ и иметь длину менее 128 байт. Они отображаются как часть URL в сервере метаданных. Кроме того, для избежания неоднозначности ключи не должны совпадать с другими ключами метаданных для проекта или быть одним из четырёх зарезервированных ключей: «instance-template», «kube-env», «startup-script» и «user-data». Значения — произвольные строки, и их значение определяется только интерпретатором образа, работающего в экземпляре. Единственное ограничение заключается в том, что размер каждого значения должен быть меньше или равен 32 КБ. Суммарный размер всех ключей и значений должен быть меньше 512 КБ. Объект, содержащий список пар «ключ»: значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }. | |||
| oauthScopes список | успех | Набор облачных API-скопов Google, которые должны быть доступны на всех виртуальных машинах узлов под службой «по умолчанию». Рекомендуются следующие, но не обязательные, API-скопы, которые по умолчанию не включены: https://www.googleapis.com/auth/compute необходим для подключения постоянного хранилища к узлам.
https://www.googleapis.com/auth/devstorage.read_only необходим для связи с gcr.io (Google Container Registry). Если не указано, никакие API-скопы не добавляются, если не включены Cloud Logging или Cloud Monitoring, в этом случае будут добавлены их необходимые API-скопы. | |||
| preemptible булево | успех | Создаются ли узлы в виде преемлемых виртуальных машин. Подробности см. по адресу: https://cloud.google.com/compute/docs/instances/preemptible. | |||
| serviceAccount строка | успех | Учётная запись службы Google Cloud Platform, которая должна использоваться виртуальными машинами узлов. Если учётная запись службы не указана, используется учётная запись «по умолчанию». | |||
| tags список | успех | Список меток экземпляров, применяемых ко всем узлам. Метки используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом при создании кластера или пула узлов. Каждая метка в списке должна соответствовать RFC1035. | |||
| initialNodeCount целое число | успех | Начальное количество узлов для пула. Вам необходимо убедиться, что у вас достаточно квот ресурсов Compute Engine для этого количества экземпляров. Также необходимо иметь доступные квоты на брандмауэры и маршруты. | |||
| location строка | успех | Местоположение, где развернут пул узлов. | |||
| management сложный | успех | Настройка управления для этого NodePool. | |||
| autoRepair булево | успех | Флаг, указывающий, включено ли автоматическое восстановление узлов для пула узлов. При включении узлы в этом пуле узлов отслеживаются, и если они слишком часто не проходят проверки работоспособности, будет выполнено автоматическое действие по восстановлению. | |||
| autoUpgrade булево | успех | Флаг, указывающий, включено ли автоматическое обновление узлов для пула узлов. При включении автоматическое обновление узлов помогает поддерживать узлы в вашем пуле узлов в актуальном состоянии с последней релизной версией Kubernetes. | |||
| upgradeOptions сложный | успех | Определяет параметры автоматического обновления для пула узлов. | |||
| autoUpgradeStartTime строка | успех | Это поле устанавливается при начале обновлений с приблизительным начальным временем обновлений в формате RFC3339. | |||
| description строка | успех | Это поле устанавливается при начале обновлений с описанием обновления. | |||
| name строка | успех | Имя пула узлов. | |||
| version строка | успех | Версия Kubernetes этого узла. | |||
Статус
- От этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_container_node_pool_facts_module.html
