Kubernetes 故障排除不再难

TonyBai 150 views 0

示意图解k8s

下面是一个示意图,可帮助你调试 Kubernetes Deployment

Kubernetes 故障排除指南(中文版).jpg

当你希望在 Kubernetes 中部署应用程序时,你通常会定义三个组件:

  • 一个 Deployment - 这是一份用于创建你的应用程序的 Pod 副本的"食谱";
  • 一个 Service - 一个内部负载均衡器,用于将流量路由到内部的 Pod 上;
  • 一个 Ingress - 描述如何流量应该如何从集群外部流入到集群内部的你的服务上。

下面让我们用示意图快速总结一下要点。

base-k8s.png

在 Kubernetes 中,你的应用程序通过两层负载均衡器暴露服务:内部的和外部的

deploys.png

Pod 不会直接部署。Deployment 会负责创建 Pod 并管理它们

假设你要部署一个简单的 "Hello World" 应用,该应用的 YAML 文件的内容应该类似下面这样:

// hello-world.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
  labels:
    track: canary
spec:
  selector:
    matchLabels:
      any-name: my-app
  template:
    metadata:
      labels:
        any-name: my-app
    spec:
      containers:
      - name: cont1
        image: learnk8s/app:1.0.0
        ports:
        - containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  ports:
  - port: 80
    targetPort: 8080
  selector:
    name: app
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: my-ingress
spec:
  rules:
  - http:
    paths:
    - backend:
        serviceName: app
        servicePort: 80
      path: /

这个定义很长,组件之间的相互关系并不容易看出来。

例如:

  • 什么时候应使用端口80,又是何时应使用端口 8080?
  • 你是否应该为每个服务创建一个新端口以免它们相互冲突?
  • 标签( label )名重要吗?它们是否在每一处都应该是一样的?

在进行调试之前,让我们回顾一下这三个组件是如何相互关联的。

让我们从 Deployment 和 Service 开始。

连接 Deployment 和 Service

令人惊讶的消息是,Service 和 Deployment 之间根本没有连接。

事实是:Service 直接指向 Pod,并完全跳过了 Deployment。

因此,你应该注意的是 Pod 和 Service 之间的相互关系。

你应该记住三件事:

  • Service selector 应至少与 Pod 的一个标签匹配;
  • Service的 targetPort 应与Pod中容器的 containerPort 匹配;
  • Service的 port 可以是任何数字。多个 Service 可以使用同一端口号,因为它们被分配了不同的 IP 地址。

下面的图总结了如何连接端口

port.png

 

考虑上面被一个服务暴露的 Pod

port-containerport.png

创建pod时,应为pod中的每个容器定义containerport端口

every-ports.png

当创建一个 Service 时,你可以定义 port 和 targetPort,但是哪个用来连接容器呢?

should-match.png

targetPort 和 containerPort 应该始终保持匹配

should-match-too.png

如果容器暴露 3000 端口(containerPort),那么 targetPort 应该匹配这一个端口号

再来看看 YAML,标签和 ports/targetPort 应该匹配:

// hello-world.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
  labels:
    track: canary
spec:
  selector:
    matchLabels:
      any-name: my-app
  template:
    metadata:
      labels:
        any-name: my-app
    spec:
      containers:
      - name: cont1
        image: learnk8s/app:1.0.0
        ports:
        - containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  ports:
  - port: 80
    targetPort: 8080
  selector:
    any-name: my-app

那 deployment 顶部的track: canary 标签呢?

它也应该匹配吗?

该标签属于 deployment,service 的选择器未使用它来路由流量。

换句话说,你可以安全地删除它或为其分配其他值。

那 matchLabels 选择器呢?

它必须始终与 Pod 的标签匹配,并且被 Deployment 用来跟踪 Pod。

假设你已经进行了所有正确的设置,该如何测试它呢?

你可以使用以下命令检查 Pod 是否具有正确的标签:

$ kubectl get pods --show-labels

或者,如果你拥有属于多个应用程序的 Pod:

$ kubectl get pods --selector any-name=my-app --show-labels

any-name=my-app 就是标签 any-name: my-app

还有问题吗?

你也可以连接到 Pod!

你可以使用 kubectl 中的 port-forward 命令连接到 service 并测试连接。

$ kubectl port-forward service/<service name> 3000:80
  • service/ 是服务的名称- 在上面的 YAML 中是 “my-service”
  • 3000 是你希望在计算机上打开的端口
  • 80 是 service 通过 port 字段暴露的端口

