Spec-Zone.ru › AWS CLI v2

[ aws . eks ]

describe-nodegroup

Описание

Описывает управляемую группу узлов.

См. также: Документация API AWS

Синтаксис

  describe-nodegroup
--cluster-name <value>
--nodegroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--cluster-name (строка)

Имя вашего кластера.

--nodegroup-name (строка)

Имя группы узлов, которую требуется описать.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример ввода YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладовую регистрацию.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

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

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла аутентификационных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 предполагает, что двоичные блоки предоставляются как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страниц CLI.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Описать управляемую группу узлов для кластера Amazon EKS

Следующий describe-nodegroup пример описывает управляемую группу узлов для кластера Amazon EKS.

aws eks describe-nodegroup \
    --cluster-name my-eks-cluster \
    --nodegroup-name my-eks-nodegroup

Вывод:

{
    "nodegroup": {
        "nodegroupName": "my-eks-nodegroup",
        "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/a8c75f2f-df78-a72f-4063-4b69af3de5b1",
        "clusterName": "my-eks-cluster",
        "version": "1.26",
        "releaseVersion": "1.26.12-20240329",
        "createdAt": "2024-04-08T11:42:10.555000-04:00",
        "modifiedAt": "2024-04-08T11:44:12.402000-04:00",
        "status": "ACTIVE",
        "capacityType": "ON_DEMAND",
        "scalingConfig": {
            "minSize": 1,
            "maxSize": 3,
            "desiredSize": 1
        },
        "instanceTypes": [
            "t3.medium"
        ],
        "subnets": [
            "subnet-0e2907431c9988b72",
            "subnet-04ad87f71c6e5ab4d",
            "subnet-09d912bb63ef21b9a"
        ],
        "amiType": "AL2_x86_64",
        "nodeRole": "arn:aws:iam::111122223333:role/role-name",
        "labels": {},
        "resources": {
            "autoScalingGroups": [
                {
                    "name": "eks-my-eks-nodegroup-a8c75f2f-df78-a72f-4063-4b69af3de5b1"
                }
            ]
        },
        "diskSize": 20,
        "health": {
            "issues": []
        },
        "updateConfig": {
            "maxUnavailable": 1
        },
        "tags": {}
    }
}

Вывод

nodegroup -> (структура)

Полное описание вашей группы узлов.

nodegroupName -> (строка)

Имя, связанное с управляемой группой узлов Amazon EKS.

nodegroupArn -> (строка)

Amazon Resource Name (ARN), связанный с управляемой группой узлов.

clusterName -> (строка)

Имя вашего кластера.

version -> (строка)

Версия Kubernetes управляемой группы узлов.

releaseVersion -> (строка)

Если группа узлов была развернута с помощью шаблона запуска с пользовательским образом AMI, это идентификатор AMI, указанный в шаблоне запуска. Для групп узлов, которые не были развернуты с помощью шаблона запуска, это версия оптимизированного для Amazon EKS образа AMI, с которой была развернута группа узлов.

createdAt -> (временная метка)

Временная метка Unix эпохи при создании объекта.

modifiedAt -> (временная метка)

Временная метка Unix эпохи для последнего изменения объекта.

status -> (строка)

Текущий статус управляемой группы узлов.

capacityType -> (строка)

Тип емкости вашей управляемой группы узлов.

scalingConfig -> (структура)

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

minSize -> (целое число)

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

maxSize -> (целое число)

Максимальное количество узлов, до которого может масштабироваться управляемая группа узлов. Сведения о максимальном значении, которое можно указать, см. в разделе Квоты служб Amazon EKS в Руководстве пользователя Amazon EKS.

desiredSize -> (целое число)

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

Предупреждение

Если вы используете Kubernetes Cluster Autoscaler, не изменяйте значение desiredSize напрямую, так как это может привести к внезапному увеличению или уменьшению масштаба Cluster Autoscaler.

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

Этот параметр может отличаться от minSize в некоторых случаях, например, при запуске с дополнительными хостами для тестирования. Этот параметр также может отличаться, когда вы хотите начать с примерного количества необходимых хостов, но позволить Cluster Autoscaler уменьшить количество, если их слишком много. Когда используется Cluster Autoscaler, параметр desiredSize изменяется Cluster Autoscaler (но может быть неактуальным в течение коротких периодов времени). Cluster Autoscaler не масштабирует управляемую группу узлов ниже minSize или выше maxSize.

instanceTypes -> (список)

Если группа узлов не была развернута с помощью шаблона запуска, это тип экземпляра, связанный с группой узлов. Если группа узлов была развернута с помощью шаблона запуска, это null.

(строка)

subnets -> (список)

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

(строка)

remoteAccess -> (структура)

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

ec2SshKey -> (строка)

