Cómo utilizar kubectl de manera más efectiva: guía detallada

Veamos un ejemplo simple:

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

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

La salida contiene una columna con los nombres de los pods.

La expresión en la opción selecciona los nombres de los pods del campo metadata.name. Esto se debe a que el nombre del pod se define en el campo secundario nombre del campo metadata en la descripción del recurso del pod. Puede encontrar más detalles en la guía de la API o escribir el comando kubectl explain pod.metadata.name.

Ahora supongamos que deseas agregar una columna adicional a la salida, por ejemplo, mostrando el nodo en el que se está ejecutando cada pod. Para ello, simplemente puedes añadir la especificación de columna correspondiente a la opción de columnas personalizadas:

$ 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

La expresión selecciona el nombre del nodo de spec.nodeName — cuando un pod se asigna a un nodo, su nombre se escribe en el campo spec.nodeName de la especificación del recurso del pod. Puedes consultar más información en la salida de kubectl explain pod.spec.nodeName.

Ten en cuenta que los campos de recursos de Kubernetes son sensibles a mayúsculas y minúsculas.

Puedes ver cualquier campo de recurso como una columna. Simplemente revisa la especificación del recurso y pruébalo con los campos que desees.

Pero primero, echemos un vistazo más de cerca a las expresiones de selección de campos.

Expresiones JSONPath

Las expresiones para seleccionar campos de recursos se basan en JSONPath.

JSONPath es un lenguaje para extraer datos de documentos JSON. Seleccionar un solo campo es el caso de uso más simple de JSONPath. Tiene muchas más capacidades, que incluyen selectores, filtros, etc.

Kubectl explain admite un número limitado de capacidades de JSONPath. A continuación se describen las capacidades y algunos ejemplos de su uso:

# Выбрать все элементы списка
$ 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'

El operador [] tiene un significado especial. Muchos campos de recursos de Kubernetes son listas, y este operador permite seleccionar elementos de estas listas. A menudo se utiliza con un comodín como [*] para seleccionar todos los elementos de la lista.

Ejemplos de aplicación

Las posibilidades de usar un formato de salida de columna personalizada son ilimitadas, ya que puedes mostrar cualquier campo o combinación de campos del recurso en la salida. Aquí hay algunos ejemplos de aplicaciones, pero siéntete libre de explorarlas por tu cuenta y encontrar aplicaciones útiles para ti.

1. Mostrar imágenes de contenedores para pods:

   $ 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

   Este comando muestra los nombres de las imágenes de contenedores para cada pod.

   Recuerde que un pod puede contener múltiples contenedores, por lo que los nombres de las imágenes se mostrarán en una sola línea, separados por comas.

2. Visualización de las zonas de disponibilidad de los nodos:

   $ kubectl get nodes 
     -o 
   custom-columns='NOMBRE:metadata.name,ZONA:metadata.labels.failure-domain.beta.kubernetes.io/zone'
   
   NOMBRE                          ZONA
   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

   Este comando es útil si su clúster se encuentra en una nube pública. Muestra la zona de disponibilidad para cada nodo.

   Una zona de disponibilidad es un concepto de nube que restringe la zona de replicación a una región geográfica.

   Las zonas de disponibilidad para cada nodo se obtienen mediante una etiqueta especial — topology.kubernetes.io/zone. Si el clúster se ejecuta en una nube pública, esta etiqueta se crea automáticamente y se llena con los nombres de las zonas de disponibilidad para cada nodo.

   Las etiquetas no son parte de la especificación de recursos de Kubernetes, por lo que no encontrará información sobre ellas en la guía de la API. Sin embargo, se pueden ver (al igual que cualquier otra etiqueta) si se solicita información sobre los nodos en formato YAML o JSON:

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

   Esta es una excelente manera de obtener más información sobre los recursos, además de estudiar las especificaciones de recursos.

4. Cambio fácil entre clústeres y namespaces

Cuando kubectl realiza una solicitud a la API de Kubernetes, primero lee el archivo kubeconfig para obtener todos los parámetros necesarios para la conexión.

Por defecto, el archivo kubeconfig es ~/.kube/config. Normalmente, este archivo se crea o se actualiza mediante un comando especial.

Cuando trabaja con varios clústeres, su archivo kubeconfig contiene los parámetros de conexión para todos estos clústeres. Necesita una forma de indicarle a kubectl con qué clúster está trabajando.

