update-kubeconfig

Описание

Настраивает kubectl для подключения к кластеру Amazon EKS.

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

Эта команда создаёт конфигурацию с предварительно заполненными данными сервера и сертификата авторизации для указанного кластера. Вы можете указать ARN роли IAM с помощью параметра --role-arn для аутентификации при выполнении команд kubectl. В противном случае используется сущность IAM из вашей стандартной цепочки учётных данных AWS CLI или SDK. Вы можете просмотреть свою стандартную сущность AWS CLI или SDK, выполнив команду aws sts get-caller-identity.

Полученная конфигурация kubeconfig создаётся как новый файл или объединяется с существующим файлом kubeconfig с использованием следующего алгоритма:

Если вы укажете путь с параметром --kubeconfig option, то созданный файл конфигурации будет сохранён там или объединён с существующим файлом kubeconfig по этому пути.
Или, если установлена переменная среды KUBECONFIG, то созданный файл конфигурации будет сохранён по первому пути в этой переменной или объединён с существующим файлом kubeconfig по этому пути.
В противном случае по умолчанию созданный файл конфигурации сохраняется по умолчанию в пути kubeconfig (.kube/config) в вашей домашней директории или объединяется с существующим файлом kubeconfig по этому пути.
Если для кластера Amazon EKS с таким же именем уже существует конфигурация в указанном пути, то существующая конфигурация будет перезаписана новой.
При записи конфигурации в файл kubeconfig командой update-kubeconfig текущий контекст файла kubeconfig устанавливается на эту конфигурацию.

Вы можете использовать параметр --dry-run, чтобы вывести полученную конфигурацию в стандартный вывод (stdout) вместо записи её в указанное место.

Синтаксис

  update-kubeconfig
--name <value>
[--kubeconfig <value>]
[--role-arn <value>]
[--dry-run]
[--verbose]
[--alias <value>]
[--user-alias <value>]
[--assume-role-arn <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 (строка) Имя кластера, для которого нужно создать запись в kubeconfig. Этот кластер должен существовать в вашей учётной записи и в указанном или по умолчанию регионе вашей установки AWS CLI.

--kubeconfig (строка) Необязательно укажите файл kubeconfig, который необходимо дополнить вашей конфигурацией. По умолчанию конфигурация записывается в первый путь файла в переменной среды KUBECONFIG (если она установлена) или в стандартный путь kubeconfig (.kube/config) в вашей домашней директории.

--role-arn (строка) Для принятия роли для аутентификации в кластере укажите ARN роли IAM с этим параметром. Например, если вы создали кластер, приняв роль IAM, то вам также необходимо принять эту роль для подключения к кластеру в первый раз.

--dry-run (булево) Вывести объединённую конфигурацию kubeconfig в стандартный вывод (stdout) вместо записи её в указанный файл.

--verbose (булево) Выводить более подробный вывод при записи в файл kubeconfig, включая добавленные записи.

--alias (строка) Псевдоним для имени контекста кластера. По умолчанию совпадает с ARN кластера.

--user-alias (строка) Псевдоним для имени сгенерированного пользователя. По умолчанию совпадает с ARN кластера.

--assume-role-arn (строка) Для принятия роли для получения информации о кластере укажите ARN роли IAM с этим параметром. Используйте это для доступа к другой учётной записи для получения данных о кластере из учётной записи, где он находится.

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

--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: Настройка kubectl, создавая или обновляя kubeconfig для подключения к кластеру Amazon EKS с именем `my-eks-cluster`

Следующий update-kubeconfig пример настраивает kubectl, создавая или обновляя kubeconfig для подключения к кластеру Amazon EKS с именем my-eks-cluster.

aws eks update-kubeconfig \
    --name my-eks-cluster

Вывод:

Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config

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

Пример 2: Настройка kubectl, создавая или обновляя kubeconfig (с параметром role-arn для принятия роли аутентификации кластера) для подключения к кластеру Amazon EKS с именем `my-eks-cluster`

Следующий update-kubeconfig пример настраивает kubectl, создавая или обновляя kubeconfig (с параметром role-arn для принятия роли аутентификации кластера) для подключения к кластеру Amazon EKS с именем my-eks-cluster.

aws eks update-kubeconfig \
    --name my-eks-cluster \
    --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM

Вывод:

Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config

Пример 3: Настройка kubectl, создавая или обновляя kubeconfig (с параметром role-arn для принятия роли аутентификации кластера и пользовательским псевдонимом кластера и пользователя) для подключения к кластеру Amazon EKS с именем `my-eks-cluster`

Следующий update-kubeconfig пример настраивает kubectl, создавая или обновляя kubeconfig (с параметром role-arn для принятия роли аутентификации кластера и пользовательским псевдонимом кластера и пользователя) для подключения к кластеру Amazon EKS с именем my-eks-cluster.

aws eks update-kubeconfig \
    --name my-eks-cluster \
    --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \
    --alias stage-eks-cluster \
    --user-alias john

Вывод:

Updated context stage-eks-cluster in /Users/dubaria/.kube/config

Пример 4: Вывод записей файла kubeconfig для проверки и настройка kubectl для подключения к кластеру Amazon EKS с именем `my-eks-cluster`

aws eks update-kubeconfig \
    --name my-eks-cluster \
    --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \
    --alias stage-eks-cluster \
    --user-alias john \
    --verbose

Вывод:

Updated context stage-eks-cluster in /Users/dubaria/.kube/config
Entries:

context:
cluster: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster
user: john
name: stage-eks-cluster

name: john
user:
exec:
    apiVersion: client.authentication.k8s.io/v1beta1
    args:
    - --region
    - us-east-2
    - eks
    - get-token
    - --cluster-name
    - my-eks-cluster
    - --output
    - json
    - --role
    - arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM
    command: aws

cluster:
certificate-authority-data: xxx_CA_DATA_xxx
server: https://DALSJ343KE23J3RN45653DSKJTT647TYD.yl4.us-east-2.eks.amazonaws.com
name: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster