Spec-Zone.ru › AWS CLI v2

[ aws . eks ]

разрегистрировать-кластер

Описание

Разрегистрирует подключенный кластер, чтобы удалить его из управления Amazon EKS.

Подключенный кластер — это кластер Kubernetes, который вы подключили к своему контрольному узлу с помощью Amazon EKS Connector.

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

Синтаксис

  deregister-cluster
--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]

Параметры

--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
  • текст
  • таблица
  • 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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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 в Руководстве пользователя AWS CLI.

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

Для разрегистрации подключенного кластера, чтобы удалить его из управления Amazon EKS

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

aws eks deregister-cluster \
    --name my-eks-anywhere-cluster

Вывод:

{
    "cluster": {
        "name": "my-eks-anywhere-cluster",
        "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-anywhere-cluster",
        "createdAt": "2024-04-12T12:38:37.561000-04:00",
        "status": "DELETING",
        "tags": {},
        "connectorConfig": {
            "activationId": "dfb5ad28-13c3-4e26-8a19-5b2457638c74",
            "activationExpiry": "2024-04-15T12:38:37.082000-04:00",
            "provider": "EKS_ANYWHERE",
            "roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole"
        }
    }
}

Дополнительную информацию см. в разделе Разрегистрация кластера в Руководстве пользователя Amazon EKS.

Вывод

кластер -> (структура)

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

name -> (строка)

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

arn -> (строка)

Amazon Resource Name (ARN) кластера.

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

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

version -> (строка)

Версия сервера Kubernetes для кластера.

endpoint -> (строка)

Точка входа для вашего API-сервера Kubernetes.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей разрешения для управления Kubernetes вызывать API-операции Amazon Web Services от вашего имени.

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

Конфигурация VPC, используемая управляющей плоскостью кластера. Ресурсы VPC Amazon EKS имеют определённые требования для корректной работы с Kubernetes. Дополнительную информацию см. в разделе «Учетные соображения для VPC кластера» и «Учетные соображения для группы безопасности кластера» в руководстве пользователя Amazon EKS.

subnetIds -> (список)

Подсети, связанные с вашим кластером.

(строка)

securityGroupIds -> (список)

Группы безопасности, связанные с интерфейсами эластичной сети между учётными записями, используемыми для обеспечения связи между вашими узлами и управляющей плоскостью Kubernetes.

(строка)

clusterSecurityGroupId -> (строка)

Группа безопасности кластера, созданная Amazon EKS для кластера. Управляемые группы узлов используют эту группу безопасности для связи между управляющей и узловой плоскостями.

vpcId -> (строка)

VPC, связанная с вашим кластером.

endpointPublicAccess -> (булево)

Включён ли публичный API-сервер точки входа.

endpointPrivateAccess -> (булево)

Этот параметр указывает, включён ли частный API-сервер Amazon EKS. Если частная точка входа API-сервера Amazon EKS включена, запросы API Kubernetes, исходящие из VPC вашего кластера, используют частную точку входа VPC вместо прохождения через Интернет. Если данное значение выключено, и у вас есть узлы или под-Fargate в кластере, убедитесь, что publicAccessCidrs содержит необходимые блоки CIDR для связи с узлами или под-Fargate. Дополнительную информацию см. в разделе «Управление доступом к точке входа кластера Amazon EKS» в *руководстве пользователя Amazon EKS*.

publicAccessCidrs -> (список)

Блоки CIDR, которым разрешён доступ к публичной точке входа API-сервера Kubernetes вашего кластера.

(строка)

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

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

serviceIpv4Cidr -> (строка)

Блок CIDR, из которого Kubernetes Pod и Service получают IP-адреса объектов. Kubernetes назначает адреса из блока CIDR IPv4, назначенного подсети, в которой находится узел. Если при создании кластера вы не указали блок CIDR, Kubernetes назначает адреса из блоков CIDR 10.100.0.0/16 или 172.20.0.0/16. Если это было указано, то это было указано при создании кластера и изменить это нельзя.

serviceIpv6Cidr -> (строка)

