kommands

kubernetes common commands without so much typing

install

git clone https://github.com/javimox/kommands ~/.kube/kommands/

bash

echo "source ~/.kube/kommands/.kommands" >> ~/.bashrc && source ~/.bashrc

usage

All the commands below accept as parameter a number or a name. Autocomplete is enabled for names.

kommands get and their kubectl equivalents

kgpo  ->  kubectl get pods
kgpvc ->  kubectl get pvc
kgsvc ->  kubectl get svc
kgcm  ->  kubectl get cm
kgin  ->  kubectl get ingress
kgse  ->  kubectl get secret

kommands del:

kdpo  -> kubectl delete pod
kdpvc -> kubectl delete pvc
kdsvc -> kubectl delete svc
kdcm  -> kubectl delete cm
kdin  -> kubectl delete ingress
kdse  -> kubectl delete secret

kommands apply:

kapp  -> kubectl apply -f

kommand describe:

kdesc -> kubectl describe

kommands logs:

klog  -> kubectl logs -f

kommand show containers:
ksco : it returns the name of the containers that run in a specific pod

kommand execute sh:
kesh : it opens a shell in a specific pod/container

Using -n will run the command on the specified namespace.

kgpo -ntest         ->  kubectl get pods -n test
kdesc pod 1 -ntest  ->  kubectl describe first pod in namespace test
kdesc -ntest 1      ->  kubectl describe first pod in namespace test
kesh 1 2 -n test    ->  open a shell on second container of the first pod in namespace test

Alias watch

It is also possible to use watch with kommands:

For example, to add a watch alias for kgpo (kubectl get pods with their number):

bash

echo -en "export -f _add_line_nr _k_get kgpo\nalias wkgpo=\"watch -x bash -c kgpo\"" >> ~/.bashrc && source ~/.bashrc

After that, the following alias can be used:

wkgpo  -> watch kubectl get pods

some examples

get pods and their number in namespace test

$ kgpo -n test
 0 NAME                 READY   STATUS             RESTARTS   AGE
 1 echo-pod-pvc         0/1     Pending            0          103m
 2 first-pod            1/1     Running            0          2d6h
 3 pod-two-containers   2/2     Running            0          83m

get pod number 3 in namespace test

$ kgpo 3 -ntest
 0 NAME                 READY   STATUS             RESTARTS   AGE
 3 pod-two-containers   2/2     Running            0          84m

show containers of the pod number 3

$ ksco 3
 0 NAME
 1 i-am-the-first-container-in-this-pod
 2 i-am-then-the-second-container

open a shell in a container of a pod using names

$ kesh pod-[TAB] [TAB]
i-am-the-first-container-in-this-pod  i-am-then-the-second-container

$ kesh pod-two-containers i-am-then-the-second-container
You are now in pod: pod-two-containers -c i-am-then-the-second-container
/ # 

open a shell in a container of a pod using numbers

pod number 3 , container number 2

$ kesh 3 2
You are now in pod: pod-two-containers -c i-am-then-the-second-container
/ # 

get persistent volume claims

$ kgpvc
 0 NAME          STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS       AGE
 1 echo-cache2   Bound    pvc-49704fde-7d19-446c-b9f2-192e297e7f0a   1Gi        RWO            do-block-storage   111m
 2 pvc-1         Bound    pvc-4e902e87-0df7-4c3c-827c-a8c7cfd75fa5   1Gi        RWO            do-block-storage   93m

delete persistent volume claim using its number

$ kdpvc 2
do you want to remove pvc-1 (y/N)? y
persistentvolumeclaim "pvc-1" deleted

get services

$ kgsvc
 0 NAME                    TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
 1 echo-web-svc-nodeport   NodePort    10.245.124.76    <none>        8080:31777/TCP   112m
 2 kubernetes              ClusterIP   10.245.0.1       <none>        443/TCP          2d6h
 3 test-app                ClusterIP   10.245.109.229   <none>        8080/TCP         113m

describe service number 3 from namespace test2

$ kdesc svc 3 -n test2
Name:              test-app
Namespace:         test2
Labels:            name=test-app
Annotations:       Selector:  app=echo-app
Type:              ClusterIP
IP:                10.245.109.229
Port:              echo  8080/TCP
TargetPort:        8080/TCP
Endpoints:         <none>
Session Affinity:  None
Events:            <none>

get ingress

$ kgin
 0 NAME            CLASS    HOSTS            ADDRESS   PORTS   AGE
 1 test-api        <none>   api.example.com            80      20m
 2 test-frontend   <none>   example.com                80      20m

describe ingress number 1

$ kdesc in 1
Name:             test-api
Namespace:        default
Address:
Default backend:  default-http-backend:80 (<error: endpoints "default-http-backend" not found>)
Rules:
  Host          Path  Backends
  ----          ----  --------
  api.example.com
                /   test-api-service:3000 (10.244.0.234:3000)
Annotations:    ingress.kubernetes.io/ssl-redirect: true
Events:         <none>

apply manifest

$ kapp pod-1.yaml
pod/first-pod created

show logs of the pod using numbers

pod number 2 , container number 2

$ klog 2 2 | head -5
You are now showing logs of: pod-two-containers i-am-then-the-second-container
Fri Jun 26 23:00:04 UTC 2020
Fri Jun 26 23:00:05 UTC 2020
Fri Jun 26 23:00:06 UTC 2020
Fri Jun 26 23:00:07 UTC 2020

license

The source code is licensed under the GNU General Public License v3.0.

Copyright (C) 2023 jmox@pm.me

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.