使用 istioctl analyze 诊断配置

istioctl analyze 是一个诊断工具，可以检测 Istio 配置的潜在问题。 它检测的目标可以是一个正在运行的集群，也可以是一组本地配置文件。 它检测的目标还可以是这二者的结合，从而能够让您及时发现问题并对集群做出变更。

一分钟入门

您可以使用如下的命令分析您当前的集群：

  1. $ istioctl analyze --all-namespaces

就这么一条简单的命令！它会为您提供所有合适的建议。

例如，如果您忘记启用 Istio 注入（一个非常常见的问题），则会收到以下 ‘Info’ 类型的消息：

  1. Info [IST0102] (Namespace default) The namespace is not enabled for Istio injection. Run 'kubectl label namespace default istio-injection=enabled' to enable it, or 'kubectl label namespace default istio-injection=disabled' to explicitly mark it as not needing injection.

您可使用如下命令修复：

  1. $ kubectl label namespace default istio-injection=enabled

然后再重新检测一下：

  1. $ istioctl analyze --namespace default
  2. ✔ No validation issues found when analyzing namespace: default.

分析运行中的集群、本地文件或同时分析两者

分析当前运行中的集群，模拟在 samples/bookinfo/networking 目录下应用 bookinfo-gateway.yaml 和 destination-rule-all.yaml 等更多 YAML 文件的效果：

ZipZip

  1. $ istioctl analyze @samples/bookinfo/networking/bookinfo-gateway.yaml@ @samples/bookinfo/networking/destination-rule-all.yaml@
  2. Error [IST0101] (Gateway default/bookinfo-gateway samples/bookinfo/networking/bookinfo-gateway.yaml:9) Referenced selector not found: "istio=ingressgateway"
  3. Error [IST0101] (VirtualService default/bookinfo samples/bookinfo/networking/bookinfo-gateway.yaml:41) Referenced host not found: "productpage"
  4. Error: Analyzers found issues when analyzing namespace: default.
  5. See https://istio.io/v1.23/docs/reference/config/analysis for more information about causes and resolutions.

分析整个 networking 目录：

  1. $ istioctl analyze samples/bookinfo/networking/