Dentro del clúster, puede crear varios namespaces, una especie de clúster virtual dentro del clúster físico. Kubectl también determina qué namespace usar según los datos del archivo kubeconfig. Por lo tanto, también necesita una forma de indicarle a kubectl con qué namespace trabajar.

En este capítulo, explicaremos cómo funciona esto y cómo lograr un funcionamiento efectivo.

Tenga en cuenta que puede tener varios archivos kubeconfig enumerados en la variable de entorno KUBECONFIG. En este caso, todos estos archivos se combinarán en una configuración común durante la ejecución. También puede cambiar el archivo kubeconfig predeterminado ejecutando kubectl con el parámetro --kubeconfig. Consulte la documentación oficial.

Archivos kubeconfig

Veamos qué contiene exactamente el archivo kubeconfig:

Como puede ver, el archivo kubeconfig contiene un conjunto de contextos. Un contexto consiste en tres elementos:

• Cluster — URL del servidor API del clúster.
• User — credenciales de autenticación del usuario en el clúster.
• Namespace — espacio de nombres utilizado al unirse al clúster.

En la práctica, a menudo se utiliza un único contexto por clúster en su archivo kubeconfig. Sin embargo, puede tener varios contextos por clúster que difieren por usuario o espacio de nombres. No obstante, esta configuración con múltiples contextos es poco común, por lo que generalmente hay una correspondencia uno a uno entre clústeres y contextos.

En cualquier momento, uno de los contextos es el actual:

Cuando kubectl lee el archivo de configuración, siempre toma información del contexto actual. En el ejemplo anterior, kubectl se conectará al clúster Hare.

Por lo tanto, para cambiar a otro clúster, debe cambiar el contexto actual en el archivo kubeconfig:

Ahora kubectl se conectará al clúster Fox.

Para cambiar a otro espacio de nombres en el mismo clúster, debe cambiar el valor del elemento namespace para el contexto actual:

En el ejemplo anterior, kubectl utilizará el espacio de nombres Prod del clúster Fox (anteriormente se había configurado el espacio de nombres Test).

Tenga en cuenta que kubectl también proporciona los parámetros --cluster, --user, --namespace y --context, que permiten sobrescribir elementos individuales y el contexto actual, independientemente de lo que esté configurado en el archivo kubeconfig. Consulte opciones de kubectl.

Teóricamente, puede cambiar manualmente los parámetros en el archivo kubeconfig. Pero esto es inconveniente. Para facilitar estas operaciones, existen diversas utilidades que permiten cambiar parámetros de forma automática.

Utilice kubectx

Una utilidad muy popular para cambiar entre clústeres y espacios de nombres.

La herramienta proporciona comandos kubectx y kubens para cambiar el contexto actual y el espacio de nombres respectivamente.

Como se mencionó anteriormente, cambiar el contexto actual significa cambiar el clúster si solo tiene un contexto por clúster.

Aquí hay un ejemplo de la ejecución de estos comandos:

En esencia, estos comandos simplemente editan el archivo kubeconfig, como se describió anteriormente.

Para instalar kubectx, siga las instrucciones en Github.

Ambos comandos admiten la autocomplete de nombres de contextos y espacios de nombres, lo que permite no tener que escribirlos completamente. Las instrucciones para configurar la completion automática aquí.

Otra función útil kubectx es el modo interactivo. Funciona junto con la herramienta fzf, que debe instalarse por separado. La instalación de fzf automáticamente habilita el modo interactivo en kubectx. En modo interactivo, puede seleccionar el contexto y el espacio de nombres a través de una interfaz de búsqueda libre interactiva proporcionada por fzf.

Usando alias de la shell

No necesita herramientas separadas para cambiar el contexto actual y el espacio de nombres, porque kubectl también proporciona comandos para ello. Así, el comando kubectl config ofrece subcomandos para editar archivos kubeconfig.

Aquí hay algunos de ellos:

• kubectl config get-contexts: lista todos los contextos;
• kubectl config current-context: obtener el contexto actual;
• kubectl config use-context: cambiar el contexto actual;
• kubectl config set-context: cambiar el elemento del contexto.

Sin embargo, usar estos comandos directamente no es muy conveniente porque son largos. Puede crear alias de shell para ellos que son fáciles de ejecutar.

He creado un conjunto de alias basados en estos comandos que proporcionan funcionalidad similar a kubectx. Aquí puedes ver su funcionamiento:

Tenga en cuenta que los alias utilizan fzf para proporcionar una interfaz de búsqueda libre interactiva (como en el modo interactivo de kubectx). Esto significa que necesita instalar fzf, para usar estos alias.

