10个必须掌握的Kubernetes命令和工具

左手的ㄟ右手 2023-01-11 01:16 451阅读 0赞

### 文章目录 ###

*  10个必须掌握的Kubernetes命令和工具
 *   *  前言
     *  命令和工具列表
     *  命令和工具详解
     *   *  Kubens - 切换namespace
         *  Kubeshell - 命令提示和自动完成
         *  Dive - 镜像分析工具
         *  Kube-PS1 - Kubernetes命令行提示
         *  Stern - 日志归集查找工具
         *  Kubectl
         *   *  tab键自动完成
             *  编辑YAML时语法高亮

# 10个必须掌握的Kubernetes命令和工具 #

## 前言 ##

本文根据[10 awesome Kubernetes tools every user should know | DevNation Tech Talk][10 awesome Kubernetes tools every user should know _ DevNation Tech Talk] 整理而成。

## 命令和工具列表 ##

<table> 
 <thead> 
  <tr> 
   <th>命令和工具</th> 
   <th>说明</th> 
   <th>常用指数</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://k9scli.io/" rel="nofollow">k9s</a></td> 
   <td>命令行风格的Kubernetes控制台。</td> 
   <td><code>*</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/ahmetb/kubectl-aliases" rel="nofollow">Kubectl aliases</a></td> 
   <td><code>kubectl</code> 命令别名。</td> 
   <td><code>**</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/wercker/stern" rel="nofollow">Stern</a></td> 
   <td>Pod和容器日志归集查找工具。<code>Debug工具</code></td> 
   <td><code>****</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/wagoodman/dive" rel="nofollow">Dive</a></td> 
   <td>镜像分析工具，支持Docker和Podman。<code>安全工具</code> <code>性能工具</code></td> 
   <td><code>****</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/ahmetb/kubectx" rel="nofollow">Kubens</a></td> 
   <td>切换namespace。<code>效率工具</code></td> 
   <td><code>*****</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/jonmosco/kube-ps1" rel="nofollow">Kube-PS1</a></td> 
   <td>Kubernetes命令行提示。</td> 
   <td><code>****</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/ahmetb/kubectx" rel="nofollow">Kubectx</a></td> 
   <td>切换context。</td> 
   <td><code>**</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/pulumi/kubespy" rel="nofollow">KubeSpy</a></td> 
   <td>实时观测Kubernetes资源。<code>Debug工具</code></td> 
   <td><code>***</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/cloudnativelabs/kube-shell" rel="nofollow">Kube-Shell</a></td> 
   <td><code>kubectl</code>命令提示和自动完成，可以选择pod而不需要复制粘贴。<code>效率工具</code></td> 
   <td><code>**</code></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/kubernetes/kubectl" rel="nofollow">Kubectl</a></td> 
   <td><code>kubectl</code>命令行工具。</td> 
   <td><code>*****</code></td> 
  </tr> 
 </tbody> 
</table>

下面介绍几个最为常用的命令和工具。

## 命令和工具详解 ##

### Kubens - 切换namespace ###

[Kubens][]

安装：

# MacOS
    # 安装kubectx时会同时安装kubens
    brew install kubectx

使用：

# 列出namespace
    # 高亮显示当前namespace
    kubens
    
    # 切换namespace
    kubens <ns-name>
    
    # 查看当前namespace
    # -c, --current
    kubens -c
    
    # 切换回上一个namespace
    kubens -
    
    # 查看帮助
    # -h, --help
    kubens -h

### Kubeshell - 命令提示和自动完成 ###

[Kube-Shell][]

安装：

# MacOS
    # Python3
    pip3 install kube-shell

使用：

# start kube-shell
    kube-shell
    
    # exit kube-shell
    exit
    
    # 清空屏幕
    clear
    
    # 提示
    <tab> key
    
    # 选择
    <up> / <down> key

> 在MacOS上，kube-shell-0.0.23 的Server Side Auto Completion 功能不正常。
> 
> 该项目已经有2年没有维护！！

### Dive - 镜像分析工具 ###

[Dive][]

安装：

# MacOS
    brew install dive

使用：

