诊断工具asmctl常用命令

命令

当前不支持原因

dashboard系列命令中，除dashboard envoy以外的命令

服务网格控制面由ASM托管，不支持通过命令行工具对控制面核心组件及服务网格自建可观测性。

create-remote-secret

服务网格控制面由ASM托管，不支持自行为控制面创建Secret访问远程Kubernetes集群。

istiod

服务网格控制面由ASM托管，不支持通过命令行工具管理控制面核心组件。

metrics

服务网格控制面由ASM托管，不支持通过命令行工具对控制面核心组件及服务网格自建可观测性。

precheck

服务网格控制面由ASM托管，asmctl无需提供Istio兼容性检查相关功能。

proxy-status

服务网格控制面由ASM托管，当前不支持通过命令行工具自行查询控制面状态，您可以在服务网格控制台概览页面查看网格状态。

uninstall、install

服务网格控制面由ASM托管，不支持自行安装、卸载控制面。

version

当前不支持查看版本信息，可以通过服务网格控制台查看网格基础信息。

wait

服务网格控制面由ASM托管，当前开发进度下不支持通过命令行工具自行查询控制面状态。

manifest、operator、profile、upgrade、verify-install

服务网格控制面由ASM托管，asmctl不提供通过命令在用户侧集群中再次安装istio的能力。

kube-inject、kube-uninject、workload、add-to-mesh系列命令、remove-from-mesh命令

asmctl还处于开发早期阶段，目前暂时不开放会对集群进行实质性更改的命令。

命令

描述

链接

asmctl analyze

分析集群的控制面配置并输出分析结果。

asmctl analyze

asmctl bug-report

选择性地收集ASM实例与用户侧集群中的信息与日志，并压缩到一个压缩包，帮助您对常见问题进行诊断。

asmctl bug-report

asmctl dashboard

访问与社区Istio兼容的Web UI。

asmctl dashboard

asmctl dashboard envoy

为指定容器组的Sidecar打开Envoy管理面板。

asmctl dashboard envoy

asmctl experimental

这些命令还在开发中，属于实验性命令。

asmctl experimental

asmctl experimental authz

提供与服务网格授权策略有关的功能。

asmctl experimental authz

asmctl experimental authz check

检查指定容器组的Sidecar配置，并输出应用在该容器组Sidecar上的所有授权策略。

asmctl experimental authz check

asmctl experimental config

提供与服务网格默认设置有关的功能。

asmctl experimental config

asmctl experimental config list

列出服务网格中可配置的默认设置信息。

asmctl experimental config list

asmctl experimental describe

输出有关指定Kubernetes资源以及与其相关的服务网格配置的描述性信息。

asmctl experimental describe

asmctl experimental describe pod

根据指定的容器组，分析与它相关的Kubernetes服务、目标规则和虚拟服务等，并最终输出与该容器组相关的描述性信息。

asmctl experimental describe pod

asmctl experimental describe service

根据指定的Kubernetes服务，结合分析与之相关的容器组、目标规则和虚拟服务等，并最终输出与该Kubernetes服务相关的描述性信息。

asmctl experimental describe service

asmctl experimental injector

负责与Sidecar注入情况以及Sidecar注入器信息有关的功能。

asmctl experimental injector

asmctl experimental injector list

列出每个命名空间中容器组Sidecar的注入情况，并输出ASM使用的Sidecar注入器的概要信息。

asmctl experimental injector list

asmctl proxy-config

负责获取容器组中Sidecar的配置信息。

asmctl proxy-config

asmctl proxy-config bootstrap

负责获取指定容器组中Sidecar Envoy的bootstrap配置信息。

asmctl proxy-config bootstrap

asmctl proxy-config cluster

负责获取指定容器组中Sidecar Envoy的cluster配置信息。

asmctl proxy-config cluster

asmctl proxy-config endpoint

负责获取指定容器组中Sidecar Envoy的Endpoint配置信息。

asmctl proxy-config endpoint

asmctl proxy-config listener

负责获取指定容器组中Sidecar Envoy的Listener配置信息。

asmctl proxy-config listener

asmctl proxy-config log