Aquí están las definiciones de los alias:

# Получить текущий контекст
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/^..//")"'

Para instalar estos alias, debe agregar las definiciones anteriores a su archivo ~~/.bashrc o ~/.zshrc y reiniciar su shell.

Uso de plugins

Kubectl permite cargar plugins que se ejecutan de la misma manera que los comandos principales. Puede, por ejemplo, instalar el plugin kubectl-foo y ejecutarlo usando el comando kubectl foo.

Sería conveniente cambiar el contexto y el espacio de nombres de esta manera, por ejemplo, ejecutando kubectl ctx para cambiar el contexto y kubectl ns para cambiar el espacio de nombres.

Escribí dos plugins que hacen esto:

• kubectl-ctx
• kubectl-ns

El funcionamiento de los plugins se basa en los alias de la sección anterior.

Así es como funcionan:

Tenga en cuenta que los plugins utilizan fzf para proporcionar una interfaz interactiva de búsqueda libre (como en el modo interactivo de kubectx). Esto significa que necesita instalar fzf, para usar estos alias.

Para instalar los plugins, debe descargar los scripts de shell con los nombres kubectl-ctx y kubectl-ns en cualquier directorio de su variable PATH y hacerlos ejecutables, por ejemplo, con chmod +x. Inmediatamente después, podrá usar kubectl ctx y kubectl ns.

5. Abreviación de entrada con autoalias

Los alias de la línea de comandos son una buena manera de acelerar la entrada. El proyecto kubectl-aliases contiene alrededor de 800 abreviaturas para los comandos principales de kubectl.

Puede preguntarse: ¿cómo recordar 800 alias? Pero no es necesario recordar todos, ya que se construyen según un esquema simple que se presenta a continuación:

Por ejemplo:

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

Como puede ver, los alias consisten en componentes, cada uno de los cuales representa un elemento determinado del comando kubectl. Cada alias puede tener un componente para el comando base, operación y recurso, y varios componentes para los parámetros. Simplemente "rellena" estos componentes de izquierda a derecha de acuerdo con el esquema anterior.

La descripción detallada actual se encuentra en GitHub. Allí también puede encontrar la lista completa de alias.

Por ejemplo, el alias kgpooyamlall es equivalente al comando kubectl get pods -o yaml --all-namespaces.

El orden relativo de las opciones no es importante: el comando kgpooyamlall es equivalente al comando kgpoalloyaml.

No es necesario utilizar todos los componentes como alias. Por ejemplo k, kg, klo, ksys, kgpo también se pueden usar. Además, en la línea de comandos se pueden combinar alias y comandos u opciones normales:

Por ejemplo:

1. En lugar de kubectl proxy se puede escribir como k proxy.
2. En lugar de kubectl get roles se puede escribir como kg roles (actualmente no existe un alias para el recurso Roles).
3. Para obtener datos de un pod específico, puede usar el comando kgpo my-pod — kubectl get pod my-pod.

Tenga en cuenta que algunos alias requieren un argumento en la línea de comandos. Por ejemplo, el alias kgpol significa kubectl get pods -l. La opción -l requiere un argumento: la especificación de la etiqueta. Si usas un alias, se verá como kgpol app=ui.

Debido a que algunos alias requieren argumentos, los alias a, f y l deben usarse en último lugar.

En general, una vez que domines este esquema, podrás intuitivamente deducir los alias de los comandos que deseas ejecutar, ahorrando mucho tiempo en la entrada.

Instalación

Para instalar kubectl-aliases, necesitas descargar el archivo .kubectl_aliases desde GitHub e incluirlo en el archivo ~~/.bashrc o ~/.zshrc:

source ~/.kubectl_aliases

Autocompletado

Como ya hemos mencionado, a menudo añades palabras adicionales al alias en la línea de comandos. Por ejemplo:

$ kgpooyaml test-pod-d4b77b989

Si estás utilizando el autocompletado del comando kubectl, probablemente has usado el autocompletado para elementos como nombres de recursos. Pero, ¿se puede hacer esto cuando se utilizan alias?

Esta es una pregunta muy importante, porque si el autocompletado no funciona, perderás parte de las ventajas de los alias.

La respuesta depende de qué shell estás utilizando:

1. Para Zsh, el autocompletado para alias funciona 'fuera de la caja'.
2. Para Bash, desafortunadamente, se necesitan algunos pasos para hacer que el autocompletado funcione.

Habilitando el autocompletado para alias en Bash