分析 networking 目录下的所有 YAML 文件：

  1. $ istioctl analyze samples/bookinfo/networking/*.yaml

上面的这些例子是对运行中的集群进行分析。 此工具还支持分析一组本地 Kubernetes YAML 配置文件，也支持组合分析运行中的集群及本地的文件。 当分析一组本地文件时，文件集应该是完全独立的（自包含的）。通常，这用于分析打算部署到某集群的整个配置文件集。 要使用此功能，只需添加 --use-kube=false 标志。

分析 networking 目录下的所有 YAML 文件：

  1. $ istioctl analyze --use-kube=false samples/bookinfo/networking/*.yaml

您可以运行 istioctl analyze --help 来查看完整的选项设置。

高级功能

为资源状态启用验证消息

以下信息描述了一个实验性功能，仅用于评估。

从 v1.5 开始，Istio 可以通过 istiod.enableAnalysis 标志设置为与 Galley 主要负责的配置分发一起执行配置分析。 Galley 分析所使用的逻辑和错误消息与 istioctl analyze 相同。 分析所产生的验证消息被写入到受影响的 Istio 资源的状态子资源。

例如：如果您的 “ratings” VirtualService 上的网关配置错误，运行 kubectl get virtualservice ratings 会给出类似这样的结果：

  1. apiVersion: networking.istio.io/v1
  2. kind: VirtualService
  3. ...
  4. spec:
  5.   gateways:
  6.   - bogus-gateway
  7.   hosts:
  8.   - ratings
  9. ...
  10. status:
  11.   observedGeneration: "1"
  12.   validationMessages:
  13.   - documentationUrl: https://istio.io/v1.23/docs/reference/config/analysis/ist0101/
  14.     level: ERROR
  15.     type:
  16.       code: IST0101

enableAnalysis 在后台运行，并将保持资源的 status 字段与其当前验证状态保持同步。 请注意，这不是 istioctl analyze 的替代品：

  • 并非所有资源都有自定义 status 字段（例如 Kubernetes namespace 资源）， 因此附加到这些资源的消息不会显示验证消息。
  • enableAnalysis 仅适用于从 1.5 开始的 Istio 版本，而 istioctl analyze 可用于旧版本。
  • 虽然可以轻松查看特定资源是否有问题，但很难全面了解网格中的验证状态。

您可以通过以下命令启用此功能：

  1. $ istioctl install --set values.global.istiod.enableAnalysis=true

通过 CLI 忽略特定的分析器消息

有时您可能会发现在某些情况下隐藏或忽略分析器消息很有用。例如， 想象这样一种情况，针对您无权更新的某个资源发出一条消息：

  1. $ istioctl analyze -k --namespace frod
  2. Info [IST0102] (Namespace frod) The namespace is not enabled for Istio injection. Run 'kubectl label namespace frod istio-injection=enabled' to enable it, or 'kubectl label namespace frod istio-injection=disabled' to explicitly mark it as not needing injection.

由于您无权更新命名空间，因此无法通过为命名空间添加注解来解析消息。 这种情况下，您可以直接使用 istioctl analyze 来抑制针对此资源的上述消息：

  1. $ istioctl analyze -k --namespace frod --suppress "IST0102=Namespace frod"
  2. ✔ No validation issues found when analyzing namespace: frod.

当引用 <kind> <name>.<namespace> 资源时，抑制所用的语法与整个 istioctl 中使用的语法相同，或者仅使用 <kind> <name> 表示 Namespace 这类集群作用域的资源。如果您想抑制多个对象，您可以重复 --suppress 参数或使用通配符：

  1. $ # Suppress code IST0102 on namespace frod and IST0107 on all pods in namespace baz
  2. $ istioctl analyze -k --all-namespaces --suppress "IST0102=Namespace frod" --suppress "IST0107=Pod *.baz"

通过注解忽略特定的分析器消息

您也可以对资源增加注解来忽略特定的分析器消息。例如，要忽略资源 deployment/my-deployment 上的代码 IST0107（MisplacedAnnotation）：

  1. $ kubectl annotate deployment my-deployment galley.istio.io/analyze-suppress=IST0107

要忽略资源的多个代码，请用英文逗号分隔每个代码：

  1. $ kubectl annotate deployment my-deployment galley.istio.io/analyze-suppress=IST0107,IST0002

帮助我们改进此工具

我们将不断增加更多的分析功能，希望您能帮助我们发现更多的使用场景。 如果您发现了一些 Istio 配置“陷阱”，一些导致您的使用出现问题的棘手情况，请提一条 Issue 告知我们。 这样我们也许就可以自动标记此问题，以便他人可以提前发现并避免此问题。

为此，请您提一个 Issue 来描述您所遇到的情况。例如：

  • 查看所有 VirtualService
  • 查看每个 VirtualService 的网关列表
  • 如果某些网关不存在，则报错

我们已经有针对这种特定场景的分析器，因此这仅是一个示例，用于说明您应在 Issue 中提供哪种信息。

Q&A

  • 此工具针对的是哪个 Istio 版本？

    和其它 istioctl 工具一样，我们通常建议下载并使用一个与您集群中所部署版本相匹配的版本。

    就目前而言，分析器是向后兼容的，所以您可以在运行 Istio 1.x 的集群上使用 1.23 版本的 istioctl analyze，并且会得到有用的反馈。对老版本 Istio 没有意义的分析规则将被跳过。

    如果您决定使用最新的 istioctl 来分析一个运行老版本 Istio 的集群， 我们建议您将其保存在一个独立的目录中，和用于管理已部署 Istio 版本的二进制文件分开。

  • 现在支持哪些分析器？

    我们仍在努力编写分析器文档。目前，您可以在 Istio 源代码中看到所有分析器。

    您还可以了解一下目前支持哪些配置分析消息。

  • 分析对我的集群有影响吗？

    分析永远不会更改配置状态。这是一个完全只读的操作，因此永远不会更改集群的状态。

  • 超出配置范围的又如何分析呢？

    今天，分析完全基于 Kubernetes 的配置，但是将来我们希望进一步扩展。例如， 我们可以允许分析器查看日志以生成建议。

  • 在哪里可以找到解决错误的方法？

    配置分析消息集包含每条消息的描述以及建议的修复措施。