负责获取Sidecar Envoy的日志等级信息，并且支持选择性地更新日志。

asmctl proxy-config log

asmctl proxy-config route

负责获取指定容器组中Sidecar Envoy的Route配置信息。

asmctl proxy-config route

asmctl proxy-config secret

负责获取指定容器组中Sidecar Envoy的Secret配置信息。

asmctl proxy-config secret

asmctl validate

负责验证服务网格规则与策略文件的正确性。

asmctl validate

选项

选项缩写

描述

--all-namespaces

-A

分析所有的命名空间。

--asmconfig <string>

-m

设置ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--color

无

是否以带颜色的格式输出分析结果，默认为true，可设定为false。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--failure-threshold <Level>

无

设定分析时在何种等级下会返回非0的错误码。可用的值包括：Info、Warning 、Error，默认为Error。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--list-analyzers

-L

列出analyze命令当前执行的所有分析手段。

--meshConfigFile <string>

无

在分析时使用给定的网格配置文件来覆盖当前的网格配置，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设定输出的格式，可用的值包括：log、json、yaml ，默认为空。

--output-threshold <Level>

无

设定分析时在何种等级下会输出消息。可用的值包括：Info、Warning 、Error，默认为Info。

--recursive

-R

在指定了分析目录时，递归地处理目录中的所有文件，而不是仅分析目录中的第一层文件。

--suppress <stringArray>

-S

设定停止报告某个特定资源的某个消息码。该项以<code>=<resource>的形式提供，例如--suppress "IST0102=DestinationRule primary-dr.default。该项可以重复提供，且可以在传入的参数中使用通配符“*”来支持部分匹配，例如suppress "IST0102=DestinationRule *.default。该项默认为[]。

--timeout <duration>

无

设置命令返回超时错误的时间，执行分析超过超时时间后会返回timeout错误而不再返回分析结果，默认为30s。

--use-kube

-k

是否基于当前的ASM实例与用户侧集群进行分析，如果只是想要分析文件本身，则需将此项设定为use-kube=false。

--verbose

-v

设定输出详细的分析过程。

选项

选项缩写

描述

--asmconfig <string>

-m

ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--dir <string>

无

为bug-report命令中产生的临时输出文件设定一个目录，默认为空。

--dry-run

无

控制是否实际进行日志的收集和存储，设定dry-run选项，表示不进行实际的日志收集和存储。

--duration <duration>

无

从当前时间计算，往前收集多长一段时间的日志信息。默认为无穷大（0s），如果该项被设置，则start-time选项不能被设置。

--end-time <string>

无

要包含在命令输出中的日志的时间跨度的结束时间。默认为现在时间。

--exclude <stringSlice>

无

匹配应该从所有Sidecar日志中排除的容器组的Sidecar日志。该项在include选项之后生效，更多信息，请参见下文的自定义过滤bug-report命令收集的Sidecar日志。默认排除命名空间kube-system、kube-public、kube-node-lease、local-path-storage中的容器组。

--filename <string>

-f

指定一个包含bug-report配置信息的YAML文件。该文件中指定的选项内容将覆盖在命令行选项中指定的内容，默认为空。

--full-secrets

无

控制是否收集Secret信息，设定full-secrets选项，则收集Secret信息到命令输出中。

--ignore-errs <stringSlice>

无

一系列以逗号分隔的glob匹配模式，这些模式用来匹配忽略的日志错误（error）信息字符串。在计算日志重要性时，匹配该项给出模式的错误将忽略不计。

--include <stringSlice>

无

匹配应该在命令输出中包含的容器组的Sidecar日志，更多信息，请参见下文的自定义过滤bug-report命令收集的Sidecar日志。默认为空。

--istio-namespace <string>

-i

控制面组件安装的命名空间，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--start-time <string>

无

包含在命令输出中的日志的时间跨度的开始时间。默认为空，即从最早的日志开始收集。

--timeout <duration>

无

能够容忍获取日志所花的最长时间。当收集日志时间超时时，仅目前已经收集的日志会保存至命令输出，默认为30m0s。

选项

选项缩写

描述

--address <string>

无

