# 排错概览

Kubernetes 集群以及应用排错的一般方法，主要包括

* [集群状态异常排错](https://kubernetes.feisky.xyz/troubleshooting/cluster)
* [Pod运行异常排错](https://kubernetes.feisky.xyz/troubleshooting/pod)
* [网络异常排错](https://kubernetes.feisky.xyz/troubleshooting/network)
* [持久化存储异常排错](https://kubernetes.feisky.xyz/troubleshooting/pv)
  * [AzureDisk 排错](https://kubernetes.feisky.xyz/troubleshooting/pv/azuredisk)
  * [AzureFile 排错](https://kubernetes.feisky.xyz/troubleshooting/pv/azurefile)
* [Windows容器排错](https://kubernetes.feisky.xyz/troubleshooting/windows)
* [云平台异常排错](https://kubernetes.feisky.xyz/troubleshooting/cloud)
  * [Azure 排错](https://kubernetes.feisky.xyz/troubleshooting/cloud/azure)
* [常用排错工具](https://kubernetes.feisky.xyz/troubleshooting/tools)

你可以使用 [kube-copilot](https://github.com/feiskyer/kube-copilot) 借助 OpenAI 来帮你自动排查集群中的问题并通过自然语言的方式与集群进行交互。

在排错过程中，`kubectl` 是最重要的工具，通常也是定位错误的起点。这里也列出一些常用的命令，在后续的各种排错过程中都会经常用到。

### 查看 Pod 状态以及运行节点

```bash
kubectl get pods -o wide
kubectl -n kube-system get pods -o wide
```

### 查看 Pod 事件

```bash
kubectl describe pod <pod-name>
```

### 查看 Node 状态

```bash
kubectl get nodes
kubectl describe node <node-name>
```

### kube-apiserver 日志

```bash
PODNAME=$(kubectl -n kube-system get pod -l component=kube-apiserver -o jsonpath='{.items[0].metadata.name}')
kubectl -n kube-system logs $PODNAME --tail 100
```

以上命令操作假设控制平面以 Kubernetes 静态 Pod 的形式来运行。如果 kube-apiserver 是用 systemd 管理的，则需要登录到 master 节点上，然后使用 journalctl -u kube-apiserver 查看其日志。

### kube-controller-manager 日志

```bash
PODNAME=$(kubectl -n kube-system get pod -l component=kube-controller-manager -o jsonpath='{.items[0].metadata.name}')
kubectl -n kube-system logs $PODNAME --tail 100
```

以上命令操作假设控制平面以 Kubernetes 静态 Pod 的形式来运行。如果 kube-controller-manager 是用 systemd 管理的，则需要登录到 master 节点上，然后使用 journalctl -u kube-controller-manager 查看其日志。

### kube-scheduler 日志

```bash
PODNAME=$(kubectl -n kube-system get pod -l component=kube-scheduler -o jsonpath='{.items[0].metadata.name}')
kubectl -n kube-system logs $PODNAME --tail 100
```

以上命令操作假设控制平面以 Kubernetes 静态 Pod 的形式来运行。如果 kube-scheduler 是用 systemd 管理的，则需要登录到 master 节点上，然后使用 journalctl -u kube-scheduler 查看其日志。

### kube-dns 日志

kube-dns 通常以 Addon 的方式部署，每个 Pod 包含三个容器，最关键的是 kubedns 容器的日志：

```bash
PODNAME=$(kubectl -n kube-system get pod -l k8s-app=kube-dns -o jsonpath='{.items[0].metadata.name}')
kubectl -n kube-system logs $PODNAME -c kubedns
```

### Kubelet 日志

Kubelet 通常以 systemd 管理。查看 Kubelet 日志需要首先 SSH 登录到 Node 上，推荐使用 [kubectl-node-shell](https://github.com/kvaps/kubectl-node-shell) 插件而不是为每个节点分配公网 IP 地址。比如：

```bash
curl -LO https://github.com/kvaps/kubectl-node-shell/raw/master/kubectl-node_shell
chmod +x ./kubectl-node_shell
sudo mv ./kubectl-node_shell /usr/local/bin/kubectl-node_shell

kubectl node-shell <node>
journalctl -l -u kubelet
```

### Kube-proxy 日志

Kube-proxy 通常以 DaemonSet 的方式部署，可以直接用 kubectl 查询其日志

```bash
$ kubectl -n kube-system get pod -l component=kube-proxy
NAME               READY     STATUS    RESTARTS   AGE
kube-proxy-42zpn   1/1       Running   0          1d
kube-proxy-7gd4p   1/1       Running   0          3d
kube-proxy-87dbs   1/1       Running   0          4d
$ kubectl -n kube-system logs kube-proxy-42zpn
```

## 参考文档

* [hjacobs/kubernetes-failure-stories](https://github.com/hjacobs/kubernetes-failure-stories) 整理了一些公开的 Kubernetes 异常案例。
* <https://docs.microsoft.com/en-us/azure/aks/troubleshooting> 包含了 AKS 中排错的一般思路
* <https://cloud.google.com/kubernetes-engine/docs/troubleshooting> 包含了 GKE 中问题排查的一般思路
* <https://www.oreilly.com/ideas/kubernetes-recipes-maintenance-and-troubleshooting>