[Перевод] Как эффективнее использовать kubectl: подробное руководство03.06.2020 11:32

Давайте посмотрим на простой пример:

$ kubectl get pods -o custom-columns='NAME:metadata.name'

NAME
engine-544b6b6467-22qr6
engine-544b6b6467-lw5t8
engine-544b6b6467-tvgmg
web-ui-6db964458-8pdw4

Вывод содержит один столбец с именами подов.

Выражение в опции выбирает имена подов из поля metadata.name. Это потому что имя пода определяется в дочернем поле name поля metadata в ресурсном описании пода. Детальнее можно ознакомиться в руководстве API либо набрать команду kubectl explain pod.metadata.name.

Теперь допустим, что вы хотите добавить дополнительный столбец к выводу, например, показывая ноду, на которой работает каждый под. Для этого вы можете просто добавить соответствующую спецификацию столбца в опцию пользовательских столбцов:

$ kubectl get pods \
  -o custom-columns='NAME:metadata.name,NODE:spec.nodeName'

NAME                       NODE
engine-544b6b6467-22qr6    ip-10-0-80-67.ec2.internal
engine-544b6b6467-lw5t8    ip-10-0-36-80.ec2.internal
engine-544b6b6467-tvgmg    ip-10-0-118-34.ec2.internal
web-ui-6db964458-8pdw4     ip-10-0-118-34.ec2.internal

Выражение выбирает имя ноды из spec.nodeName — когда под назначается ноде, ее имя прописывается в поле spec.nodeName ресурсной спецификации пода. Более подробную информацию можно посмотреть в выводе kubectl explain pod.spec.nodeName.

Учтите, что поля ресурсов Kubernetes чувствительны к регистру.

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

Но сначала давайте подробнее рассмотрим выражения выбора полей.

Выражения JSONPath

Выражения для выбора полей ресурсов базируются на JSONPath.

JSONPath — это язык для выборки данных из JSON-документов. Выбор одного поля — самый простой случай использования JSONPath. У него гораздо больше возможностей, включая селекторы, фильтры и так далее.

Kubectl explain поддерживает ограниченное количество возможностей JSONPath. Ниже описаны возможности и примеры их использования:

# Выбрать все элементы списка
$ kubectl get pods -o custom-columns='DATA:spec.containers[*].image'
# Выбрать специфический элемент списка
$ kubectl get pods -o custom-columns='DATA:spec.containers[0].image'
# Выбрать элементы списка, попадающие под фильтр
$ kubectl get pods -o custom-columns='DATA:spec.containers[?(@.image!="nginx")].image'
# Выбрать все поля по указанному пути, независимо от их имени
$ kubectl get pods -o custom-columns='DATA:metadata.*'
# Выбрать все поля с указанным именем, вне зависимости от их расположения
$ kubectl get pods -o custom-columns='DATA:..image'

Особое значение имеет оператор []. Многие поля ресурсов Kubernetes являются списками, и этот оператор позволяет выбирать элементы этих списков. Он часто используется с подстановочным знаком как [*], чтобы выбрать все элементы списка.

Примеры применения

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

1. Отображение образов контейнеров для подов:

   $ kubectl get pods \
     -o custom-columns='NAME:metadata.name,IMAGES:spec.containers[*].image'
   
   NAME                        IMAGES
   engine-544b6b6467-22qr6     rabbitmq:3.7.8-management,nginx
   engine-544b6b6467-lw5t8     rabbitmq:3.7.8-management,nginx
   engine-544b6b6467-tvgmg     rabbitmq:3.7.8-management,nginx
   web-ui-6db964458-8pdw4      wordpress

   
   Эта команда отображает имена образов контейнеров для каждого пода.

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