El problema con Bash es que intenta completar (cada vez que presionas Tab) el alias, y no el comando al que hace referencia el alias (como lo hace Zsh). Dado que no tienes scripts de autocompletado para los 800 alias, el autocompletado no funciona.

Proyecto complete-alias ofrece una solución general a este problema. Se conecta al mecanismo de autocompletado para alias, completa internamente el alias hasta el comando y devuelve las opciones de autocompletado para el comando completado. Esto significa que el autocompletado para el alias se comporta exactamente igual que para el comando completo.

Primero explicaré cómo instalar complete-alias y luego cómo configurarlo para habilitar el autocompletado para todos los alias de kubectl.

Instalando complete-alias

Primero que nada, complete-alias depende de bash-completion. Por lo tanto, antes de instalar complete-alias, asegúrate de que bash-completion esté instalado. Las instrucciones de instalación fueron dadas anteriormente para Linux y MacOS.

Nota importante para usuarios de MacOS: al igual que el script de autocompletado de kubectl, complete-alias no funciona con Bash 3.2, que es el que se utiliza por defecto en MacOS. En particular, complete-alias depende de bash-completion v2 (brew install bash-completion@2), que requiere al menos Bash 4.1. Esto significa que para usar complete-alias en MacOS debes instalar una versión más reciente de Bash.

Necesitas descargar el script bash_completion.sh de del repositorio de GitHub y incluirlo en tu archivo ~~/.bashrc:

source ~/bash_completion.sh

Después de reiniciar la terminal, complete-alias estará completamente instalado.

Habilitando la autocompletación para los alias de kubectl

Técnicamente, complete-alias proporciona la función de shell _complete_alias. Esta función verifica el alias y devuelve sugerencias de autocompletado para el comando del alias.

Para vincular la función a un alias específico, debes usar el mecanismo incorporado de Bash complete, para establecerlo _complete_alias como función de autocompletado para el alias.

Como ejemplo, tomemos el alias k, que representa el comando kubectl. Para establecerlo _complete_alias como función de autocompletado para este alias, debes ejecutar el siguiente comando:

$ complete -F _complete_alias k

El resultado de esto es que cada vez que completes automáticamente el alias k, se llamará a la función _complete_alias, que verifica el alias y devuelve sugerencias de autocompletado para el comando. kubectl.

Como segundo ejemplo, tomemos el alias kg, que representa kubectl get:

$ complete -F _complete_alias kg

De la misma manera que en el ejemplo anterior, cuando completes automáticamente kg, recibirás las mismas sugerencias de autocompletado que recibirías para kubectl get.

Ten en cuenta que puedes usar complete-alias para cualquier alias en tu sistema.

Por lo tanto, para habilitar la autocompletación para todos los alias de kubectl, debes ejecutar el comando mencionado anteriormente para cada uno de ellos. El siguiente fragmento hace exactamente eso, siempre que hayas instalado kubectl-aliases en ~/ .kubectl-aliases:

for _a in $(sed '/^alias /!d;s/^alias //;s/=.*$// ' ~/ .kubectl_aliases); 
do
  complete -F _complete_alias "$_a"
done

Este fragmento de código debe ir en tu ~~/.bashrc, reiniciar la terminal y la autocompletación estará disponible para todos los 800 alias de kubectl.

6. Extensión de kubectl mediante plugins

Comenzando con en la versión 1.12, kubectl soporta mecanismos de plugins, que permiten extender sus funciones con comandos adicionales.

Si estás familiarizado con los mecanismos de plugins de Git, los plugins de kubectl están construidos bajo el mismo principio.

En este capítulo, hablaremos sobre cómo instalar plugins, dónde encontrarlos y cómo crear tus propios plugins.

Instalación de plugins

Los complementos de kubectl se distribuyen como archivos ejecutables simples con nombres del tipo kubectl-x. El prefijo kubectl- es obligatorio, seguido de un nuevo subcomando de kubectl, que permite invocar el complemento.

Por ejemplo, el complemento hello se distribuirá como un archivo llamado kubectl-hello.

Para instalar el complemento, es necesario copiar el archivo kubectl-x en cualquier directorio en su variable PATH y hacerlo ejecutable, por ejemplo usando chmod +x. Inmediatamente después, puede invocar el complemento usando kubectl x.

Puede usar el siguiente comando para listar todos los complementos que actualmente están instalados en su sistema:

$ kubectl plugin list

Este comando también mostrará advertencias si tiene múltiples complementos con los mismos nombres, o si hay un archivo de complemento que no es ejecutable.

