如何使用命令行工具管理 APM
安装地址池管理器 (APM) 应用程序后,您可以执行以下管理功能。
地址池管理器为您提供了两个用于执行管理员任务的命令行选项。您可以使用 APM 实用程序脚本 (apm) 或 Kubernetes 命令行工具来管理 APM。
访问 APM 实用程序命令
使用 APM 实用程序命令执行管理功能。
您可以使用 APM 实用程序脚本 (apm) 来管理应用程序并访问用于配置地址管理功能的 CLI。瞻博网络 APM 安装将实用程序脚本放置在 /var/local/apm 中,并在 /usr/local/bin/apm 中创建指向该脚本的符号链接。
您可以使用 apm 实用程序脚本(使用 Kubernetes 命令行工具和 Helm 命令)执行以下操作:
- 创建和删除对象。
- 提供日志访问权限。
- 使用 pod 容器进行交互式会话。
- 显示 APM 对象的状态。
使用实用工具脚本可以 apm 简化许多管理职责。该脚本执行管理 APM 所需的任务,同时掩盖命令的 kubectl 复杂性。
表 1 列出了可以使用 apm 实用程序脚本调用的命令,并介绍了发生的操作。许多单独的命令都有可以指定的选项。
| 姓名 | 行动 |
|---|---|
|
|
清理不需要的版本和 Docker 缓存。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
|
|
|
允许您访问可用于配置 APM 功能的 CLI。 此命令提供以下选项:
|
|
|
显示使用 APM 进行控制的可用上下文。 此命令提供以下选项:
|
|
|
提供对 Redis 数据库 CLI 的访问。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
|
|
|
显示 APM 数据库微服务的当前状态,包括当前版本、有状态集 pod 及其角色。
注意:对于位于多个地理位置的设置,显示
apm db-info工作负载集群的 redis 角色。
此命令提供以下选项:
|
|
|
强制主数据库容器切换到符合条件的备份数据库容器。要运行此命令,您需要 sudo 权限。
此命令提供以下选项:
注意:
|
|
|
显示每个服务的外部 IP 地址。 此命令提供以下选项:
|
|
位于单一地理位置的设置用途: 位于多个地理位置的设置用途: sudo -E apm link --context multi-cluster-context-name --version software-release --from-running --log info --no-color --workload-contexts workload-1-context-name workload-2-context-name |
将群集链接到特定软件版本。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
|
apm logs --logset logset-type --services services-names --context [context-name | multi-cluster-context-name] --workload-context workload-context-name --log info --follow --previous --nocolor |
显示 APM 微服务的日志。如果运行命令时不带该
|
|
|
显示工作负载群集之间的数据库同步状态。 此命令提供以下选项:
注意:
此命令仅在位于多个地理位置的设置中受支持。 |
|
|
从应用程序的角度显示工作负载集群的状态。 此命令提供以下选项:
注意:
此命令仅在位于多个地理位置的设置中受支持。 |
|
|
启动到其他工作负载群集的切换。APM 微服务在其他工作负载群集上重新调度。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
此命令仅在多地理位置设置中受支持。 |
|
|
重命名上下文。该命令不会影响当前在群集上运行的 APM。要运行此命令,您需要 sudo root 权限。
此命令提供以下选项:
|
|
|
重新启动一个或多个指定的服务。要运行此命令,您需要 sudo root 权限。
此命令提供以下选项:
|
|
|
升级或启动 APM 服务。要运行此命令,您需要 sudo root 权限。
此命令提供以下选项:
|
sudo -E apm save-config -- context [context-name | multi-cluster-context-name] |
存档 APM 的当前工作配置,以便在发生 和 此命令提供以下选项:
|
|
|
在安装过程中设置 APM 应用程序。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
|
|
|
将您连接到正在运行的微服务。要运行此命令,您需要 sudo root 权限。
此命令提供以下选项:
|
|
|
显示 APM 服务的当前状态。
此命令提供以下选项:
|
|
|
停止所有 APM 服务。要运行此命令,您需要 sudo root 权限。
此命令提供以下选项:
|
apm storage --context [context-name | multi-cluster-context-name] |
提供 APM 的存储驱动程序的状态。 此命令提供以下选项:
|
sudo -E apm unlink --context [context-name | multi-cluster-context-name] |
取消链接与上下文关联的组件。要运行此命令,您需要 sudo root 权限。 此命令提供以下选项:
|
apm version --context [context-name | multi-cluster-context-name] --detail |
显示 APM 实例中每个正在运行的微服务的版本以及 APM 实用程序。它还列出了系统上所有可用的 APM 软件版本。 此命令提供以下选项:
|
使用以下常规语法发出命令:
-
简短的选项:
$ apm command-name --option
-
对于长期选项:
$ apm command-name --option
要将命令定位到特定群集上下文,请使用该 context 选项。
$ apm command-name --context context-name
要显示带有简要说明的可用命令列表,请使用 h 或 help 选项:
$ apm -h
$ apm --help
要显示特定命令的选项:
$ apm command-name -h
要指定 no-color 禁用彩色文本输出的选项(用于区分日志与不同微服务):
$ apm command-name --no-color
使用 APM 安装实用程序将 APM 升级到新版本
使用此过程升级到安装在类似群集部署(单个地理位置或多个地理位置)上的新版本的 APM。此过程假定 APM 在您的系统上运行。
使用此过程升级到新版本的 APM,该版本安装在由 BBE Cloudsetup 实用程序或 Red Hat OpenShift Container Platform 控制台创建的群集上。此过程假定 APM 在您的系统上运行。
使用 APM 实用程序启动或停止 APM 服务
使用实用程序脚本启动 apm 或停止所有 APM 服务。服务按依赖关系顺序开始。首先开始提供基本服务(数据库和管理),然后是其他服务。服务按依赖关系相反的顺序停止。
-
要启动所有 APM 服务:
$ sudo -E apm rollout --context context-name
注意:APM 在您执行
apm setup命令时从其初始设置开始。执行命令时apm stop,任何持久状态都将丢失。可以使用命令apm save-config保存当前配置。保存的配置是下次启动 APM 时使用的配置。 -
要停止所有 APM 服务:
$ sudo -E apm stop --context context-name WARNING Shutting down your Address Pool Manager will reset it to factory defaults and you will lose all state on the system. Shutdown will begin in 2 minutes. Please use CTRL+C to cancel.
使用 APM 实用程序设置密钥
您可以在设置过程中设置机密,也可以运行以 sudo -E apm setup --context context-name --secrets 设置机密或更新它们。
$ sudo -E apm setup --context context-name --secrets APMi Secret Name (deployed: ) > APMi certificate (default: ) > ./apm.crt Copied /home/user/apm.crt to /var/local/apm/e476597324/secrets/apmi with 600 permissions APMi private key (default: ) > ./apm.key Copied /home/user/apm.keyto /var/local/apm/e476597324/secrets/apmi with 600 permissions APMi root certificate (default: ) > ./rootCA.crt Copied /home/user/rootCA.crt to /var/local/apm/e476597324/secrets/apmi with 600 permissions
如果输入密钥名称的值,则不会要求您提供密钥或认证文件。
使用 APM 实用程序显示数据库信息
该 apm db-info 命令显示 APM 数据库微服务的当前状态,包括当前版本、有状态集 Pod 及其角色。
位于单一地理位置的设置
$ apm db-info --context context-name [-o|--output json] Version: 6.2.16 Primary: jnpr-apm-redis-0 Backup(s): jnpr-apm-redis-1
位于多个地理位置的设置
$ apm db-info --context context-name [--workload-context workload-context-name] [-o|--output json] redis-workload-1: version: 6.2.16-debian-12-r3 Primary: jnpr-apm-redis-workload-1-0 Backup(s): jnpr-apm-redis-workload-1-1 redis-workload-2: version: 6.2.16-debian-12-r3 Primary: jnpr-apm-redis-workload-2-0 Backup(s): jnpr-apm-redis-workload-2-1
apm db-info命令时,参数workload-context workload-context-name是可选的。
使用 APM 实用程序检查 APM 服务的状态
使用 apm status 实用程序脚本检查 表 2 中列出的每个 APM 服务(功能组件)的状态。状态显示服务是否正在运行、已退出或尚未启动。它还会在 Kubernetes Pod 上显示服务名称。可以比较服务的正常运行时间,以快速查看是否已重启任何服务。
apm status实用程序脚本检查多地理位置设置中每个 APM 服务的状态。
|
微服务 |
Pod 前缀 |
|---|---|
|
addrman - 地址管理器。 |
jnpr-apm-addrman |
|
dbSync - 数据库同步。 |
jnpr-apm-db同步 |
|
entman - 实体管理器。 |
jnpr-apm-entman |
|
管理 — CLI 管理。 |
JNPR-APM-管理 |
|
apm-operator — 协调切换并收集系统运行状况信息。 |
jnpr-apm-operator |
|
provman — 配置管理器。 |
jnpr-apm-provman |
|
redis (远程字典服务器)— 由一组提供持久数据库的 Pod 组成。 |
jnpr-apm-redis |
要检查状态,请执行以下操作:
例如:
$ apm status --context multi-cluster-context-name --detail MICROSERVICE WORKLOAD CLUSTER POD STATE RESTARTS UPTIME NODE addrman workload-1 jnpr-apm-addrman-workload-1-74d657f6dd-pnj5c Running 0 0:05:52.430246 diatomite-wl1-n-1 addrman workload-2 jnpr-apm-addrman-workload-2-84c58b988-ncdvb Running 0 0:04:09.430327 diatomite-wl2-n-1 dbsync workload-1 jnpr-apm-dbsync-workload-1-84685f955b-rs5ml Running 0 0:05:45.430359 diatomite-wl1-n-1 dbsync workload-2 jnpr-apm-dbsync-workload-2-55965bf696-p2wlq Running 0 0:04:07.430378 diatomite-wl2-n-1 entman workload-1 jnpr-apm-entman-workload-1-6d6b88ccdb-rxnrl Running 0 0:05:50.430397 diatomite-wl1-n-1 entman workload-2 jnpr-apm-entman-workload-2-8644676f96-9tmln Running 0 0:04:08.430412 diatomite-wl2-n-1 mgmt workload-1 jnpr-apm-mgmt-workload-1-5c46f54dc4-lg5j2 Running 0 0:05:51.430427 diatomite-wl1-n-1 mgmt workload-2 jnpr-apm-mgmt-workload-2-56b558875d-5s6ct Running 0 0:04:08.430441 diatomite-wl2-n-1 apm-operator workload-1 jnpr-apm-operator-controller-manager-workload-1-56c55d59df8gchr Running 0 0:05:50.430456 diatomite-wl1-n-1 apm-operator workload-1 jnpr-apm-operator-state-manager-workload-1-66b678469d-l2mfv Running 0 0:05:50.430469 diatomite-wl1-n-1 apm-operator workload-2 jnpr-apm-operator-controller-manager-workload-2-694b6dbc89p5jfm Running 0 0:04:11.430483 diatomite-wl2-n-1 apm-operator workload-2 jnpr-apm-operator-state-manager-workload-2-66c9bbdc6-p2h7j Running 0 0:04:11.430497 diatomite-wl2-n-1 provman workload-1 jnpr-apm-provman-workload-1-6dcc8754bf-fj29b Running 0 0:05:39.430522 diatomite-wl1-n-1 provman workload-2 jnpr-apm-provman-workload-2-779cd68fdc-cmk6m Running 0 0:04:00.430537 diatomite-wl2-n-1 redis-workload-1 workload-1 jnpr-apm-redis-workload-1-0 Running 0 0:06:36.430551 diatomite-wl1-n-1 redis-workload-1 workload-1 jnpr-apm-redis-workload-1-1 Running 0 0:06:19.430570 diatomite-wl1-n-1 redis-workload-1 workload-1 jnpr-apm-redis-workload-1-sentinels-0 Running 0 0:06:04.430590 diatomite-wl1-n-1 redis-workload-1 workload-1 jnpr-apm-redis-workload-1-sentinels-1 Running 0 0:06:04.430610 diatomite-wl1-n-1 redis-workload-1 workload-1 jnpr-apm-redis-workload-1-sentinels-2 Running 0 0:06:04.430628 diatomite-wl1-n-1 redis-workload-2 workload-2 jnpr-apm-redis-workload-2-0 Running 0 0:04:57.430647 diatomite-wl2-n-1 redis-workload-2 workload-2 jnpr-apm-redis-workload-2-1 Running 0 0:04:40.430667 diatomite-wl2-n-1 redis-workload-2 workload-2 jnpr-apm-redis-workload-2-sentinels-0 Running 0 0:04:26.430685 diatomite-wl2-n-1 redis-workload-2 workload-2 jnpr-apm-redis-workload-2-sentinels-1 Running 0 0:04:26.430704 diatomite-wl2-n-1 redis-workload-2 workload-2 jnpr-apm-redis-workload-2-sentinels-2 Running 0 0:04:26.430722 diatomite-wl2-n-1
使用 APM 实用程序显示 APM IP 地址
使用 apm ip 实用程序脚本显示 APM Pod 编排所需的 Kubernetes 对象。例如:
$ apm ip --context multi-cluster-context-name --detail SERVICE WORKLOAD CLUSTER MICROSERVICE EXTERNAL IP INTERNAL IP PORT(S) apm-apmi-workload-1 workload-1 provman 198.19.0.2 10.43.215.16 20557 apm-apmi-workload-2 workload-2 provman 198.19.0.10 10.47.108.64 20557 apm-mgmt-workload-1 workload-1 mgmt 10.43.244.135 22 jnpr-apm-mgmt-svc workload-1 mgmt 10.43.162.210 8066 jnpr-apm-mgmt-svc workload-2 mgmt 10.47.229.115 8066 apm-mgmt-workload-2 workload-2 mgmt 10.47.244.166 22 apm-operator-workload-1 workload-1 apm-operator 10.43.11.54 20304 apm-operator-workload-2 workload-2 apm-operator 10.47.42.234 20304 apm-ssh-wl1 workload-1 address-pool-manager 10.37.64.128 10.43.212.227 8066 apm-ssh-wl1 workload-2 address-pool-manager 10.37.64.128 10.47.12.177 8066 apm-ssh-wl2 workload-1 address-pool-manager 10.37.64.129 10.43.250.155 8066 apm-ssh-wl2 workload-2 address-pool-manager 10.37.64.129 10.47.237.238 8066 jnpr-apm-redis-sentinels-workload-1-0-svc workload-1 redis-workload-1 10.43.6.167 7381 jnpr-apm-redis-sentinels-workload-1-1-svc workload-1 redis-workload-1 10.43.77.9 7381 jnpr-apm-redis-sentinels-workload-1-2-svc workload-1 redis-workload-1 10.43.139.122 7381 jnpr-apm-redis-workload-1-svc workload-1 redis-workload-1 None 7380 jnpr-dbsync-inter-service-workload-1 workload-1 dbsync 10.43.72.236 61706 jnpr-dbsync-rest-service-workload-1 workload-1 dbsync 10.43.62.234 8080 jnpr-dbsync-inter-service-workload-2 workload-2 dbsync 10.47.25.118 61706 jnpr-dbsync-rest-service-workload-2 workload-2 dbsync 10.47.114.136 8080 jnpr-apm-redis-sentinels-workload-2-0-svc workload-2 redis-workload-2 10.47.249.37 7381 jnpr-apm-redis-sentinels-workload-2-1-svc workload-2 redis-workload-2 10.47.91.138 7381 jnpr-apm-redis-sentinels-workload-2-2-svc workload-2 redis-workload-2 10.47.158.158 7381 jnpr-apm-redis-workload-2-svc workload-2 redis-workload-2 None 7380
使用 APM 实用程序显示日志记录
使用 apm logs 实用程序脚本显示 APM 运行时发生的事件日志。您还可以使用 BBE 事件收集和可视化实用程序来显示自 APM 启动以来收集和存储的基于文件的日志。BBE 事件收集和可视化是一个基于云的集中式实用程序,它提供了一种捕获跨越 APM 微服务生命周期的 APM 日志的方法。设置 APM 时,您可以链接到 BBE 事件收集和可视化日志记录实用程序。请参阅 《宽带边缘事件收集和可视化安装指南》。
显示 APM 日志记录
BBE 事件收集和可视化是一个基于云的集中式实用程序,它提供了一种捕获跨越 APM 微服务生命周期的 APM 日志的方法。如果 BBE 事件收集和可视化正在运行,则在 APM 设置期间,您可以指向 BBE 事件收集和可视化来执行日志记录。BBE 事件收集和可视化通过一个基于 Web 的界面连接 OpenSearch 的功能,可对收集的系统日志事件进行高级搜索、聚合、查看和数据分析。
使用 apm logs 实用程序脚本显示 APM 运行时发生的事件日志。事件日志包括事件,例如以下非详尽列表中所示的事件:
-
池域注册事件
-
地址分配失败
-
网络实体连接失败
-
启动消息
-
网络实体重新同步事件
-
池和分区利用率阈值和耗尽警告
默认情况下,APM 将日志发送到服务的标准输出 (stdout)。输出显示所有服务或指定服务的循环缓冲区。您还可以启用日志记录以跟踪正在运行的服务的日志输出。遵循日志输出将创建一个打开的会话,该会话将日志持续流式传输到 stdout。
APM 日志记录函数掩盖了收集日志信息的命令的 kubectl log 潜在复杂性。您仍然可以使用该 kubectl log 命令,但这超出了本文档的范围。
您可以使用第三方应用程序来捕获和重定向容器的 stdout 流。请参阅您的第三方文档以获取帮助。您还可以使用不同的日志记录驱动程序配置 Docker 以重定向 stdout。请参阅您的 Docker 文档以获取帮助。
要显示所有服务的 APM 日志:
$ apm logs [--context context-name] [--workload-context workload-context-name] [-f] [--previous] [--services SERVICES [SERVICES ...]] [--logset LOGSET] [--nocolor]
仅在瞻博网络支持代表的指导下进行故障排除时才使用该 apm logs [--context contextName] [--workload-context workload-context-name]] --services 选项。
要跟踪所有服务的日志,请指定以下选项 (-f):
$ apm logs [--context context-name] [--workload-context workload-context-name] -f
要查看 Kubernetes Pod 中容器先前实例的日志,请指定之前的容器选项 ():-p
$ apm logs [--context context-name] [--workload-context workload-context-name] -p
您可以使用标准 Ubuntu 约定将日志重定向到文件或终端和文件。有关更多信息,请参阅 Ubuntu 文档,但您可以使用以下示例作为起点:
-
仅将所有日志重定向到一个文件。
$ apm logs [--context context-name] [--workload-context workload-context-name] > file-path
-
将所有日志重定向到屏幕和文件。
$ apm logs [--context context-name] [--workload-context workload-context-name] | tee file-path
只能在瞻博网络支持代表的指导下将该 --services 选项用于故障排除。
您可以按严重性增加的顺序指定以下任何严重性级别:
| 严重性级别 | 描述 |
|---|---|
debug |
通常仅在尝试诊断问题时才对其感兴趣的详细信息。这些日志通常非常频繁。 |
info |
关注的事件或非错误条件。此级别的日志可确认一切按预期工作。这些日志通常不是很频繁。 |
warning |
表示发生了意外情况或不久的将来可能会出现某些问题。后者的一个简单示例是 磁盘空间不足 警告,表示您可能很快就会用完磁盘空间。无论哪种情况,软件仍按预期工作,但您可能需要更密切地监控它。这些日志通常不是很频繁。 |
error |
表示更严重的问题导致软件无法执行某些功能,但软件已尽可能妥善处理问题以继续运行。 |
critical |
严重错误,指示程序本身可能无法继续运行。 |
您可以使用该 --logset 选项仅显示 APM 服务或仅预构建服务的日志。如果不使用此选项,则仅显示 APM 服务日志。
要仅显示 APM 服务的日志:
$ apm logs [--context context-name] [--workload-context workload-context-name] --logset apm $ apm logs
要显示预构建服务的日志,请执行以下操作:
$ apm logs [--context context-name] [--workload-context workload-context-name] --logset apm-infra
预构建服务是从其他来源借来的服务,为 APM 提供基础设施功能。这些来源包括 mgmt、redis 和 redis-sentinel。例如,redis 提供数据库和消息服务,管理提供配置和 CLI 服务等等。
使用 APM 实用程序确定 APM 版本
使用 apm version [--context context-name] [-o|--output json] [--detail] [--compare software-version] 实用程序脚本确定已安装的 APM 版本的版本号。
要显示发行版本:
$ apm version --context context-name --detail Address Pool Manager versions: Microservice Release (version) apm: 3.6.0 addrman: 3.6.0 apm-operator: 3.6.0 dbsync: 3.6.0 entman: 3.6.0 mgmt: 3.6.0 provman: 3.6.0 redis: (3.6.0) (6.2.16-debian-12-r3) redis-workload-1: 3.6.0 redis-workload-2: 3.6.0
要将指定的软件版本与指定上下文的当前部署版本进行比较:
apm version --compare 3.6.0 –-context context-name components: apm: 3.5.0 -> 3.6.0 addrman: 3.5.0 -> 3.6.0 apm-operator: 3.5.0 -> 3.6.0 entman: 3.5.0 -> 3.6.0 mgmt: 3.5.0 -> 3..0 provman: 3.5.0 -> 3.6.0 redis: 6.2.13 -> 6.2.16-debian-12-r3
使用该 -j 选项以 JavaScript Object Notation (JSON) 格式呈现版本信息。
使用 APM 实用程序卸载并删除 APM
使用 apm 实用程序脚本卸载 APM 配置。该 uninstall 命令将恢复您在设置 APM 时执行的操作。使用此命令可将 APM 恢复到安装应用程序后、执行任何设置配置之前的状态。
要卸载 APM:
$ sudo -E apm stop --context context-name sudo -E apm unlink --context context-name
卸载 APM 后,我们建议您使用 Debian 卸载过程删除整个软件包。
$ sudo sudo -E apm clean [-h] [--log {error | warn | info | debug}] [--no-color] [--docker] [--release release-number] [--dry-run] [--uninstall] [--cluster-repos] ]
有关 apm clean 命令选项,请参阅以下内容:
-
-h或--help—显示帮助消息并退出。 -
--log或-l[error | warn | info | debug] - 调整实用程序脚本的日志级别。 -
--no-color—打印无颜色的邮件。 -
--docker- 清理本地 docker 缓存。 -
--release release-number- 要清理的释放 (默认为未使用的释放)。 -
--dry-run- 列出将要移除的发行版或容器。 -
--uninstall— 卸载所有软件版本并从系统中删除 APM。 -
--cluster-repos- 清理已移除的群集存储库。
如何使用 APM 实用程序访问 APM 配置和操作命令
使用 APM 实用程序访问 APM CLI
要访问 CLI 提示符,请输入以下 apm 实用程序脚本命令:
$ apm cli --context context-name [-p|--pipe]
root@jnpr-apm-mgmt
输入问号以查看可用的顶级 CLI 命令。此命令列表是 Junos OS 顶级命令的子集。
root@jnpr-apm-mgmt> ? Possible completions: clear Clear information in the system configure Manipulate software configuration information file Perform file operations help Provide help information monitor Show real-time debugging information op Invoke an operation script quit Exit the management session request Make system-level requests restart Restart software process set Set CLI properties, date/time, craft interface message show Show system information ssh Start secure shell on another host start Start shell telnet Telnet to another host test Perform diagnostic debugging traceroute Trace route to remote host
有关 Junos OS CLI 基础知识的概述,请参阅 Day One:探索 Junos CLI。有关更多详细信息,请参阅 CLI 用户指南。
使用 APM 实用程序访问和使用 CLI 配置语句
使用 APM 实用程序访问和使用 CLI 操作命令
要监控 APM、查看 APM 配置和统计信息或手动运行某些操作: