whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

resolve conflicts

Browse Source
This commit is contained in:
bryan
2020-09-30 17:12:06 +08:00
parent 202b9957ec
commit 34d0a6f2ce
1 changed files with 104 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/zh/docs/tasks/debug-application-cluster/debug-running-pod.md
+102 -108
View File
@@ -2,26 +2,15 @@
title: 调试运行中的 Pod title: 调试运行中的 Pod
content_type: task content_type: task
--- ---
<!--
reviewers:
- verb
- soltysh
title: Debug Running Pods
content_type: task
-->
<!-- overview --> <!-- overview -->
<!-- <!--
This page explains how to debug Pods running (or crashing) on a Node. This page explains how to debug Pods running (or crashing) on a Node.
--> -->
本页解释了如何调试节点上正在运行(或者正在崩溃)的 Pod。 本页解释如何在节点上调试运行中（或崩溃）的 Pod。
## {{% heading "prerequisites" %}} ## {{% heading "prerequisites" %}}
<!-- <!--
* Your {{< glossary_tooltip text="Pod" term_id="pod" >}} should already be * Your {{< glossary_tooltip text="Pod" term_id="pod" >}} should already be
scheduled and running. If your Pod is not yet running, start with [Troubleshoot scheduled and running. If your Pod is not yet running, start with [Troubleshoot
@@ -30,15 +19,11 @@ This page explains how to debug Pods running (or crashing) on a Node.
Pod is running and have shell access to run commands on that Node. You don't Pod is running and have shell access to run commands on that Node. You don't
need that access to run the standard debug steps that use `kubectl`. need that access to run the standard debug steps that use `kubectl`.
--> -->
* 你的 {{< glossary_tooltip text="Pod" term_id="pod" >}} * 你的 {{< glossary_tooltip text="Pod" term_id="pod" >}} 应该已经被调度并正在运行中，
应该已经调度并正在运行。 如果你的 Pod 还没有运行，请参阅[应用问题排查](/docs/tasks/debug-application-cluster/debug-application/)。
如果 Pod 尚未运行，则从
[应用故障排查](/zh/docs/tasks/debug-application-cluster/debug-application/) 开始。
* 对于一些高级调试步骤，
你需要知道 Pod 在哪个节点上运行，并拥有在该节点上执行 shell 命令的权限。
在使用 `kubectl` 运行标准调试步骤时，则不需要这种权限。
* 对于一些高级调试步骤，你应该知道 Pod 具体运行在哪个节点上，在该节点上有权限去运行一些命令。
你不需要任何访问权限就可以使用 `kubectl` 去运行一些标准调试步骤。
<!-- steps --> <!-- steps -->
@@ -46,19 +31,26 @@ This page explains how to debug Pods running (or crashing) on a Node.
## Examining pod logs {#examine-pod-logs} ## Examining pod logs {#examine-pod-logs}
First, look at the logs of the affected container: First, look at the logs of the affected container:
-->
## 检查 Pod 日志 {#examine-pod-logs}
首先，查看受影响的容器的日志：
```shell ```shell
kubectl logs ${POD_NAME} ${CONTAINER_NAME} kubectl logs ${POD_NAME} ${CONTAINER_NAME}
``` ```
<!--
If your container has previously crashed, you can access the previous container's crash log with: If your container has previously crashed, you can access the previous container's crash log with:
```shell
kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME}
```
--> -->
如果你的容器以前崩溃过，你可以访问前一个容器的崩溃日志： ## 检查 Pod 的日志 {#examine-pod-logs}
首先，查看受到影响的容器的日志：
```shell
kubectl logs ${POD_NAME} ${CONTAINER_NAME}
```
如果你的容器之前崩溃过，你可以通过下面命令访问之前容器的崩溃日志：
```shell ```shell
kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME} kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME}
@@ -67,64 +59,58 @@ kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME}
<!-- <!--
## Debugging with container exec {#container-exec} ## Debugging with container exec {#container-exec}
If the {{< glossary_tooltip text="container image" term_id="image" >}} includes
debugging utilities, as is the case with images built from Linux and Windows OS
base images, you can run commands inside a specific container with
`kubectl exec`:
-->
## 使用容器 exec 调试 {#container-exec}
如果 {{< glossary_tooltip text="容器镜像" term_id="image" >}}
包含调试工具，就像基于 Linux 和 Windows 基础镜像构建的镜像一样，
你可以使用 `kubectl exec` 在特定的容器中执行命令：
```shell ```shell
kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN} kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN}
``` ```
<!--
`-c ${CONTAINER_NAME}` is optional. You can omit it for Pods that only contain a single container.
-->
{{< note >}}
`-c ${CONTAINER_NAME}` 是可选项。
对于单容器 Pod，可以省略此参数。
{{< /note >}}
<!--
As an example, to look at the logs from a running Cassandra pod, you might run As an example, to look at the logs from a running Cassandra pod, you might run
-->
例如，要查看正在运行的 Cassandra Pod 的日志，可以执行：
```shell ```shell
kubectl exec cassandra -- cat /var/log/cassandra/system.log kubectl exec cassandra -- cat /var/log/cassandra/system.log
``` ```
<!--
You can run a shell that's connected to your terminal using the `-i` and `-t` You can run a shell that's connected to your terminal using the `-i` and `-t`
arguments to `kubectl exec`, for example: arguments to `kubectl exec`, for example:
-->
你可以使用 `kubectl exec` 的 `-i` 和 `-t` 参数启动一个连接到终端的 shell，例如：
```shell ```shell
kubectl exec -it cassandra -- sh kubectl exec -it cassandra -- sh
``` ```
<!--
For more details, see [Get a Shell to a Running Container]( For more details, see [Get a Shell to a Running Container](
/docs/tasks/debug-application-cluster/get-shell-running-container/). /docs/tasks/debug-application-cluster/get-shell-running-container/).
--> -->
更多细节，参见 ## 使用容器 exec 进行调试 {#container-exec}
[获取运行容器的 Shell](
/zh/docs/tasks/debug-application-cluster/get-shell-running-container/)。 如果 {{< 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/)。
<!-- <!--
## Debugging with an ephemeral debug container {#ephemeral-container} ## Debugging with an ephemeral debug container {#ephemeral-container}
-->
## 使用临时调试容器进行调试 {#ephemeral-container}
{{< feature-state state="alpha" for_k8s_version="v1.18" >}} {{< feature-state state="alpha" for_k8s_version="v1.18" >}}
<!--
{{< glossary_tooltip text="Ephemeral containers" term_id="ephemeral-container" >}} {{< glossary_tooltip text="Ephemeral containers" term_id="ephemeral-container" >}}
are useful for interactive troubleshooting when `kubectl exec` is insufficient are useful for interactive troubleshooting when `kubectl exec` is insufficient
because a container has crashed or a container image doesn't include debugging because a container has crashed or a container image doesn't include debugging
@@ -133,12 +119,12 @@ https://github.com/GoogleContainerTools/distroless). `kubectl` has an alpha
command that can create ephemeral containers for debugging beginning with version command that can create ephemeral containers for debugging beginning with version
`v1.18`. `v1.18`.
--> -->
因为容器已经崩溃，或因为容器镜像没有内含调试工具，比如 ## 使用临时调试容器来进行调试 {#ephemeral-container}
[distroless images](https://github.com/GoogleContainerTools/distroless)，
导致 `kubectl exec` 不足以解决问题时， {{< feature-state state="alpha" for_k8s_version="v1.18" >}}
{{< glossary_tooltip text="Ephemeral containers" term_id="ephemeral-container" >}}
对交互式故障诊断非常有用。 当由于容器崩溃或容器镜像不包含调试程序（例如[无发行版镜像](https://github.com/GoogleContainerTools/distroless)等）
从 `v1.18` 开始，`kubectl` 提供 alpha 命令，它可以为调试创建临时容器。 而导致 `kubectl exec` 无法运行时，{{< glossary_tooltip text="临时容器" term_id="ephemeral-container" >}}对于排除交互式故障很有用。
<!-- <!--
### Example debugging using ephemeral containers {#ephemeral-container-example} ### Example debugging using ephemeral containers {#ephemeral-container-example}
@@ -146,45 +132,39 @@ command that can create ephemeral containers for debugging beginning with versio
The examples in this section require the `EphemeralContainers` [feature gate]( The examples in this section require the `EphemeralContainers` [feature gate](
/docs/reference/command-line-tools-reference/feature-gates/) enabled in your /docs/reference/command-line-tools-reference/feature-gates/) enabled in your
cluster and `kubectl` version v1.18 or later. cluster and `kubectl` version v1.18 or later.
-->
## 示例：使用临时容器调试 {#ephemeral-container-example}
{{< note >}}
本节中的示例要求在集群启用 `EphemeralContainers` [特性门控](
/zh/docs/reference/command-line-tools-reference/feature-gates/
)。
并且要求 `kubectl` v1.18 或更高版本。
{{< /note >}}
<!--
You can use the `kubectl alpha debug` command to add ephemeral containers to a You can use the `kubectl alpha debug` command to add ephemeral containers to a
running Pod. First, create a pod for the example: running Pod. First, create a pod for the example:
-->
可以使用 `kubectl alpha debug` 命令将临时容器添加到正在运行的 Pod 中。
首先，为本例创建一个 Pod：
```shell ```shell
kubectl run ephemeral-demo --image=k8s.gcr.io/pause:3.1 --restart=Never kubectl run ephemeral-demo --image=k8s.gcr.io/pause:3.1 --restart=Never
``` ```
<!--
This section use the `pause` container image in examples because it does not This section use the `pause` container image in examples because it does not
contain userland debugging utilities, but this method works with all container contain userland debugging utilities, but this method works with all container
images. images.
If you attempt to use `kubectl exec` to create a shell you will see an error
because there is no shell in this container image.
--> -->
## 使用临时容器来调试的例子 {#ephemeral-container-example}
{{< note >}} {{< note >}}
本节在示例中使用 `pause` 容器镜像， 本示例需要你的集群已经开启 `EphemeralContainers` [特性门控](/zh/docs/reference/command-line-tools-reference/feature-gates/)，
是因为它不包含用户态的调试工具。 `kubectl` 版本为 v1.18 或者更高。
但此方法适用于所有容器镜像。
{{< /note >}} {{< /note >}}
如果你试图使用 `kubectl exec` 去建立一个 shell， 你可以使用 `kubectl alpha debug` 命令来给正在运行中的 Pod 增加一个临时容器。
你会看到一个报错， 首先，像示例一样创建一个 pod：
这是因为在容器镜像中并没有包含 shell。
```shell
kubectl run ephemeral-demo --image=k8s.gcr.io/pause:3.1 --restart=Never
```
{{< note >}}
本节示例中使用 `pause` 容器镜像，因为它不包含任何用户级调试程序，但是这个方法适用于所有容器镜像。
{{< /note >}}
<!--
If you attempt to use `kubectl exec` to create a shell you will see an error
because there is no shell in this container image.
```shell ```shell
kubectl exec -it ephemeral-demo -- sh kubectl exec -it ephemeral-demo -- sh
@@ -194,14 +174,32 @@ 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 OCI runtime exec failed: exec failed: container_linux.go:346: starting container process caused "exec: \"sh\": executable file not found in $PATH": unknown
``` ```
<!--
You can instead add a debugging container using `kubectl alpha debug`. If you You can instead add a debugging container using `kubectl alpha debug`. If you
specify the `-i`/`--interactive` argument, `kubectl` will automatically attach specify the `-i`/`--interactive` argument, `kubectl` will automatically attach
to the console of the Ephemeral Container. to the console of the Ephemeral Container.
```shell
kubectl alpha debug -it ephemeral-demo --image=busybox --target=ephemeral-demo
```
```
Defaulting debug container name to debugger-8xzrl.
If you don't see a command prompt, try pressing enter.
/ #
```
--> -->
你可以使用 `kubectl alpha debug` 添加一个调试容器。 如果你尝试使用 `kubectl exec` 来创建一个 shell，你将会看到一个错误，因为这个容器镜像中没有 shell。
如果指定了 `-i`/`--interactive` 参数，
`kubectl` 将自动连接到临时容器的控制台。 ```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 ```shell
kubectl alpha debug -it ephemeral-demo --image=busybox --target=ephemeral-demo 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`: You can view the state of the newly created ephemeral container using `kubectl describe`:
--> -->
此命令添加一个新的 busybox 容器并连接。 此命令添加一个新的 busybox 容器并将其挂接到该容器。`--target` 参数指定另一个容器的进程命名空间。
`--target` 参数指定了另一个容器的进程命名空间。 这是必需的，因为 `kubectl run` 不能在它创建的pod中启用
这里必须这样做，因为 `kubectl run` 没有在它创建的 Pod 中启用 [共享进程命名空间](/zh/docs/tasks/configure-pod-container/share-process-namespace/)。
[进程命名空间共享](/zh/docs/tasks/configure-pod-container/share-process-namespace/) 。
{{< note >}} {{< note >}}
{{< glossary_tooltip text="Container Runtime" term_id="container-runtime" >}} {{< glossary_tooltip text="容器运行时" term_id="container-runtime" >}}必须支持`--target`参数。
必须支持 `--target` 参数。 如果不支持，则临时容器可能不会启动，或者可能使用隔离的进程命名空间启动。
如果不支持，临时容器可能无法启动，
或者可能使用隔离的进程名称空间启动。
{{< /note >}} {{< /note >}}
可以使用 `kubectl describe` 查看新创建的临时容器的状态： 你可以使用 `kubectl describe` 查看新创建的临时容器的状态：
```shell ```shell
kubectl describe pod ephemeral-demo kubectl describe pod ephemeral-demo
@@ -266,7 +261,7 @@ Ephemeral Containers:
<!-- <!--
Use `kubectl delete` to remove the Pod when you're finished: Use `kubectl delete` to remove the Pod when you're finished:
--> -->
完成后，使用 `kubectl delete` 删除 Pod： 使用 `kubectl delete` 来移除已经结束掉的 Pod：
```shell ```shell
kubectl delete pod ephemeral-demo 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 ssh into a machine, please file a feature request on GitHub describing your use
case and why these tools are insufficient. case and why these tools are insufficient.
--> -->
## 通过节点上的 shell 进行调试 {#node-shell-session} ## 在节点上通过 shell 来调试 {#node-shell-session}
如果这些方法都不起作用，
你可以找到运行 Pod 的主机并通过 SSH 连接到该主机，
但是 Kubernetes API 中的工具通常不需要这样做。
因此，如果你发现自己需要 ssh 到一台机器上，请在 GitHub 上提交一个功能请求，描述你的用例以及为什么这些工具不够用。
如果这些方法都不起作用，你可以找到运行 Pod 的主机并通过 SSH 进入该主机，
但是如果使用 Kubernetes API 中的工具，则通常不需要这样做。
因此，如果你发现自己需要使用 ssh 进入主机，请在GitHub 上提交功能请求，
以描述你的用例以及这些工具不足的原因。