Buscar e instalar complementos usando Krew

Los complementos de kubectl son aptos para uso compartido o reutilizable como paquetes de software. Pero, ¿dónde se pueden encontrar complementos compartidos por otros?

El proyecto Krew está enfocado en proporcionar una solución unificada para compartir, buscar, instalar y gestionar complementos de kubectl. El proyecto se llama a sí mismo "el gestor de paquetes para complementos de kubectl" (Krew es similar a Brew).

Krew es una lista de complementos de kubectl que puede elegir e instalar. Además, Krew es también un complemento para kubectl.

Esto significa que la instalación de Krew funciona, en esencia, como la instalación de cualquier otro complemento de kubectl. Puede encontrar instrucciones detalladas en la página de GitHub.

Los comandos más importantes de Krew:

# Поиск в списке плагинов
$ kubectl krew search [<query>]
# Посмотреть информацию о плагине
$ kubectl krew info <plugin>
# Установить плагин
$ kubectl krew install <plugin>
# Обновить все плагины до последней версии
$ kubectl krew upgrade
# Посмотреть все плагины, установленные через Krew
$ kubectl krew list
# Деинсталлировать плагин
$ kubectl krew remove <plugin>

Tenga en cuenta que la instalación de complementos utilizando Krew no interfiere con la instalación de complementos de la manera estándar, como se describió anteriormente.

Tenga en cuenta que el comando kubectl krew list muestra solo los complementos que se han instalado utilizando Krew, mientras que el comando kubectl plugin list enumera todos los complementos, es decir, aquellos que se han instalado usando Krew y aquellos que se han instalado de otras maneras.

Buscar complementos en otros lugares

Krew es un proyecto joven, en este momento en su lista hay aproximadamente 30 complementos. Si no puede encontrar lo que necesita, puede buscar complementos en otro lugar, como en GitHub.

Recomiendo ver la sección de GitHub kubectl-plugins. Allí encontrará varias docenas de complementos disponibles que vale la pena explorar.

Escribir sus propios complementos

Puede hacerlo usted mismo crear complementos — no es complicado. Solo necesita crear un archivo ejecutable que haga lo que necesita, nombrarlo como kubectl-x y configurarlo como se describió anteriormente.

El archivo puede ser un script bash, un script de python o una aplicación compilada en Go — no importa. La única condición es que debe ser ejecutable directamente en el sistema operativo.

Vamos a crear un ejemplo de complemento ahora mismo. En la sección anterior, utilizó el comando kubectl para listar los contenedores de cada pod. Puede convertir fácilmente este comando en un complemento que puede invocar, por ejemplo, usando kubectl img.

Cree un archivo kubectl-img users.module.ts

#!/bin/bash
kubectl get pods -o custom-columns='NAME:metadata.name,IMAGES:spec.containers[*].image'

Ahora haga que el archivo sea ejecutable con chmod +x kubectl-img y muévalo a cualquier directorio en su PATH. Justo después de eso, puede usar el complemento kubectl img.

Como se mencionó, los complementos de kubectl pueden estar escritos en cualquier lenguaje de programación o scripts. Si utiliza scripts de shell, la ventaja es que puede invocar fácilmente kubectl desde el complemento. Sin embargo, puede escribir complementos más complejos en lenguajes de programación reales, utilizando la biblioteca cliente de Kubernetes. Si usa Go, también puede utilizar la biblioteca cli-runtime, que existe específicamente para escribir complementos de kubectl.

Cómo compartir sus complementos

Si cree que sus complementos pueden ser útiles para otros, no dude en compartirlos en GitHub. Asegúrese de incluirlos en el tema kubectl-plugins.

También puede solicitar que su complemento se agregue a la lista Krew. Las instrucciones sobre cómo hacerlo se encuentran en repositorio de GitHub.

Autocompletación de comandos

Actualmente, los complementos no soportan autocompletado. Es decir, debe escribir el nombre completo del complemento y los nombres completos de los argumentos.

En el repositorio de GitHub de kubectl, hay una solicitud abierta. Por lo tanto, es posible que esta función se implemente en algún momento en el futuro.

¡Buena suerte!!!

Lecturas adicionales sobre el tema:

1. Tres niveles de escalado automático en Kubernetes y cómo utilizarlos eficazmente.
2. Kubernetes con espíritu de piratería con plantilla de implementación.
3. Nuestro canal Alrededor de Kubernetes en Telegram.

Fuente: habr.com