Web UI的监听地址，只接受IP地址或localhost。如果该项为localhost，asmctl将会尝试绑定127.0.0.1（IPV4）或是::1（IPV6）两个地址，如果这两个地址都无法绑定则命令执行失败。默认为localhost。

--browser

无

设定是否打开浏览器。当browse选项被设定为false，asmctl将不会自动打开浏览器，默认为true。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--port <int>

-p

Web UI监听的本地端口，默认为空。

选项

选项缩写

描述

--address <string>

无

Web UI的监听地址，只接受IP地址或localhost。如果该项为localhost，asmctl将会尝试绑定127.0.0.1（IPV4）或是::1（IPV6）两个地址，如果这两个地址都无法绑定则命令执行失败。默认为localhost。

--browser

无

设定是否打开浏览器。当browse选项被设定为false，asmctl将不会自动打开浏览器，默认为true。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--port <int>

-p

Web UI监听的本地端口（默认为0）。

--selector <string>

-l

容器组标签选择器（默认为空，使用标签选择器时不能提供容器组名称。）

选项

选项缩写

描述

--asmconfig <string>

-m

设置ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

指定被检查的Envoy配置转储文件，文件为JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--asmconfig <string>

-m

ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--ignoreUnmeshed

无

对于分析时发现的未加入网格的容器组，设定是否输出警告信息，默认为false。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--asmconfig <string>

-m

ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--ignoreUnmeshed

无

对于分析时发现的未加入网格的容器组，设定是否输出警告信息，默认为false。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--asmconfig <string>

-m

ASM实例的kubeconfig文件路径，默认为$HOME/.kube/asmconfig。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--direction <string>

无

通过Direction字段筛选收集的cluster配置信息，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--fqdn <string>

无

通过Service FQDN字段筛选收集的cluster配置信息，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

--port <int>

无

通过Port字段筛选收集的cluster配置信息，默认为空。

--subset <string>

无

通过Subset字段筛选收集的cluster配置信息，默认为空。

选项

选项缩写

描述

--address <string>

无

通过address字段筛选收集的Endpoint配置信息，默认为空。

--cluster <string>

无

通过cluster name字段筛选收集的Endpoint配置信息，默认为空。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

命令输出格式，可选json和short，默认为short。

--port <int>

无

通过Port字段筛选收集的Endpoint配置信息，默认为空。

--status <string>

无

通过status字段筛选收集的Endpoint配置信息，默认为空。

选项

选项缩写

描述

--address <string>

无

通过address字段筛选收集的Listener配置信息，默认为空。

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

命令输出格式，可选json和short，默认为short。

--port <int>

无

通过Port字段筛选收集的Listener配置信息，默认为空。

--type <string>

无

通过type字段筛选收集的Listener配置信息，默认为空。

--verbose

无

输出更多信息，默认为true。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--level <string>

无

要输出的以逗号分隔的每个logger的最低消息级别，形式为：[<logger>:]<level>,[<logger>:]<level>,...。其中，logger可以是admin、aws、assert、backtrace、client、config、connection、conn_handler、dubbo、file、filter、forward_proxy、grpc、hc、health_checker、http、mongo、quic、pool、rbac、redis、router、runtime、stats、secret、tap、testing、thrift、tracing、upstream、udp、wasm中的一个。而消息级别可以是trace、debug、info、warning、error、critical、off中的一个，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

--reset

-r

将日志等级重设为默认值（warning）。

--selector <string>

-l

标签选择器，默认为空。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--name <string>

无

通过name字段筛选收集的Router配置信息，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

--verbose

无

输出更多信息，默认为true。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

Envoy配置转储文件，JSON格式，默认为空。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--kubeconfig <string>

-c

设置用户侧集群的kubeconfig文件路径，默认为空。

--namespace <string>

-n

指定生效的命名空间，默认为空。

--output <string>

-o

设置命令输出格式，可选json和short，默认为short。

选项

选项缩写

描述

--context <string>

无

设置默认使用的kubeconfig context名称，默认为空。

--file <string>

-f

需要验证的服务网格规格与策略文件名称。

--istioNamespace <string>

-i

设置Istio所在命名空间名称，默认为istio-system。

--namespace <string>

-n

指定生效的命名空间，默认为空。