2. Отображение зон доступности нод:

   $ kubectl get nodes \
     -o 
   custom-columns='NAME:metadata.name,ZONE:metadata.labels.failure-domain\.beta\.kubernetes\.io/zone'
   
   NAME                          ZONE
   ip-10-0-118-34.ec2.internal   us-east-1b
   ip-10-0-36-80.ec2.internal    us-east-1a
   ip-10-0-80-67.ec2.internal    us-east-1b

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

   Зона доступности — это облачная концепция, ограничивающая зону репликации географическим регионом.

   Зоны доступности для каждой ноды получаются через специальную метку — failure-domain.beta.kubernetes.io/zone. Если кластер запущен в публичном облаке, эта метка создается автоматически и заполняется именами зон доступности для каждой ноды.

   Метки не являются частью спецификации ресурсов Kubernetes, так что вы не найдете информации о них в руководстве API. Однако их можно увидеть (как и любые другие метки), если запросить информацию о нодах в формате YAML или JSON:

   $ kubectl get nodes -o yaml
   # или
   $ kubectl get nodes -o json

   
   Это отличный способ узнать больше о ресурсах, в дополнение к изучению ресурсных спецификаций.

4. Легкое переключение между кластерами и пространствами имен

Когда kubectl выполняет запрос к Kubernetes API, перед этим он читает файл kubeconfig, чтобы получить все необходимые параметры для коннекта.

По умолчанию файл kubeconfig — это ~/.kube/config. Обычно этот файл создается или обновляется особой командой.

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

Внутри кластера вы можете создать несколько пространств имен — разновидность виртуального кластера внутри физического кластера. Kubectl определяет, какое пространство имен использовать также по данным файла kubeconfig. Значит, вам также нужен способ указать команде kubectl, с каким пространством имен работать.

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

Обратите внимание, что у вас может быть несколько файлов kubeconfig, перечисленных в переменной среды KUBECONFIG. В этом случае все эти файлы будут объединены в одну общую конфигурацию во время выполнения. Вы также можете изменить применяемый по умолчанию файл kubeconfig, запуская kubectl с параметром --kubeconfig. Смотрите официальную документацию.

Файлы kubeconfig

Давайте посмотрим, что же именно содержит файл kubeconfig:

Как вы видите, файл kubeconfig содержит набор контекстов. Контекст состоит из трех элементов:

• Cluster — URL API сервера кластера.
• User — учетные данные аутентификации пользователя в кластере.
• Namespace — пространство имен, используемое при присоединении к кластеру.

На практике часто используют один контекст на кластер в своем файле kubeconfig. Тем не менее у вас может быть несколько контекстов на кластер, различающихся по пользователю или пространству имен. Однако такая конфигурация с несколькими контекстами встречается нечасто, так что обычно существует взаимно-однозначное сопоставление между кластерами и контекстами.

В любой момент времени один из контекстов является текущим:

Когда kubectl читает конфигурационный файл, то всегда берется информация из текущего контекста. В примере выше kubectl будет коннектиться к кластеру Hare.

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

Теперь kubectl будет коннектиться к кластеру Fox.

Чтобы переключиться на другое пространство имен в том же самом кластере, нужно изменить значение элемента namespace для текущего контекста:

В вышеприведенном примере kubectl будет использовать пространство имен Prod кластера Fox (ранее было установлено пространство имен Test).

Обратите внимание, что kubectl также предоставляет параметры --cluster, --user, --namespace и --context, которые позволяют перезаписывать отдельные элементы и сам текущий контекст, независимо от того, что установлено в файле kubeconfig. Смотрите kubectl options.

Теоретически вы можете вручную менять параметры в файле kubeconfig. Но это неудобно. Для упрощения этих операций существуют разнообразные утилиты, которые позволяют менять параметры в автоматическом режиме.

Используйте kubectx

Очень популярная утилита для переключения между кластерами и пространствами имен.

Утилита предоставляет команды kubectx и kubens для изменения текущего контекста и пространства имен соответственно.

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

Вот пример выполнения этих команд:

По сути, эти команды просто редактируют файл kubeconfig, как было описано выше.

Чтобы установить kubectx, следуйте инструкциям на Github.

