From 34d0a6f2ce817338ce5b215573eff0240701ee1a Mon Sep 17 00:00:00 2001 From: bryan Date: Wed, 30 Sep 2020 17:12:06 +0800 Subject: [PATCH] resolve conflicts --- .../debug-running-pod.md | 214 +++++++++--------- 1 file changed, 104 insertions(+), 110 deletions(-) diff --git a/content/zh/docs/tasks/debug-application-cluster/debug-running-pod.md b/content/zh/docs/tasks/debug-application-cluster/debug-running-pod.md index 6863fcb723..358ee111c3 100644 --- a/content/zh/docs/tasks/debug-application-cluster/debug-running-pod.md +++ b/content/zh/docs/tasks/debug-application-cluster/debug-running-pod.md @@ -2,27 +2,16 @@ title: 调试运行中的 Pod content_type: task --- - - - -本页解释了如何调试节点上正在运行(或者正在崩溃)的 Pod。 - - +本页解释如何在节点上调试运行中（或崩溃）的 Pod。 ## {{% heading "prerequisites" %}} - - -* 你的 {{< glossary_tooltip text="Pod" term_id="pod" >}} - 应该已经调度并正在运行。 - 如果 Pod 尚未运行，则从 - [应用故障排查](/zh/docs/tasks/debug-application-cluster/debug-application/) 开始。 -* 对于一些高级调试步骤， - 你需要知道 Pod 在哪个节点上运行，并拥有在该节点上执行 shell 命令的权限。 - 在使用 `kubectl` 运行标准调试步骤时，则不需要这种权限。 - +* 你的 {{< glossary_tooltip text="Pod" term_id="pod" >}} 应该已经被调度并正在运行中， +如果你的 Pod 还没有运行，请参阅[应用问题排查](/docs/tasks/debug-application-cluster/debug-application/)。 +* 对于一些高级调试步骤，你应该知道 Pod 具体运行在哪个节点上，在该节点上有权限去运行一些命令。 + 你不需要任何访问权限就可以使用 `kubectl` 去运行一些标准调试步骤。 @@ -46,19 +31,26 @@ This page explains how to debug Pods running (or crashing) on a Node. ## Examining pod logs {#examine-pod-logs} First, look at the logs of the affected container: ---> -## 检查 Pod 日志 {#examine-pod-logs} - -首先，查看受影响的容器的日志： ```shell kubectl logs ${POD_NAME} ${CONTAINER_NAME} ``` - -如果你的容器以前崩溃过，你可以访问前一个容器的崩溃日志： +## 检查 Pod 的日志 {#examine-pod-logs} + +首先，查看受到影响的容器的日志： + +```shell +kubectl logs ${POD_NAME} ${CONTAINER_NAME} +``` + +如果你的容器之前崩溃过，你可以通过下面命令访问之前容器的崩溃日志： ```shell kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME} @@ -67,64 +59,58 @@ kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME} -## 使用容器 exec 调试 {#container-exec} - -如果 {{< glossary_tooltip text="容器镜像" term_id="image" >}} -包含调试工具，就像基于 Linux 和 Windows 基础镜像构建的镜像一样， -你可以使用 `kubectl exec` 在特定的容器中执行命令： - ```shell kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN} ``` - -{{< note >}} -`-c ${CONTAINER_NAME}` 是可选项。 -对于单容器 Pod，可以省略此参数。 -{{< /note >}} - - -例如，要查看正在运行的 Cassandra Pod 的日志，可以执行： ```shell kubectl exec cassandra -- cat /var/log/cassandra/system.log ``` - -你可以使用 `kubectl exec` 的 `-i` 和 `-t` 参数启动一个连接到终端的 shell，例如： ```shell kubectl exec -it cassandra -- sh ``` - -更多细节，参见 -[获取运行容器的 Shell]( -/zh/docs/tasks/debug-application-cluster/get-shell-running-container/)。 +## 使用容器 exec 进行调试 {#container-exec} + +如果 {{< glossary_tooltip text="容器镜像" term_id="image" >}} 包含调试程序， +比如从 Linux 和 Windows 操作系统基础镜像构建的镜像，你可以使用 `kubectl exec` 命令 +在特定的容器中运行一些命令： + +```shell +kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN} +``` +{{< note >}} +`-c ${CONTAINER_NAME}` 是可选择的。如果Pod中仅包含一个容器，就可以忽略它。 +{{< /note >}} + +例如，要查看正在运行的 Cassandra pod中的日志，可以运行： + +```shell +kubectl exec cassandra -- cat /var/log/cassandra/system.log +``` + +你可以在 `kubectl exec` 命令后面加上 `-i` 和 `-t` 来运行一个连接到你的终端的 Shell，比如： + +```shell +kubectl exec -it cassandra -- sh +``` + +若要了解更多内容，可查看[获取正在运行容器的 Shell](/zh/docs/tasks/debug-application-cluster/get-shell-running-container/)。 -## 使用临时调试容器进行调试 {#ephemeral-container} {{< feature-state state="alpha" for_k8s_version="v1.18" >}} - -因为容器已经崩溃，或因为容器镜像没有内含调试工具，比如 -[distroless images](https://github.com/GoogleContainerTools/distroless)， -导致 `kubectl exec` 不足以解决问题时， -{{< glossary_tooltip text="Ephemeral containers" term_id="ephemeral-container" >}} -对交互式故障诊断非常有用。 -从 `v1.18` 开始，`kubectl` 提供 alpha 命令，它可以为调试创建临时容器。 +## 使用临时调试容器来进行调试 {#ephemeral-container} + +{{< feature-state state="alpha" for_k8s_version="v1.18" >}} + +当由于容器崩溃或容器镜像不包含调试程序（例如[无发行版镜像](https://github.com/GoogleContainerTools/distroless)等） +而导致 `kubectl exec` 无法运行时，{{< glossary_tooltip text="临时容器" term_id="ephemeral-container" >}}对于排除交互式故障很有用。 -## 示例：使用临时容器调试 {#ephemeral-container-example} -{{< note >}} -本节中的示例要求在集群启用 `EphemeralContainers` [特性门控]( -/zh/docs/reference/command-line-tools-reference/feature-gates/ -)。 -并且要求 `kubectl` v1.18 或更高版本。 -{{< /note >}} - - - -可以使用 `kubectl alpha debug` 命令将临时容器添加到正在运行的 Pod 中。 -首先，为本例创建一个 Pod： ```shell kubectl run ephemeral-demo --image=k8s.gcr.io/pause:3.1 --restart=Never ``` - +## 使用临时容器来调试的例子 {#ephemeral-container-example} + {{< note >}} -本节在示例中使用 `pause` 容器镜像， -是因为它不包含用户态的调试工具。 -但此方法适用于所有容器镜像。 +本示例需要你的集群已经开启 `EphemeralContainers` [特性门控](/zh/docs/reference/command-line-tools-reference/feature-gates/)， +`kubectl` 版本为 v1.18 或者更高。 {{< /note >}} -如果你试图使用 `kubectl exec` 去建立一个 shell， -你会看到一个报错， -这是因为在容器镜像中并没有包含 shell。 +你可以使用 `kubectl alpha debug` 命令来给正在运行中的 Pod 增加一个临时容器。 +首先，像示例一样创建一个 pod： + +```shell +kubectl run ephemeral-demo --image=k8s.gcr.io/pause:3.1 --restart=Never +``` + +{{< note >}} +本节示例中使用 `pause` 容器镜像，因为它不包含任何用户级调试程序，但是这个方法适用于所有容器镜像。 +{{< /note >}} + + -你可以使用 `kubectl alpha debug` 添加一个调试容器。 -如果指定了 `-i`/`--interactive` 参数， -`kubectl` 将自动连接到临时容器的控制台。 +如果你尝试使用 `kubectl exec` 来创建一个 shell，你将会看到一个错误，因为这个容器镜像中没有 shell。 + +```shell +kubectl exec -it ephemeral-demo -- sh +``` + +``` +OCI runtime exec failed: exec failed: container_linux.go:346: starting container process caused "exec: \"sh\": executable file not found in $PATH": unknown +``` + +你可以改为使用 `kubectl alpha debug` 添加调试容器。 +如果你指定 `-i` 或者 `--interactive` 参数，`kubectl` 将自动挂接到临时容器的控制台。 ```shell kubectl alpha debug -it ephemeral-demo --image=busybox --target=ephemeral-demo @@ -227,19 +225,16 @@ isolated process namespace. You can view the state of the newly created ephemeral container using `kubectl describe`: --> -此命令添加一个新的 busybox 容器并连接。 -`--target` 参数指定了另一个容器的进程命名空间。 -这里必须这样做，因为 `kubectl run` 没有在它创建的 Pod 中启用 -[进程命名空间共享](/zh/docs/tasks/configure-pod-container/share-process-namespace/) 。 +此命令添加一个新的 busybox 容器并将其挂接到该容器。`--target` 参数指定另一个容器的进程命名空间。 +这是必需的，因为 `kubectl run` 不能在它创建的pod中启用 +[共享进程命名空间](/zh/docs/tasks/configure-pod-container/share-process-namespace/)。 {{< note >}} -{{< glossary_tooltip text="Container Runtime" term_id="container-runtime" >}} -必须支持 `--target` 参数。 -如果不支持，临时容器可能无法启动， -或者可能使用隔离的进程名称空间启动。 +{{< glossary_tooltip text="容器运行时" term_id="container-runtime" >}}必须支持`--target`参数。 +如果不支持，则临时容器可能不会启动，或者可能使用隔离的进程命名空间启动。 {{< /note >}} -可以使用 `kubectl describe` 查看新创建的临时容器的状态： +你可以使用 `kubectl describe` 查看新创建的临时容器的状态： ```shell kubectl describe pod ephemeral-demo @@ -266,7 +261,7 @@ Ephemeral Containers: -完成后，使用 `kubectl delete` 删除 Pod： +使用 `kubectl delete` 来移除已经结束掉的 Pod： ```shell kubectl delete pod ephemeral-demo @@ -289,10 +284,9 @@ given tools in the Kubernetes API. Therefore, if you find yourself needing to ssh into a machine, please file a feature request on GitHub describing your use case and why these tools are insufficient. --> -## 通过节点上的 shell 进行调试 {#node-shell-session} - -如果这些方法都不起作用， -你可以找到运行 Pod 的主机并通过 SSH 连接到该主机， -但是 Kubernetes API 中的工具通常不需要这样做。 -因此，如果你发现自己需要 ssh 到一台机器上，请在 GitHub 上提交一个功能请求，描述你的用例以及为什么这些工具不够用。 +## 在节点上通过 shell 来调试 {#node-shell-session} +如果这些方法都不起作用，你可以找到运行 Pod 的主机并通过 SSH 进入该主机， +但是如果使用 Kubernetes API 中的工具，则通常不需要这样做。 +因此，如果你发现自己需要使用 ssh 进入主机，请在GitHub 上提交功能请求， +以描述你的用例以及这些工具不足的原因。