# 分析Docker镜像
    # 默认source为Docker
    dive <image>
    
    # 分析Podman镜像
    dive <image> --source podman
    
    # 退出
    <control> + <C>
    
    # 左边屏幕为镜像的分层（Layers），右边屏幕为每一层的内容（Current Layer Content)
    
    # 切换屏幕（视图）
    <tab> key	
    
    # 在右边屏幕的文件树
    # 折叠或展开目录
    <space>
    # 回到父目录
    <left>
    # 进到子目录
    <right>
    
    # 左边屏幕包括：
    # - Layers 镜像的分层，可以查看每层的大小（size）和命令（command）
    # 选择某一层
    <up> / <down> key
    
    # 选择某一层时，右边屏幕高亮显示每一层改动的内容
    # 按层显示改动内容（Show layer changes)
    <control> + <L>
    # 显示汇总后的改动内容，也就是当前层以及前面层的改动内容（Show aggregated changes)
    <control> + <A>
    
    # 左边屏幕还可查看总共的镜像大小（Total Image size)和镜像效率（Image efficiency score）
    # Image efficiency score 越接近100%，说明镜像越有效
    # Potential wasted space 表示可能的重复层，该值越小越好

### Kube-PS1 - Kubernetes命令行提示 ###

[Kube-PS1][]

安装：

# MacOS
    # Install from source
    git clone https://github.com/jonmosco/kube-ps1.git
    
    
    # zsh
    # Add below contents on ~/.zshrc
    source /path/to/kube-ps1/kube-ps1.sh
    PROMPT='$(kube_ps1)'$PROMPT
    
    # source ~/.zshrc
    source ~/.zshrc
    
    
    # bash
    # Add below contents on ~/.bashrc
    source /path/to/kube-ps1/kube-ps1.sh
    PS1='[\u@\h \W $(kube_ps1)]\$ '
    
    # source ~/.bashrc
    source ~/.bashrc

使用：

# 启用kube-ps1
    kubeon
    
    # 默认提示的格式
    # symbol - 图标或图片
    # context - 上下文，包括集群API server URL，当前用户名
    # namespace - 当前namespace / project
    <symbol>|<context>:<namespace>
    
    
    # 停用kube-ps1
    kubeoff
    
    # 查看命令行工具
    # 默认为kubectl
    # 如果使用OpenShift，也可以设置该值为oc。
    echo $KUBE_PS1_BINARY

如果觉得提示太长，可以选择只显示namespace：

以zsh为例，`~/.zshrc` 中的kube-ps1设置类似：

# kube-ps1
    export KUBE_PS1_CONTEXT_ENABLE=false
    export KUBE_PS1_SYMBOL_ENABLE=false
    source /path/to/kube-ps1/kube-ps1.sh
    PROMPT='$(kube_ps1)'$PROMPT

运行 `source ~/.zshrc` 让设置生效。  
重开一个新的Terminal来验证。

### Stern - 日志归集查找工具 ###

[Stern][]

安装：

# MacOS
    brew install stern

用法：

# 在多个Pod中查找日志
    # pod-query - 一般为Pod名称的前缀
    # 根据关键字筛选，并高亮显示关键字
    stern <pod-query> | grep <keyword> --color
    
    # 查看2分钟前的日志
    stern <pod-query> --since 2m
    
    # 查看30秒前的日志
    stern <pod-query> --since 30s

### Kubectl ###

#### tab键自动完成 ####

`kubectl` 支持按下tab键自动完成（补全）命令，还可以用来补全资源名称，比如Pod名称，这样就不用复制粘贴Pod名称了。

设置之后就不再需要上面提到的kube-shell了。

配置：

# MacOS zsh
    # generate kubectl_zsh_completion
    kubectl completion zsh > kubectl_zsh_completion
    
    # add kubectl_zsh_completion to ~/.zshrc
    source /path/to/kubectl_zsh_completion
    
    # source ~/.zshrc
    source ~/.zshrc

参见 ：

*  [https://kubernetes.io/docs/reference/kubectl/cheatsheet/\#kubectl-autocomplete][https_kubernetes.io_docs_reference_kubectl_cheatsheet_kubectl-autocomplete]

类似地也可用`oc completion` 命令来设置OpenShift的命令自动完成功能:

oc completion bash >/etc/bash_completion.d/openshift

#### 编辑YAML时语法高亮 ####

# set default editor
    export EDITOR=vim
    
    # syntax highlight when edit yaml
    kubectl edit ...

Mac上开启vim语法高亮：

# enable vim syntax highlight
    cp /usr/share/vim/vimrc ~/.vimrc
    # add below content in ~/.vimrc
    syntax on

[10 awesome Kubernetes tools every user should know _ DevNation Tech Talk]: https://www.youtube.com/watch?v=5eIlfNGGuU8
[Kubens]: https://github.com/ahmetb/kubectx
[Kube-Shell]: https://github.com/cloudnativelabs/kube-shell
[Dive]: https://github.com/wagoodman/dive
[Kube-PS1]: https://github.com/jonmosco/kube-ps1
[Stern]: https://github.com/wercker/stern
[https_kubernetes.io_docs_reference_kubectl_cheatsheet_kubectl-autocomplete]: https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-autocomplete