Обе команды поддерживают автодополнение имен контекстов и пространств имен, что позволяет не вводить их полностью. Инструкции по настройке автодополнения тут.

Другой полезной функцией kubectx является интерактивный режим. Он работает совместно с утилитой fzf, которую необходимо устанавливать отдельно. Установка fzf автоматически делает доступным интерактивный режим в kubectx. В интерактивном режиме вы можете выбирать контекст и пространство имен через интерактивный интерфейс свободного поиска, предоставленный fzf.

Использование алиасов командной оболочки

Вам не нужны отдельные инструменты для изменения текущего контекста и пространства имен, потому что kubectl также предоставляет команды для этого. Так, команда kubectl config предоставляет подкоманды для редактирования файлов kubeconfig.

Вот некоторые из них:

• kubectl config get-contexts: вывести все контексты;
• kubectl config current-context: получить текущий контекст;
• kubectl config use-context: изменить текущий контекст;
• kubectl config set-context: изменить элемент контекста.

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

Я создал набор алиасов на основе этих команд, которые предоставляют функциональность, аналогичную kubectx. Здесь вы можете увидеть их действие:

Обратите внимание, что алиасы используют fzf для предоставления интерактивного интерфейса свободного поиска (как в интерактивном режиме kubectx). Это означает, что вам нужно установить fzf, чтобы использовать эти алиасы.

Вот сами определения алиасов:

# Получить текущий контекст
alias krc='kubectl config current-context'
# Список всех контекстов
alias klc='kubectl config get-contexts -o name | sed "s/^/  /;\|^  $(krc)$|s/ /*/"'
# Изменить текущий контекст
alias kcc='kubectl config use-context "$(klc | fzf -e | sed "s/^..//")"'

# Получить текущее пространство имен
alias krn='kubectl config get-contexts --no-headers "$(krc)" | awk "{print \$5}" | sed "s/^$/default/"'
# Список всех пространств имен
alias kln='kubectl get -o name ns | sed "s|^.*/|  |;\|^  $(krn)$|s/ /*/"'
# Изменить текущее пространство имен
alias kcn='kubectl config set-context --current --namespace "$(kln | fzf -e | sed "s/^..//")"'

Чтобы установить эти алиасы, нужно добавить приведенные выше определения в ваш файл ~/.bashrc или ~/.zshrc и перезагрузить вашу оболочку.

Использование плагинов

Kubectl позволяет загружать плагины, которые исполняются так же, как основные команды. Можно, например, установить плагин kubectl-foo и запускать его, выполняя команду kubectl foo.

Было бы удобно менять контекст и пространство имен таким способом, например, запускать kubectl ctx для смены контекста и kubectl ns для смены пространства имен.

Я написал два плагина, которые делают это:

Работа плагинов базируется на алиасах из предыдущего раздела.

Вот как они работают:

Обратите внимание, что плагины используют fzf для предоставления интерактивного интерфейса свободного поиска (как в интерактивном режиме kubectx). Это означает, что вам нужно установить fzf, чтобы использовать эти алиасы.

Чтобы установить плагины, нужно загрузить сценарии оболочки с именами kubectl-ctx и kubectl-ns в любой каталог в вашей переменной PATH и сделать их исполняемыми, например, с помощью chmod +x. Сразу после этого вы сможете использовать kubectl ctx и kubectl ns.

5. Сокращение ввода с автоалиасами

Алиасы командной оболочки — хорошая возможность ускорить ввод. Проект kubectl-aliases содержит около 800 сокращений для основных команд kubectl.

Вы можете удивиться — как запомнить 800 алиасов? Но не нужно помнить их все, ведь они строятся по простой схеме, которая приведена ниже:

Например:

1. kgpooyaml — kubectl get pods oyaml
2. ksysgsvcw — kubectl -n kube-system get svc w
3. ksysrmcm — kubectl -n kube-system rm cm
4. kgdepallsl — kubectl get deployment all sl