如果可以连接,则说明设置正确。

如果不行,则很可能是你填写了错误的标签或端口不匹配。

连接 Service 和 Ingress

接下来是配置 Ingress 以将你的应用暴露到集群外部。

Ingress 必须知道如何检索服务,然后检索 Pod 并将流量路由给它们。

Ingress 按名字和暴露的端口检索正确的服务。

在 Ingress 和 Service 中应该匹配两件事:

  • Ingress 的 servicePort 应该匹配 service 的 port
  • Ingress 的 serviceName 应该匹配服务的 name

下面的图总结了如何连接端口:

port.png

你已经知道 servive 暴露一个 port

serviceport+port.png

Ingress 有一个字段叫 servicePort

shouldmatch.png

service 的 port 和 Ingress 的 service 应该始终保持匹配

 

shouldmatch-2.png

如果你为 service 指定的 port 是80,那么你也应该将 ingress 的 servicePort 改为 80

实践中,你应该查看以下几行(下面代码中的 my-service 和 80):

// hello-world.yaml

apiVersion: v1
kind: Service
metadata:
  name: my-service   --- 需关注
spec:
  ports:
  - port: 80       --- 需关注
    targetPort: 8080
  selector:
    any-name: my-app
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: my-ingress
spec:
  rules:
  - http:
    paths:
    - backend:
        serviceName: my-service --- 需关注
        servicePort: 80 --- 需关注
      path: /

你如何测试 Ingress 是否正常工作呢?

你可以使用与以前相同的策略 kubectl port-forward,但是这次你应该连接到 Ingress 控制器,而不是连接到 Service。

首先,使用以下命令检索 Ingress 控制器的 Pod 名称:

$ kubectl get pods --all-namespaces
NAMESPACE   NAME                              READY STATUS
kube-system coredns-5644d7b6d9-jn7cq          1/1   Running
kube-system etcd-minikube                     1/1   Running
kube-system kube-apiserver-minikube           1/1   Running
kube-system kube-controller-manager-minikube  1/1   Running
kube-system kube-proxy-zvf2h                  1/1   Running
kube-system kube-scheduler-minikube           1/1   Running
kube-system nginx-ingress-controller-6fc5bcc  1/1   Running

标识 Ingress Pod(可能在其他命名空间中)并描述它以检索端口:

$ kubectl describe pod nginx-ingress-controller-6fc5bcc \
 --namespace kube-system \
 | grep Ports
Ports:         80/TCP, 443/TCP, 18080/TCP

最后,连接到 Pod:

$ kubectl port-forward nginx-ingress-controller-6fc5bcc 3000:80 --namespace kube-system

此时,每次你访问计算机上的端口3000时,请求都会转发到 Ingress 控制器 Pod 上的端口 80。

如果访问 http://localhost:3000,则应找到提供网页服务的应用程序。

回顾 Port

快速回顾一下哪些端口和标签应该匹配:

  • service selector 应与 Pod 的标签匹配
  • service 的 targetPort 应与 Pod 中容器的 containerPort 匹配
  • service 的端口可以是任何数字。多个服务可以使用同一端口,因为它们分配了不同的IP地址。
  • ingress 的 servicePort 应该匹配 service 的 port•serivce 的名称应与 ingress 中的 serviceName 字段匹配

知道如何构造 YAML 定义只是故事的一部分。

出了问题后该怎么办?

Pod 可能无法启动,或者正在崩溃。

Kubernetes Deployment 故障排除的 3 个步骤

在深入研究失败的 Deployment 之前,我们必须对 Kubernetes 的工作原理有一个明确定义的思维模型。

由于每个 Deployment 中都有三个组件,因此你应该自下而上依次调试所有组件。

  • 你应该先确保 Pods 正在运行
  • 然后,专注于让 service 将流量路由到到正确的 Pod
  • 然后,检查是否正确配置了 Ingress

1.png

你应该从底部开始对 deployment 进行故障排除。首先,检查 Pod 是否已就绪并正在运行。

2.png

如果 Pod 已就绪,则应调查 service 是否可以将流量分配给 Pod。

3.png

最后,你应该检查 service 与 ingress 之间的连接。

1. Pod 故障排除

在大多数情况下,问题出在 Pod 本身。

你应该确保 Pod 正在运行并准备就绪。

该如何检查呢?

$ kubectl get pods
NAME                    READY STATUS            RESTARTS  AGE
app1                    0/1   ImagePullBackOff  0         47h
app2                    0/1   Error             0         47h
app3-76f9fcd46b-xbv4k   1/1   Running           1         47h