Блок CIDR, из которого Kubernetes под и сервисные IP-адреса назначаются, если вы создали кластер версии 1.21 или новее с версией 1.10.1 или новее плагина Amazon VPC CNI и указали ipv6 для ipFamily при создании кластера. Kubernetes назначает адреса сервисов из диапазона адресов частных сетей (fc00::/7), поскольку вы не можете указать собственный блок CIDR IPv6 при создании кластера.

ipFamily -> (строка)

Семейство IP, используемое для назначения IP-адресов объектов Kubernetes Pod и Service. Семейство IP всегда ipv4, если у вас нет кластера версии 1.21 или более поздней, работающего с плагином Amazon VPC CNI для Kubernetes версии 1.10.1 или более поздней и при создании кластера было указано ipv6.

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

Указывает текущую конфигурацию возможности балансировки нагрузки в вашем кластере EKS Auto Mode. Например, включена или выключена ли возможность.

enabled -> (булево)

Указывает, включена ли возможность балансировки нагрузки в вашем кластере EKS Auto Mode. Если возможность балансировки нагрузки включена, EKS Auto Mode будет создавать и удалять балансировщики нагрузки в вашей учётной записи Amazon Web Services.

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

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

clusterLogging -> (список)

Конфигурация ведения журнала управляющей плоскости кластера для вашего кластера.

(структура)

Объект, представляющий включённые или выключенные журналы управляющей плоскости Kubernetes для вашего кластера.

types -> (список)

Доступные типы журналов управляющей плоскости кластера.

(строка)

enabled -> (булево)

Если тип журнала включен, этот тип журнала экспортирует журналы управляющей плоскости в CloudWatch Logs. Если тип журнала не включен, этот тип журнала не экспортирует журналы управляющей плоскости. Каждый отдельный тип журнала может быть включен или отключен независимо.

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

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

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

Объект, представляющий информацию об идентификаторе источника OpenID Connect.

issuer -> (строка)

URL издателя для идентификатора источника OIDC.

status -> (строка)

Текущий статус кластера.

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

certificate-authority-data для вашего кластера.

data -> (строка)

Данные сертификата в кодировке Base64, необходимые для связи с вашим кластером. Добавьте их в раздел certificate-authority-data файла kubeconfig для вашего кластера.

clientRequestToken -> (строка)

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

platformVersion -> (строка)

Версия платформы вашего кластера Amazon EKS. Дополнительную информацию о кластерах, развернутых в облаке Amazon Web Services, см. в разделе «Версии платформы» в руководстве пользователя Amazon EKS. Дополнительную информацию о локальных кластерах, развернутых на Outpost, см. в разделе «Версии платформы локальных кластеров Amazon EKS» в руководстве пользователя Amazon EKS.

tags -> (карта)

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

key -> (строка)

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

value -> (строка)

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

encryptionConfig -> (список)

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

(структура)

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

resources -> (список)

Указывает ресурсы, которые необходимо зашифровать. Единственное поддерживаемое значение — secrets.

(строка)

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

Ключ управления ключами (KMS). Можно использовать либо ARN, либо псевдоним.

keyArn -> (строка)

Amazon Resource Name (ARN) или псевдоним ключа KMS. Ключ KMS должен быть симметричным и создан в той же области Amazon Web Services, что и кластер. Если ключ KMS был создан в другой учётной записи, принципалу IAM необходимо иметь доступ к ключу KMS. Дополнительную информацию см. в разделе «Разрешение пользователям из других учётных записей использовать ключ KMS» в руководстве разработчика Key Management Service.

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

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

activationId -> (строка)

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

activationCode -> (строка)

Уникальный код, связанный с кластером для целей регистрации.

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

Срок действия подключённого кластера. Файл YAML кластера должен быть применён через собственный поставщик.

provider -> (строка)

Поставщик облачных служб кластера.

roleArn -> (строка)

Amazon Resource Name (ARN) роли для связи с сервисами из подключенного кластера Kubernetes.

id -> (строка)

Идентификатор вашего локального кластера Amazon EKS на Amazon Web Services Outpost. Это свойство недоступно для кластера Amazon EKS в облаке Amazon Web Services.

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

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

