register-cluster
Описание
Подключает кластер Kubernetes к управляющей плоскости Amazon EKS.
Любой кластер Kubernetes может быть подключён к управляющей плоскости Amazon EKS для просмотра текущей информации о кластере и его узлах.
Подключение к кластеру требует двух шагов. Во-первых, отправьте ` RegisterClusterRequest https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html`__ для добавления его в управляющую плоскость Amazon EKS.
Во-вторых, необходимо применить манифест, содержащий activationID и activationCode, к кластеру Kubernetes через его собственный поставщик для обеспечения видимости.
После обновления и применения манифеста подключённый кластер станет видимым для управляющей плоскости Amazon EKS. Если манифест не будет применён в течение трёх дней, подключённый кластер перестанет быть видимым и его необходимо будет дерегистрировать, используя DeregisterCluster .
См. также: Документация по API AWS
Синтаксис
register-cluster
--name <value>
--connector-config <value>
[--client-request-token <value>]
[--tags <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 (строка)
--connector-config (структура)
Настройки конфигурации, необходимые для подключения кластера Kubernetes к управляющей плоскости Amazon EKS.
roleArn -> (строка)
provider -> (строка)
Сокращённый синтаксис:
roleArn=string,provider=string
Синтаксис JSON:
{
"roleArn": "string",
"provider": "EKS_ANYWHERE"|"ANTHOS"|"GKE"|"AKS"|"OPENSHIFT"|"TANZU"|"RANCHER"|"EC2"|"OTHER"
}
--client-request-token (строка)
--tags (массив)
Метаданные, которые помогают с категоризацией и организацией. Каждый тег состоит из ключа и необязательного значения. Вы определяете оба. Теги не распространяются на другие кластеры или ресурсы Amazon Web Services.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--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 (строка)
Включает/отключает цветной вывод.
- on
- off
- auto
--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.
Если не указано иное, все примеры используют правила цитирования по типу Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.
Пример 1: Регистрация внешнего кластера Kubernetes EKS_ANYWHERE в Amazon EKS
Следующий register-cluster пример регистрирует внешний кластер Kubernetes EKS_ANYWHERE в Amazon EKS.
aws eks register-cluster \
--name my-eks-anywhere-cluster \
--connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=EKS_ANYWHERE'
Вывод:
{
"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": "PENDING",
"tags": {},
"connectorConfig": {
"activationId": "xxxxxxxxACTIVATION_IDxxxxxxxx",
"activationCode": "xxxxxxxxACTIVATION_CODExxxxxxxx",
"activationExpiry": "2024-04-15T12:38:37.082000-04:00",
"provider": "EKS_ANYWHERE",
"roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole"
}
}
}
Для получения более подробной информации, обратитесь к разделу Подключение внешнего кластера в руководстве пользователя Amazon EKS.
Пример 2: Регистрация любого внешнего кластера Kubernetes в Amazon EKS
Следующий register-cluster пример регистрирует внешний кластер Kubernetes EKS_ANYWHERE в Amazon EKS.
aws eks register-cluster \
--name my-eks-anywhere-cluster \
--connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=OTHER'
Вывод:
{
"cluster": {
"name": "my-onprem-k8s-cluster",
"arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-onprem-k8s-cluster",
"createdAt": "2024-04-12T12:42:10.861000-04:00",
"status": "PENDING",
"tags": {},
"connectorConfig": {
"activationId": "xxxxxxxxACTIVATION_IDxxxxxxxx",
"activationCode": "xxxxxxxxACTIVATION_CODExxxxxxxx",
"activationExpiry": "2024-04-15T12:42:10.339000-04:00",
"provider": "OTHER",
"roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole"
}
}
}
Для получения более подробной информации, обратитесь к разделу Подключение внешнего кластера в руководстве пользователя Amazon EKS.
Вывод
кластер -> (структура)
Объект, представляющий кластер Amazon EKS.
name -> (строка)
arn -> (строка)
createdAt -> (временная метка)
version -> (строка)
endpoint -> (строка)
roleArn -> (строка)
resourcesVpcConfig -> (структура)
Конфигурация VPC, используемая контрольной плоскостью кластера. Ресурсы VPC Amazon EKS имеют определённые требования для корректной работы с Kubernetes. Для получения дополнительной информации см. Раздел «Учет VPC кластера» и «Учет группы безопасности кластера» в руководстве пользователя Amazon EKS.
subnetIds -> (список)
Подсети, связанные с вашим кластером.
(строка)
securityGroupIds -> (список)
Группы безопасности, связанные с интерфейсами эластичной сети между аккаунтами, которые используются для обеспечения связи между вашими узлами и контрольной плоскостью Kubernetes.
(строка)
clusterSecurityGroupId -> (строка)
vpcId -> (строка)
endpointPublicAccess -> (булево)
endpointPrivateAccess -> (булево)
publicAccessCidrs включает необходимые блоки CIDR для связи с узлами или контейнерами Fargate. Дополнительную информацию см. в разделе «Управление доступом к конечным точкам кластера Amazon EKS» в *руководстве пользователя Amazon EKS*.publicAccessCidrs -> (список)
Блоки CIDR, которым разрешен доступ к вашему публичному конечному пункту сервера API Kubernetes кластера.
(строка)
kubernetesNetworkConfig -> (структура)
Конфигурация сети Kubernetes для кластера.
serviceIpv4Cidr -> (строка)
Pod и Service объектам присваиваются IP-адреса. Kubernetes присваивает адреса из блока CIDR IPv4, назначенного подсети, в которой находится узел. Если вы не указали блок CIDR при создании кластера, Kubernetes присваивает адреса из блоков CIDR 10.100.0.0/16 или 172.20.0.0/16. Если это было указано, то это было указано при создании кластера и изменить его нельзя.serviceIpv6Cidr -> (строка)
ipv6 для ipFamily при создании кластера. Kubernetes назначает адреса сервисов из уникального диапазона локальных адресов (fc00::/7), так как вы не можете указать собственный блок IPv6 CIDR при создании кластера.ipFamily -> (строка)
Pod и Service объектам IP-адресов. Семейство IP всегда ipv4, если у вас нет кластера 1.21 или более поздней версии, работающей с версией 1.10.1 или более поздней версии плагина Amazon VPC CNI для Kubernetes и указанного ipv6 при создании кластера.elasticLoadBalancing -> (структура)
Указывает текущую конфигурацию возможности балансировки нагрузки в вашем кластере EKS в режиме Автоматический. Например, включена или выключена ли эта возможность.
enabled -> (булево)
logging -> (структура)
Конфигурация ведения журналов для вашего кластера.
clusterLogging -> (список)
Конфигурация ведения журналов контрольной плоскости кластера для вашего кластера.
(структура)
Объект, представляющий включенные или выключенные журналы контрольной плоскости Kubernetes для вашего кластера.
types -> (список)
Доступные типы журналов контрольной плоскости кластера.
(строка)
enabled -> (булево)
identity -> (структура)
Информация о поставщике идентификации для кластера.
oidc -> (структура)
Объект, представляющий информацию о поставщике идентификации OpenID Connect.
issuer -> (строка)
status -> (строка)
certificateAuthority -> (структура)
certificate-authority-data для вашего кластера.
data -> (строка)
certificate-authority-data файла kubeconfig для вашего кластера.clientRequestToken -> (строка)
platformVersion -> (строка)
tags -> (карта)
Метаданные, которые помогают с категоризацией и организацией. Каждый тег состоит из ключа и необязательного значения. Вы определяете оба. Теги не распространяются на другие кластеры или ресурсы Amazon Web Services.
key -> (строка)
key - это общее обозначение, которое действует как категория для более конкретных значений тегов.value -> (строка)
value действует как описание в категории тегов (ключ).encryptionConfig -> (список)
Конфигурация шифрования для кластера.
(структура)
Конфигурация шифрования для кластера.
resources -> (список)
Указывает ресурсы, которые должны быть зашифрованы. Поддерживается только значение secrets.
(строка)
provider -> (структура)
Ключ управления ключами (KMS). Можно использовать либо ARN, либо псевдоним.
keyArn -> (строка)
connectorConfig -> (структура)
Конфигурация, используемая для подключения к кластеру для регистрации.
activationId -> (строка)
activationCode -> (строка)
activationExpiry -> (временная метка)
provider -> (строка)
roleArn -> (строка)
id -> (строка)
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 -> (строка)
controlPlanePlacement -> (структура)
Объект, представляющий конфигурацию размещения для всех экземпляров контрольной плоскости вашего локального кластера Amazon EKS на Amazon Web Services Outpost. Дополнительную информацию см. в разделе «Учет ресурсов» в *руководстве пользователя Amazon EKS*.
groupName -> (строка)
accessConfig -> (структура)
Конфигурация доступа к кластеру.
bootstrapClusterCreatorAdminPermissions -> (булево)
authenticationMode -> (строка)
upgradePolicy -> (структура)
Это значение указывает, включена или выключена расширенная поддержка для кластера.
supportType -> (строка)
Если кластер настроен на EXTENDED, он перейдет в расширенную поддержку в конце стандартной поддержки. Если кластер настроен на STANDARD, он будет автоматически обновлен по завершении стандартной поддержки.
zonalShiftConfig -> (структура)
Конфигурация смещения зоны для кластера.
enabled -> (boolean)
remoteNetworkConfig -> (структура)
Конфигурация в кластере для узлов EKS Hybrid. Вы можете добавить, изменить или удалить эту конфигурацию после создания кластера.
remoteNodeNetworks -> (список)
Список сетевых CIDR, которые могут содержать гибридные узлы.
(структура)
Сетевой CIDR, который может содержать гибридные узлы.
Эти блоки CIDR определяют ожидаемый диапазон IP-адресов гибридных узлов, которые присоединяются к кластеру. Эти блоки обычно определяются вашим сетевым администратором.
Введите один или несколько блоков IPv4 CIDR в десятичной точечной записи (например, 10.2.0.0/16 ).
Он должен удовлетворять следующим требованиям:
- Каждый блок должен находиться в диапазоне сети
IPv4RFC-1918. Минимальный разрешенный размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются. - Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.
- Каждый блок должен иметь маршрут к VPC, который использует блоки VPC CIDR, а не публичные IP-адреса или Elastic IP. Существует множество вариантов, включая Transit Gateway, VPN «сайт-сайт» или Direct Connect.
- Каждый хост должен разрешать исходящее соединение с контрольной плоскостью кластера EKS по TCP-портам
443и10250. - Каждый хост должен разрешать входящее соединение от контрольной плоскости кластера EKS по TCP-порту 10250 для операций логов, exec и port-forward.
- Каждый хост должен разрешать TCP и UDP сетевое соединение с другими хостами, на которых запущено
CoreDNS, по UDP-порту53для имен служб и Pods.
cidrs -> (список)
Сетевой CIDR, который может содержать гибридные узлы.
Эти блоки CIDR определяют ожидаемый диапазон IP-адресов гибридных узлов, которые присоединяются к кластеру. Эти блоки обычно определяются вашим сетевым администратором.
Введите один или несколько блоков IPv4 CIDR в десятичной точечной записи (например, 10.2.0.0/16 ).
Он должен удовлетворять следующим требованиям:
- Каждый блок должен находиться в диапазоне сети
IPv4RFC-1918. Минимальный разрешенный размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются. - Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.
- Каждый блок должен иметь маршрут к VPC, который использует блоки VPC CIDR, а не публичные IP-адреса или Elastic IP. Существует множество вариантов, включая Transit Gateway, VPN «сайт-сайт» или Direct Connect.
- Каждый хост должен разрешать исходящее соединение с контрольной плоскостью кластера EKS по TCP-портам
443и10250. - Каждый хост должен разрешать входящее соединение от контрольной плоскости кластера EKS по TCP-порту 10250 для операций логов, exec и port-forward.
- Каждый хост должен разрешать TCP и UDP сетевое соединение с другими хостами, на которых запущено
CoreDNS, по UDP-порту53для имен служб и Pods.
(строка)
remotePodNetworks -> (список)
Список сетевых CIDR, которые могут содержать Pods, выполняющие Kubernetes webhooks на гибридных узлах.
(структура)
Сетевой CIDR, который может содержать Pods, выполняющие Kubernetes webhooks на гибридных узлах.
Эти блоки CIDR определяются путем настройки плагина Container Network Interface (CNI). Мы рекомендуем Calico CNI или Cilium CNI. Обратите внимание, что плагин Amazon VPC CNI для Kubernetes недоступен для локальных и периферийных расположений.
Введите один или несколько блоков IPv4 CIDR в десятичной точечной записи (например, 10.2.0.0/16 ).
Он должен удовлетворять следующим требованиям:
- Каждый блок должен находиться в диапазоне сети
IPv4RFC-1918. Минимальный разрешенный размер — /24, максимальный — /8. Публично маршрутизируемые адреса не поддерживаются. - Каждый блок не должен перекрываться с диапазоном блоков VPC CIDR для ваших ресурсов EKS или блоком диапазона IP-адресов Kubernetes Service.
cidrs -> (список)
Сетевой CIDR, который может содержать Pods, выполняющие Kubernetes webhooks на гибридных узлах.
Эти блоки CIDR определяются путем настройки плагина Container Network Interface (CNI). Мы рекомендуем Calico CNI или Cilium CNI. Обратите внимание, что плагин Amazon VPC CNI для Kubernetes недоступен для локальных и периферийных расположений.
Введите один или несколько блоков IPv4 CIDR в десятичной точечной записи (например, 10.2.0.0/16 ).
Он должен удовлетворять следующим требованиям:
- Каждый блок должен находиться в диапазоне сети
IPv4RFC-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)
nodePools -> (список)
Указывает текущую конфигурацию пулов узлов в вашем кластере EKS Auto Mode. Дополнительную информацию см. в разделе «Пулы узлов EKS Auto Mode» в руководстве пользователя Amazon EKS.
(строка)
nodeRoleArn -> (строка)
storageConfig -> (структура)
Указывает текущую конфигурацию возможностей блочного хранения в вашем кластере EKS Auto Mode. Например, если возможность включена или выключена. Если возможность блочного хранения включена, EKS Auto Mode будет создавать и удалять тома EBS в вашей учетной записи Amazon Web Services. Дополнительную информацию см. в разделе «Возможность блочного хранения EKS Auto Mode» в руководстве пользователя Amazon EKS.
blockStorage -> (структура)
Указывает текущую конфигурацию возможностей блочного хранения в вашем кластере EKS Auto Mode. Например, если возможность включена или выключена.
enabled -> (boolean)
© Copyright 2025, Amazon Web Services. Created using Sphinx.