在上述会话中,最后一个 Pod 处于就绪并正常运行的状态;但是,前两个 Pod 既不处于 Running 也不是 Ready。

你如何调查出了什么问题?

有四个有用的命令可以对 Pod 进行故障排除:

  • kubectl logs 有助于检索 Pod 容器的日志
  • kubectl describe pod 检索与 Pod 相关的事件列表很有用
  • kubectl get pod 用于提取存储在 Kubernetes 中的 Pod 的 YAML 定义
  • kubectl exec -ti bash 在 Pod 的一个容器中运行交互式命令很有用

应该使用哪一个呢?

没有一种万能的。

相反,我们应该结合着使用它们。

常见 Pod 错误

Pod 可能会出现启动和运行时错误。

启动错误包括:
  • ImagePullBackoff
  • ImageInspectError
  • ErrImagePull
  • ErrImageNeverPull
  • RegistryUnavailable
  • InvalidImageName
运行时错误包括:
  • CrashLoopBackOff
  • RunContainerError
  • KillContainerError
  • VerifyNonRootError
  • RunInitContainerError
  • CreatePodSandboxError
  • ConfigPodSandboxError
  • KillPodSandboxError
  • SetupNetworkError
  • TeardownNetworkError

有些错误比其他错误更常见。

以下是最常见的错误列表以及如何修复它们的方法。

ImagePullBackOff

当 Kubernetes 无法获取到 Pod 中某个容器的镜像时,将出现此错误。

共有三个可能的原因:

  • 镜像名称无效-例如,你拼错了名称,或者 image 不存在
  • 你为 image 指定了不存在的标签
  • 你尝试检索的 image 属于一个私有 registry,而 Kubernetes 没有凭据可以访问它

前两种情况可以通过更正 image 名称和标记来解决。

针对第三种情况,你应该将私有 registry 的访问凭证通过 Secret 添加到 k8s 中并在 Pod 中引用它。

官方文档中有一个有关如何实现此目标的示例。

CrashLoopBackOff

如果容器无法启动,则 Kubernetes 将显示错误状态为:CrashLoopBackOff。

通常,在以下情况下容器无法启动:

  • 应用程序中存在错误,导致无法启动
  • 你未正确配置容器
  • Liveness 探针失败太多次

你应该尝试从该容器中检索日志以调查其失败的原因。

如果由于容器重新启动太快而看不到日志,则可以使用以下命令:

$ kubectl logs <pod-name> --previous

这个命令打印前一个容器的错误消息。

RunContainerError

当容器无法启动时,出现此错误。

甚至在容器内的应用程序启动之前。

该问题通常是由于配置错误,例如:

  • 挂载不存在的卷,例如 ConfigMap 或 Secrets
  • 将只读卷安装为可读写

你应该使用 kubectl describe pod 命令收集和分析错误。

处于 Pending 状态的 Pod

当创建 Pod 时,该 Pod 保持 Pending 状态。

为什么?

假设你的调度程序组件运行良好,可能的原因如下:

  • 集群没有足够的资源(例如 CPU 和内存)来运行Pod
  • 当前的命名空间具有 ResourceQuota 对象,创建 Pod 将使命名空间超过配额
  • 该 Pod 绑定到一个处于 pending 状态的 PersistentVolumeClaim

最好的选择是检查kubectl describe命令输出的“事件”部分内容:

$ kubectl describe pod <pod name>

对于因 ResourceQuotas 而导致的错误,可以使用以下方法检查集群的日志:

$ kubectl get events --sort-by=.metadata.creationTimestamp

处于未就绪状态的 Pod
如果 Pod 正在运行但未就绪(not ready),则表示 readiness 就绪探针失败。

当“就绪”探针失败时,Pod 未连接到服务,并且没有流量转发到该实例。

就绪探针失败是应用程序的特定错误,因此你应检查 kubectl describe 中的“ 事件”部分以识别错误。

2. 服务的故障排除

如果你的 Pod 正在运行并处于就绪状态,但仍无法收到应用程序的响应,则应检查服务的配置是否正确。

service 旨在根据流量的标签将流量路由到 Pod。

因此,你应该检查的第一件事是服务关联了多少个 Pod。

你可以通过检查服务中的端点( endpoint )来做到这一点:

$ kubectl describe service <service-name> | grep Endpoints

端点是一对,并且在服务(至少)以 Pod 为目标时,应该至少有一个端点。