issues -> (список)

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

(структура)

Проблема с вашим кластером Amazon EKS.

code -> (строка)

Код ошибки проблемы.

message -> (строка)

Описание проблемы.

resourceIds -> (список)

Идентификаторы ресурсов, к которым относится проблема.

(строка)

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

Объект, представляющий конфигурацию вашего локального кластера Amazon EKS на Amazon Web Services Outpost. Этот объект недоступен для кластеров в облаке Amazon Web Services.

outpostArns -> (список)

ARN Outpost, который вы указали для использования с вашим локальным кластером Amazon EKS на Outposts.

(строка)

controlPlaneInstanceType -> (строка)

Тип экземпляра Amazon EC2, используемого для управляющей плоскости. Тип экземпляра одинаков для всех экземпляров управляющей плоскости.

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

Объект, представляющий конфигурацию размещения для всех экземпляров управляющей плоскости вашего локального кластера Amazon EKS на Amazon Web Services Outpost. Дополнительную информацию см. в разделе «Учетные соображения для ресурсов» в руководстве пользователя Amazon EKS.

groupName -> (строка)

Имя группы размещения для экземпляров управляющей плоскости Kubernetes.

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

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

bootstrapClusterCreatorAdminPermissions -> (булево)

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

authenticationMode -> (строка)

Текущий режим аутентификации кластера.

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

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

Узнайте больше о расширенной поддержке EKS в *руководстве пользователя Amazon EKS*.

supportType -> (строка)

Если для кластера установлено значение EXTENDED, он перейдет на расширенную поддержку в конце стандартной поддержки. Если для кластера установлено значение STANDARD, он будет автоматически обновлен в конце стандартной поддержки.

Узнайте больше о расширенной поддержке EKS в *руководстве пользователя Amazon EKS*.

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

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

enabled -> (boolean)

Включен ли зональный сдвиг.

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

Конфигурация в кластере для узлов EKS Hybrid. Вы можете добавить, изменить или удалить эту конфигурацию после создания кластера.

remoteNodeNetworks -> (список)

Список сетевых CIDR, которые могут содержать гибридные узлы.

(структура)

Сетевой CIDR, который может содержать гибридные узлы.

Эти блоки CIDR определяют ожидаемый диапазон IP-адресов гибридных узлов, которые присоединяются к кластеру. Эти блоки обычно определяются вашим системным администратором.

Введите один или несколько блоков IPv4 CIDR в десятичной точечной нотации (например, 10.2.0.0/16).

Он должен удовлетворять следующим требованиям:

  • Каждый блок должен находиться в диапазоне сети IPv4 RFC-1918. Минимальный допустимый размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются.
  • Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.
  • Каждый блок должен иметь маршрут к VPC, использующему блоки VPC CIDR, а не публичные IP-адреса или Elastic IP-адреса. Существует много вариантов, включая Transit Gateway, Site-to-Site VPN или Direct Connect.
  • Каждый хост должен разрешать исходящее соединение с контрольной плоскостью кластера EKS по TCP-портам 443 и 10250.
  • Каждый хост должен разрешать входящее соединение от контрольной плоскости кластера EKS по TCP-порту 10250 для операций логирования, exec и port-forward.
  • Каждый хост должен разрешать TCP и UDP сетевое соединение с другими хостами, на которых запущен CoreDNS, по UDP-порту 53 для имен служб и pod DNS.

cidrs -> (список)

Сетевой CIDR, который может содержать гибридные узлы.

Эти блоки CIDR определяют ожидаемый диапазон IP-адресов гибридных узлов, которые присоединяются к кластеру. Эти блоки обычно определяются вашим системным администратором.

Введите один или несколько блоков IPv4 CIDR в десятичной точечной нотации (например, 10.2.0.0/16).