Как вы видите, алиасы состоят из компонентов, каждый из которых обозначает определенный элемент команды kubectl. Каждый алиас может иметь один компонент для базовой команды, операции и ресурса и несколько компонентов для параметров. Вы просто «заполняете» эти компоненты слева направо в соответствии с приведенной выше схемой.

Tекущая подробная схема находится на GitHub. Там вы также можете найти полный список псевдонимов.

Например, алиас kgpooyamlall равноценен команде kubectl get pods -o yaml --all-namespaces.

Относительный порядок опций неважен: команда kgpooyamlall эквивалентна команде kgpoalloyaml.

Вы можете не использовать все компоненты как алиасы. Например k, kg, klo, ksys, kgpo также можно использовать. Более того, в командной строке можно комбинировать алиасы и обычные команды или опции:

Например:

1. Вместо kubectl proxy можно написать k proxy.
2. Вместо kubectl get roles можно написать kg roles (в настоящее время не существует алиаса для ресурса Roles).
3. Чтобы получить данные по конкретному поду, можно использовать команду kgpo my-pod — kubectl get pod my-pod.

Учтите, что некоторые алиасы требуют аргумент в командной строке. Например, алиас kgpol означает kubectl get pods -l. Опция -l требует аргумент — спецификацию метки. Если вы используете алиас, то он будет выглядеть как kgpol app=ui.

Из-за того, что часть алиасов требует аргументы, алиасы а, f и l нужно использовать последними.

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

Инсталляция

Чтобы инсталлировать kubectl-aliases, нужно скачать файл .kubectl_aliases с GitHub и включить его в файл ~/.bashrc или ~/.zshrc:

source ~/.kubectl_aliases

Автодополнение

Как мы уже говорили, вы часто добавляете дополнительные слова к алиасу в командной строке. Например:

$ kgpooyaml test-pod-d4b77b989

Если вы используете автодополнение команды kubectl, то, вероятно, использовали автодополнение для таких вещей, как имена ресурсов. Но можно ли сделать это, когда используются алиасы?

Это очень важный вопрос, потому что, если автодополнение не работает, вы лишитесь части преимуществ алиасов.

Ответ зависит от того, какую командную оболочку вы используете:

1. Для Zsh автодополнение для алиасов работает «из коробки».
2. Для Bash, к сожалению, необходимы некоторые действия, чтобы заставить работать автодополнение.

Включение автодополнения для алиасов в Bash

Проблема с Bash состоит в том, что он пытается дополнить (всякий раз, когда вы нажимаете Tab) алиас, а не команду, на которую ссылается алиас (как, например, делает Zsh). Поскольку у вас нет скриптов дополнения для всех 800 псевдонимов, автодополнение не работает.

Проект complete-alias предоставляет общее решение этой проблемы. Он подключается к механизму дополнения для алиасов, внутри дополняет алиас до команды и возвращает варианты дополнения для дополненной команды. Это означает, что дополнение для алиаса ведет себя точно так же, как для полной команды.

Далее я сначала объясню, как установить complete-alias, а затем — как его настроить, чтобы включить дополнение для всех псевдонимов kubectl.

Установка complete-alias

Прежде всего, complete-alias зависит от bash-completion. Поэтому перед установкой complete-alias необходимо убедиться, что bash-completion установлен. Инструкции по установке были даны ранее для Linux и MacOS.

Важное примечание для пользователей MacOS: как и скрипт автодополнения kubectl, сomplete-alias не работает с Bash 3.2, который по умолчанию используется в MacOS. В частности, complete-alias зависит от bash-completion v2 (brew install bash-completion@2), для которого требуется как минимум Bash 4.1. Это означает, что для использования complete-alias в MacOS нужно установить более новую версию Bash.

Вам нужно скачать скрипт bash_completion.sh из репозитория GitHub и включить его в своем файле ~/.bashrc:

source ~/bash_completion.sh

После перезагрузки командной оболочки complete-alias будет полностью установлен.

Включение автодополнения для алиасов kubectl

Технически complete-alias предоставляет функцию оболочки _com

© Habrahabr.ru