如果“端点”部分为空,则有两种解释:

  • 你没有运行带有正确标签的 Pod(提示:你应检查自己是否在正确的命名空间中)
  • service 的 selector 标签上有错字

如果你看到端点列表,但仍然无法访问你的应用程序,则 targetPort 可能是你服务中的罪魁祸首。

你如何测试服务?

无论服务类型如何,你都可以使用 kubectl port-forward 来连接它:

$ kubectl port-forward service/<service-name> 3000:80

这里:

  • 是服务的名称
  • 3000 是你希望在计算机上打开的端口
  • 80 是服务公开的端口

3.Ingress 的故障排除

如果你已到达本节,则:

  • Pod 正在运行并准备就绪
  • 服务会将流量分配到 Pod

但是你仍然看不到应用程序的响应。

这意味着最有可能是Ingress配置错误。

由于正在使用的 Ingress 控制器是集群中的第三方组件,因此有不同的调试技术,具体取决于 Ingress 控制器的类型。

但是在深入研究 Ingress 专用工具之前,你可以用一些简单的方法进行检查。

Ingress 使用 serviceName 和 servicePort 连接到服务。

你应该检查这些配置是否正确。

你可以通过下面命令检查 Ingress 配置是否正确:

$ kubectl describe ingress <ingress-name>

如果 backend 一列为空,则配置中必然有一个错误。

如果你可以在 “backend” 列中看到端点,但是仍然无法访问该应用程序,则可能是以下问题:

  • 你如何将 Ingress 暴露于公共互联网
  • 你如何将集群暴露于公共互联网

你可以通过直接连接到 Ingress Pod 来将基础结构问题与 Ingress 隔离开。

首先,获取你的 Ingress 控制器 Pod(可以位于其他名称空间中):

$ kubectl get pods --all-namespaces
NAMESPACE   NAME                              READY STATUS
kube-system coredns-5644d7b6d9-jn7cq          1/1   Running
kube-system etcd-minikube                     1/1   Running
kube-system kube-apiserver-minikube           1/1   Running
kube-system kube-controller-manager-minikube  1/1   Running
kube-system kube-proxy-zvf2h                  1/1   Running
kube-system kube-scheduler-minikube           1/1   Running
kube-system nginx-ingress-controller-6fc5bcc  1/1   Running

描述它以检索端口:

$ kubectl describe pod nginx-ingress-controller-6fc5bcc
 --namespace kube-system \
 | grep Ports

最后,连接到 Pod:

$ kubectl port-forward nginx-ingress-controller-6fc5bcc 3000:80 --namespace kube-system

此时,每次你访问计算机上的端口 3000 时,请求都会转发到 Pod 上的端口 80。

现在可以用吗?

  • 如果可行,则问题出在基础架构中。你应该调查流量如何路由到你的集群。
  • 如果不起作用,则问题出在 Ingress 控制器中。你应该调试 Ingress。

如果仍然无法使 Ingress 控制器正常工作,则应开始对其进行调试。

目前有许多不同版本的 Ingress 控制器。

热门选项包括 Nginx,HAProxy,Traefik 等。

你应该查阅 Ingress 控制器的文档以查找故障排除指南。

由于 Ingress Nginx 是最受欢迎的 Ingress 控制器,因此在下一部分中我们将介绍一些有关调试 ingress-nginx 的技巧。

调试 Ingress Nginx

Ingress-nginx 项目有一个 Kubectl 的官方插件。

你可以用 kubectl ingress-nginx 来:

  • 检查日志,后端,证书等。
  • 连接到 ingress
  • 检查当前配置

你应该尝试的三个命令是:

  • kubectl ingress-nginx lint,它会检查 nginx.conf
  • kubectl ingress-nginx backend,以检查后端(类似于 kubectl describe ingress )
  • kubectl ingress-nginx logs,查看日志

请注意,你可能需要为 Ingress 控制器指定正确的名称空间 --namespace 。

总结

如果你不知道从哪里开始,那么在 Kubernetes 中进行故障排除可能是一项艰巨的任务。

你应该始终牢记从下至上解决问题:从 Pod 开始,然后通过 Service 和 Ingress 向上移动堆栈。

你在本文中了解到的调试技术也可以应用于其他对象,例如:

  • failing Job 和 CronJob
  • StatefulSets 和 DaemonSets

本文翻译自 learnk8s 上的文章 A visual guide on troubleshooting Kubernetes deployments

发表评论 取消回复
表情 图片 链接 代码

分享