Имя ключа SSH Amazon EC2, обеспечивающее доступ для SSH-соединения с узлами в управляемой группе узлов. Дополнительные сведения см. в разделе Amazon EC2 ключи и Linux-экземпляры в Руководстве пользователя Amazon Elastic Compute Cloud для Linux-экземпляров. Для Windows используется ключ Amazon EC2 SSH для получения пароля RDP. Дополнительные сведения см. в разделе Amazon EC2 ключи и Windows-экземпляры в Руководстве пользователя Amazon Elastic Compute Cloud для Windows-экземпляров.

sourceSecurityGroups -> (список)

Идентификаторы групп безопасности, которым разрешен SSH-доступ (порт 22) к узлам. Для Windows порт составляет 3389. Если вы указываете ключ Amazon EC2 SSH, но не указываете группу безопасности источника при создании управляемой группы узлов, порт на узлах открыт для интернета (0.0.0.0/0). Дополнительные сведения см. в разделе Группы безопасности вашей VPC в Руководстве пользователя Amazon Virtual Private Cloud.

(строка)

amiType -> (строка)

Если группа узлов была развернута с помощью шаблона запуска с пользовательским AMI, это CUSTOM. Для групп узлов, которые не были развернуты с помощью шаблона запуска, это тип AMI, указанный в конфигурации группы узлов.

nodeRole -> (строка)

Роль IAM, связанная с вашей группой узлов. Демон узла Amazon EKS kubelet выполняет вызовы API Amazon Web Services от вашего имени. Узлы получают разрешения на эти вызовы API через профиль экземпляра IAM и связанные политики.

labels -> (отображение)

Kubernetes labels, применённые к узлам в группе узлов.

Примечание

Здесь отображаются только labels, применённые с помощью API Amazon EKS. Возможны другие Kubernetes labels, применённые к узлам в этой группе.

ключ -> (строка)

значение -> (строка)

taints -> (список)

Меток Kubernetes, которые необходимо применить к узлам в группе узлов при их создании. Эффект — один из No_Schedule, Prefer_No_Schedule или No_Execute. Меток Kubernetes можно использовать совместно с допусками, чтобы управлять тем, как рабочие нагрузки планируются на ваших узлах. Дополнительные сведения см. в разделе Меток узлов в управляемых группах узлов.

(структура)

Свойство, которое позволяет узлу отражать Pod. Дополнительные сведения см. в разделе Меток узлов в управляемых группах узлов в Руководстве пользователя Amazon EKS.

ключ -> (строка)

Ключ метки.

значение -> (строка)

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

эффект -> (строка)

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

resources -> (структура)

Ресурсы, связанные с группой узлов, такие как группы автоматического масштабирования и группы безопасности для удалённого доступа.

autoScalingGroups -> (список)

Группы автоматического масштабирования, связанные с группой узлов.

(структура)

Группа автоматического масштабирования, связанная с управляемой группой узлов Amazon EKS.

name -> (строка)

Имя группы автоматического масштабирования, связанной с управляемой группой узлов Amazon EKS.

remoteAccessSecurityGroup -> (строка)

Группа безопасности удалённого доступа, связанная с группой узлов. Эта группа безопасности управляет SSH-доступом к узлам.

diskSize -> (целое число)

Если группа узлов не была развернута с помощью шаблона запуска, это размер диска в конфигурации группы узлов. Если группа узлов была развернута с помощью шаблона запуска, это null.

health -> (структура)

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

issues -> (список)

Возможные проблемы, связанные с группой узлов.

(структура)

Объект, представляющий проблему с ресурсом Amazon EKS.

code -> (строка)