Он должен удовлетворять следующим требованиям:

  • Каждый блок должен находиться в диапазоне сети IPv4 RFC-1918. Минимальный допустимый размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются.
  • Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.
  • Каждый блок должен иметь маршрут к VPC, использующему блоки VPC CIDR, а не публичные IP-адреса или Elastic IP-адреса. Существует много вариантов, включая Transit Gateway, Site-to-Site VPN или Direct Connect.
  • Каждый хост должен разрешать исходящее соединение с контрольной плоскостью кластера EKS по TCP-портам 443 и 10250.
  • Каждый хост должен разрешать входящее соединение от контрольной плоскости кластера EKS по TCP-порту 10250 для операций логирования, exec и port-forward.
  • Каждый хост должен разрешать TCP и UDP сетевое соединение с другими хостами, на которых запущен CoreDNS, по UDP-порту 53 для имен служб и pod DNS.

(строка)

remotePodNetworks -> (список)

Список сетевых CIDR, которые могут содержать pod, выполняющие Kubernetes webhooks на гибридных узлах.

(структура)

Сетевой CIDR, который может содержать pod, выполняющие Kubernetes webhooks на гибридных узлах.

Эти блоки CIDR определяются путем настройки вашего плагина Container Network Interface (CNI). Рекомендуется использовать Calico CNI или Cilium CNI. Обратите внимание, что плагин Amazon VPC CNI для Kubernetes недоступен для локальных и периферийных расположений.

Введите один или несколько блоков IPv4 CIDR в десятичной точечной нотации (например, 10.2.0.0/16).

Он должен удовлетворять следующим требованиям:

  • Каждый блок должен находиться в диапазоне сети IPv4 RFC-1918. Минимальный допустимый размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются.
  • Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.

cidrs -> (список)

Сетевой CIDR, который может содержать pod, выполняющие Kubernetes webhooks на гибридных узлах.

Эти блоки CIDR определяются путем настройки вашего плагина Container Network Interface (CNI). Рекомендуется использовать Calico CNI или Cilium CNI. Обратите внимание, что плагин Amazon VPC CNI для Kubernetes недоступен для локальных и периферийных расположений.

Введите один или несколько блоков IPv4 CIDR в десятичной точечной нотации (например, 10.2.0.0/16).

Он должен удовлетворять следующим требованиям:

  • Каждый блок должен находиться в диапазоне сети IPv4 RFC-1918. Минимальный допустимый размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются.
  • Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.

(строка)

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

Указывает текущую конфигурацию вычислительных возможностей вашего кластера EKS в режиме Auto Mode. Например, если эта возможность включена или выключена. Если вычислительные возможности включены, EKS Auto Mode будет создавать и удалять управляемые экземпляры EC2 в вашей учетной записи Amazon Web Services. Для получения дополнительной информации см. вычислительные возможности EKS Auto Mode в руководстве пользователя Amazon EKS.

enabled -> (boolean)

Указывает, включена ли вычислительная возможность в вашем кластере EKS в режиме Auto Mode. Если вычислительная возможность включена, EKS Auto Mode будет создавать и удалять управляемые экземпляры EC2 в вашей учетной записи Amazon Web Services.

nodePools -> (список)

Указывает текущую конфигурацию пулов узлов в вашем кластере EKS в режиме Auto Mode. Для получения дополнительной информации см. пулы узлов EKS Auto Mode в руководстве пользователя Amazon EKS.

(строка)

nodeRoleArn -> (строка)

ARN роли IAM, которую EKS назначит управляемым экземплярам EC2 в вашем кластере EKS в режиме Auto Mode.

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

Указывает текущую конфигурацию возможностей блочного хранения в вашем кластере EKS в режиме Auto Mode. Например, если возможность включена или выключена. Если возможность блочного хранения включена, EKS Auto Mode будет создавать и удалять тома EBS в вашей учетной записи Amazon Web Services. Для получения дополнительной информации см. возможность блочного хранения EKS Auto Mode в руководстве пользователя Amazon EKS.

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

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

enabled -> (boolean)

Указывает, включена ли возможность блочного хранения в вашем кластере EKS в режиме Auto Mode. Если возможность блочного хранения включена, EKS Auto Mode будет создавать и удалять тома EBS в вашей учетной записи Amazon Web Services.

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

Spec-Zone.ru

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