Spec-Zone.ru › AWS CLI v2

[ aws . eks ]

update-nodegroup-config

Описание

Обновляет конфигурацию управляемой группы узлов Amazon EKS. Ваша группа узлов продолжает функционировать во время обновления. В выходных данных ответа содержится идентификатор обновления, который можно использовать для отслеживания состояния обновления вашей группы узлов с помощью операции API ` DescribeUpdate https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html`__. Вы можете обновить метки и помеченные состояния Kubernetes для группы узлов, а также конфигурацию масштабирования и обновления версии.

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

Синтаксис

  update-nodegroup-config
--cluster-name <value>
--nodegroup-name <value>
[--labels <value>]
[--taints <value>]
[--scaling-config <value>]
[--update-config <value>]
[--node-repair-config <value>]
[--client-request-token <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 (строка)

Имя управляемой группы узлов для обновления.

--labels (структура)

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

addOrUpdateLabels -> (массив)

Метки Kubernetes для добавления или обновления.

key -> (строка)

value -> (строка)

removeLabels -> (список)

Метки Kubernetes для удаления.

(строка)

Сокращенный синтаксис:

addOrUpdateLabels={KeyName1=string,KeyName2=string},removeLabels=string,string

Синтаксис JSON:

{
  "addOrUpdateLabels": {"string": "string"
    ...},
  "removeLabels": ["string", ...]
}

--taints (структура)

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

addOrUpdateTaints -> (список)

Помеченные состояния Kubernetes для добавления или обновления.

(структура)

Свойство, которое позволяет узлу отталкивать помеченное состояние. Для получения дополнительной информации см. Пометки узлов в управляемых группах узлов в руководстве пользователя Amazon EKS.

key -> (строка)

Ключ помеченного состояния.

value -> (строка)

Значение помеченного состояния.

effect -> (строка)

Эффект помеченного состояния.

removeTaints -> (список)

Помеченные состояния Kubernetes для удаления.

(структура)

Свойство, которое позволяет узлу отталкивать помеченное состояние. Для получения дополнительной информации см. Пометки узлов в управляемых группах узлов в руководстве пользователя Amazon EKS.

key -> (строка)

Ключ помеченного состояния.

value -> (строка)

Значение помеченного состояния.

effect -> (строка)

Эффект помеченного состояния.

Сокращенный синтаксис:

addOrUpdateTaints=[{key=string,value=string,effect=string},{key=string,value=string,effect=string}],removeTaints=[{key=string,value=string,effect=string},{key=string,value=string,effect=string}]

Синтаксис JSON:

{
  "addOrUpdateTaints": [
    {
      "key": "string",
      "value": "string",
      "effect": "NO_SCHEDULE"|"NO_EXECUTE"|"PREFER_NO_SCHEDULE"
    }
    ...
  ],
  "removeTaints": [
    {
      "key": "string",
      "value": "string",
      "effect": "NO_SCHEDULE"|"NO_EXECUTE"|"PREFER_NO_SCHEDULE"
    }
    ...
  ]
}

--scaling-config (структура)

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

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.

Сокращенный синтаксис:

minSize=integer,maxSize=integer,desiredSize=integer

Синтаксис JSON:

{
  "minSize": integer,
  "maxSize": integer,
  "desiredSize": integer
}

--update-config (структура)

Конфигурация обновления группы узлов.

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

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

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

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

updateStrategy -> (строка)

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

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

Сокращенный синтаксис:

maxUnavailable=integer,maxUnavailablePercentage=integer,updateStrategy=string

Синтаксис JSON:

{
  "maxUnavailable": integer,
  "maxUnavailablePercentage": integer,
  "updateStrategy": "DEFAULT"|"MINIMAL"
}

--node-repair-config (структура)

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

enabled -> (булево)

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

Сокращенный синтаксис:

enabled=boolean

Синтаксис JSON:

{
  "enabled": true|false
}

--client-request-token (строка)

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

--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
  • table
  • yaml
  • yaml-stream

--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 V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставляющего двоичный блок fileb://, всегда будет рассматриваться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить вывод кли пагинатора.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Пример 1: Обновление управляемой группы узлов для добавления новых меток и пометок EKS-рабочего узла для кластера Amazon EKS

Следующий update-nodegroup-config пример обновляет управляемую группу узлов, добавляя новые метки и пометки к EKS-рабочему узлу для кластера Amazon EKS.

aws eks update-nodegroup-config \
    --cluster-name my-eks-cluster \
    --nodegroup-name my-eks-nodegroup \
    --labels 'addOrUpdateLabels={my-eks-nodegroup-label-1=value-1,my-eks-nodegroup-label-2=value-2}' \
    --taints 'addOrUpdateTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]'

Вывод:

{
    "update": {
        "id": "e66d21d3-bd8b-3ad1-a5aa-b196dc08c7c1",
        "status": "InProgress",
        "type": "ConfigUpdate",
        "params": [
            {
                "type": "LabelsToAdd",
                "value": "{\"my-eks-nodegroup-label-2\":\"value-2\",\"my-eks-nodegroup-label-1\":\"value-1\"}"
            },
            {
                "type": "TaintsToAdd",
                "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]"
            }
        ],
        "createdAt": "2024-04-08T12:05:19.161000-04:00",
        "errors": []
    }
}

Дополнительную информацию см. в разделе «Обновление управляемой группы узлов» в руководстве пользователя Amazon EKS.

Пример 2: Обновление управляемой группы узлов для удаления меток и пометок для узла EKS-рабочего узла для кластера Amazon EKS

Следующий update-nodegroup-config пример обновляет управляемую группу узлов, удаляя метки и пометки для узла EKS-рабочего узла для кластера Amazon EKS.

aws eks update-nodegroup-config \
    --cluster-name my-eks-cluster \
    --nodegroup-name my-eks-nodegroup \
    --labels 'removeLabels=my-eks-nodegroup-label-1, my-eks-nodegroup-label-2' \
    --taints 'removeTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]'

Вывод:

{
    "update": {
        "id": "67a08692-9e59-3ace-a916-13929f44cec3",
        "status": "InProgress",
        "type": "ConfigUpdate",
        "params": [
            {
                "type": "LabelsToRemove",
                "value": "[\"my-eks-nodegroup-label-1\",\"my-eks-nodegroup-label-2\"]"
            },
            {
                "type": "TaintsToRemove",
                "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]"
            }
        ],
        "createdAt": "2024-04-08T12:17:31.817000-04:00",
        "errors": []
    }
}

Дополнительную информацию см. в разделе «Обновление управляемой группы узлов» в руководстве пользователя Amazon EKS.

Пример 3: Обновление управляемой группы узлов для удаления и добавления меток и пометок для узла EKS-рабочего узла для кластера Amazon EKS

Следующий update-nodegroup-config пример обновляет управляемую группу узлов, удаляя и добавляя метки и пометки для узла EKS-рабочего узла для кластера Amazon EKS.

aws eks update-nodegroup-config \
    --cluster-name my-eks-cluster \
    --nodegroup-name my-eks-nodegroup \
    --labels 'addOrUpdateLabels={my-eks-nodegroup-new-label-1=new-value-1,my-eks-nodegroup-new-label-2=new-value-2},removeLabels=my-eks-nodegroup-label-1, my-eks-nodegroup-label-2' \
    --taints 'addOrUpdateTaints=[{key=taint-new-key-1,value=taint-new-value-1,effect=PREFER_NO_SCHEDULE}],removeTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]'

Вывод:

{
    "update": {
        "id": "4a9c8c45-6ac7-3115-be71-d6412a2339b7",
        "status": "InProgress",
        "type": "ConfigUpdate",
        "params": [
            {
                "type": "LabelsToAdd",
                "value": "{\"my-eks-nodegroup-new-label-1\":\"new-value-1\",\"my-eks-nodegroup-new-label-2\":\"new-value-2\"}"
            },
            {
                "type": "LabelsToRemove",
                "value": "[\"my-eks-nodegroup-label-1\",\"my-eks-nodegroup-label-2\"]"
            },
            {
                "type": "TaintsToAdd",
                "value": "[{\"effect\":\"PREFER_NO_SCHEDULE\",\"value\":\"taint-new-value-1\",\"key\":\"taint-new-key-1\"}]"
            },
            {
                "type": "TaintsToRemove",
                "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]"
            }
        ],
        "createdAt": "2024-04-08T12:30:55.486000-04:00",
        "errors": []
    }
}

Дополнительную информацию см. в разделе «Обновление управляемой группы узлов» в руководстве пользователя Amazon EKS.

Пример 4: Обновление управляемой группы узлов для обновления scaling-config и update-config для узла EKS-рабочего узла для кластера Amazon EKS

Следующий update-nodegroup-config пример обновляет управляемую группу узлов, обновляя scaling-config и update-config для узла EKS-рабочего узла для кластера Amazon EKS.

aws eks update-nodegroup-config \
    --cluster-name my-eks-cluster \
    --nodegroup-name my-eks-nodegroup \
    --scaling-config minSize=1,maxSize=5,desiredSize=2 \
    --update-config maxUnavailable=2

Вывод:

{
    "update": {
        "id": "a977160f-59bf-3023-805d-c9826e460aea",
        "status": "InProgress",
        "type": "ConfigUpdate",
        "params": [
            {
                "type": "MinSize",
                "value": "1"
            },
            {
                "type": "MaxSize",
                "value": "5"
            },
            {
                "type": "DesiredSize",
                "value": "2"
            },
            {
                "type": "MaxUnavailable",
                "value": "2"
            }
        ],
        "createdAt": "2024-04-08T12:35:17.036000-04:00",
        "errors": []
    }
}

Дополнительную информацию см. в разделе «Обновление управляемой группы узлов» в руководстве пользователя Amazon EKS.

Вывод

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

Объект, представляющий асинхронное обновление.

id -> (строка)

Уникальный идентификатор (UUID), используемый для отслеживания обновления.

status -> (строка)

Текущий статус обновления.

type -> (строка)

Тип обновления.

params -> (список)

Ключево-значное отображение, содержащее параметры, связанные с обновлением.

(структура)

Объект, представляющий подробности запроса на обновление.

type -> (строка)

Ключи, связанные с запросом на обновление.

value -> (строка)

Значение ключей, предоставленных в рамках запроса на обновление.

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

Маркер Unix-времени создания объекта.

errors -> (список)

Возможные ошибки, связанные с обновлением Failed.

(структура)

Объект, представляющий ошибку при сбое асинхронной операции.

errorCode -> (строка)

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

  • SubnetNotFound : Не удалось найти одну из подсетей, связанных с кластером.
  • SecurityGroupNotFound : Не удалось найти одну из групп безопасности, связанных с кластером.
  • EniLimitReached : Достигнуто ограничение на количество сетевых интерфейсов для вашей учетной записи.
  • IpNotAvailable : В подсети, связанной с кластером, отсутствуют свободные IP-адреса.
  • AccessDenied : У вас недостаточно разрешений для выполнения указанной операции.
  • OperationNotPermitted : У связанной с кластером роли сервиса отсутствуют необходимые разрешения для Amazon EKS.
  • VpcIdNotFound : Не удалось найти VPC, связанную с кластером.

errorMessage -> (строка)

Более подробное описание ошибки.

resourceIds -> (список)

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

(строка)

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

Spec-Zone.ru

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