Краткое описание ошибки.

  • AccessDenied : Amazon EKS или один или несколько ваших управляемых узлов не могут пройти проверку подлинности или авторизацию с сервером API вашего кластера Kubernetes.
  • AsgInstanceLaunchFailures : В вашей группе автоматического масштабирования возникают ошибки при попытке запуска экземпляров.
  • AutoScalingGroupNotFound : Мы не смогли найти группу автоматического масштабирования, связанную с управляемой группой узлов. Вы можете попытаться воссоздать группу автоматического масштабирования с теми же настройками для восстановления.
  • ClusterUnreachable : Amazon EKS или один или несколько ваших управляемых узлов не могут связаться с сервером API вашего кластера Kubernetes. Это может произойти из-за сетевых сбоев или если серверы API не успевают обрабатывать запросы.
  • Ec2InstanceTypeDoesNotExist : Один или несколько указанных типов экземпляров Amazon EC2 не существуют. Amazon EKS проверил указанные вами типы экземпляров в этой области Amazon Web Services, и один или несколько из них недоступны.
  • Ec2LaunchTemplateNotFound : Мы не смогли найти шаблон запуска Amazon EC2 для вашей управляемой группы узлов. Вы можете попытаться воссоздать шаблон запуска с теми же настройками для восстановления.
  • Ec2LaunchTemplateVersionMismatch : Версия шаблона запуска Amazon EC2 для вашей управляемой группы узлов не соответствует версии, созданной Amazon EKS. Вы можете попытаться вернуться к версии, созданной Amazon EKS, для восстановления.
  • Ec2SecurityGroupDeletionFailure : Мы не смогли удалить группу безопасности удалённого доступа для вашей управляемой группы узлов. Удалите все зависимости от группы безопасности.
  • Ec2SecurityGroupNotFound : Мы не смогли найти группу безопасности кластера для кластера. Вы должны воссоздать свой кластер.
  • Ec2SubnetInvalidConfiguration : Одна или несколько указанных подсетей Amazon EC2 для группы узлов не автоматически назначают общедоступные IP-адреса экземплярам, запущенным в них. Если вы хотите, чтобы вашим экземплярам был назначен общедоступный IP-адрес, вам необходимо включить параметр auto-assign public IP address для подсети. См. Изменение атрибута адресации ``IPv4`` вашей подсети <https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip>`__ в Руководстве пользователя Amazon VPC.
  • IamInstanceProfileNotFound : Мы не смогли найти профиль экземпляра IAM для вашей управляемой группы узлов. Вы можете попытаться воссоздать профиль экземпляра с теми же настройками для восстановления.
  • IamNodeRoleNotFound : Мы не смогли найти роль IAM для вашей управляемой группы узлов. Вы можете попытаться воссоздать роль IAM с теми же настройками для восстановления.
  • InstanceLimitExceeded : Ваш счёт Amazon Web Services не может запустить больше экземпляров указанного типа экземпляра. Вы можете попытаться запросить увеличение предела экземпляров Amazon EC2 для восстановления.
  • InsufficientFreeAddresses : В одной или нескольких подсетях, связанных с вашей управляемой группой узлов, нет достаточного количества доступных IP-адресов для новых узлов.
  • InternalFailure : Эти ошибки обычно вызываются проблемой на стороне сервера Amazon EKS.
  • NodeCreationFailure : Запущенные экземпляры не могут зарегистрироваться в вашем кластере Amazon EKS. Распространёнными причинами этой ошибки являются недостаточные разрешения роли IAM узла или отсутствие внешнего доступа к интернету для узлов.

message -> (строка)

Сообщение об ошибке, связанное с проблемой.

resourceIds -> (список)

Ресурсы Amazon Web Services, которые затрагиваются этой проблемой.

(строка)

updateConfig -> (структура)

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

maxUnavailable -> (целое число)

Максимальное количество узлов, недоступных одновременно во время обновления версии. Узлы обновляются параллельно. Это значение или maxUnavailablePercentage должно иметь значение. Максимальное значение — 100.

maxUnavailablePercentage -> (целое число)

Максимальный процент узлов, недоступных во время обновления версии. Этот процент узлов обновляется параллельно, до 100 узлов одновременно. Это значение или maxUnavailable должно иметь значение.

updateStrategy -> (строка)

Настройка поведения во время обновления версии группы узлов этого управляемого узла. Вы выбираете одну из двух возможных стратегий для замены узлов во время действия ` UpdateNodegroupVersion https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html`__.

Управляемая группа узлов Amazon EKS обновляется путем параллельной замены узлов на новые узлы с более новыми версиями AMI. Стратегия обновления изменяет поведение обновления управляемых узлов управляемой группы узлов для каждого количества. Стратегия по умолчанию имеет ограничения, чтобы защитить вас от неправильной конфигурации, и запускает новые экземпляры сначала, прежде чем завершать работу старых экземпляров. Минимальная стратегия удаляет ограничения и завершает работу старых экземпляров перед запуском новых экземпляров. Эта минимальная стратегия полезна в сценариях, когда вы ограничены ресурсами или затратами (например, с аппаратными ускорителями, такими как GPU).

nodeRepairConfig -> (структура)

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

enabled -> (булево)

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

launchTemplate -> (структура)

Если для создания группы узлов использовалась шаблон запуска, то это шаблон запуска, который был использован.

name -> (строка)

Имя шаблона запуска.

Вы должны указать либо имя шаблона запуска, либо идентификатор шаблона запуска в запросе, но не оба. После создания группы узлов вы не можете использовать другое имя.

version -> (строка)

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

id -> (строка)

Идентификатор шаблона запуска.

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

tags -> (карта)

Метаданные, которые помогают с категоризацией и организацией. Каждый тег состоит из ключа и необязательного значения. Вы определяете оба. Теги не распространяются на другие кластеры или ресурсы Amazon Web Services.

key -> (строка)

Одна часть пары ключ-значение, составляющей тег. Ключ — это общее метка, которая действует как категория для более конкретных значений тегов.

value -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. Значение действует как описатель в категории тегов (ключ).

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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