Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
本页内容
 

如何使用命令行工具管理 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 实用程序脚本调用的命令，并描述了发生的操作。许多单独的命令都有您可以指定的选项。

表 1：APM 实用程序脚本命令
名称 操作
clean 清理不需要的版本和/或 docker 缓存。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.2 中引入。
cli 访问可用于配置 APM 功能和监控托管 BNG 的当前状态的 CLI。
contexts 显示可用的群集上下文，以便使用 APM 进行控制
注意：

在发行版 3.2 中引入。
db-info 显示 APM 数据库微服务的当前状态，包括当前版本、有状态集 Pod 及其角色。
注意：

在发行版 3.2 中引入。
db-switchover 强制持久状态数据库 （DB） 主 Pod 切换到符合条件的备份 Pod。要运行此命令，您需要 sudo 权限。在发行版 3.2 中引入。
注意：

数据库切换是一个服务中断事件，您只能在升级过程中使用它。
ip 显示地址池管理器的 IP 地址。
注意：

在发行版 3.2 中引入。
link 将群集链接到特定软件版本。
注意：

在发行版 3.2 中引入。
logs 显示 APM 日志。
rename-context 重命名上下文。不会影响群集上正在运行的地址池管理器。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.2 中引入。
restart 重新启动一个或多个指定的服务。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.1 中引入。
rollout 升级或启动 APM 服务。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.2 中引入。
save-config 将地址池管理器的当前配置保存到 Pod 外部的文件中。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.2 中引入。
shell 连接到正在运行的 APM 微服务。要运行此命令，您需要 sudo 权限。
setup 在安装过程中设置 APM 应用程序。要运行此命令，您需要 sudo 权限。
start 启动所有 APM 服务。要运行此命令，您需要 sudo 权限。
status 显示 APM 服务的当前状态。要运行此命令，您需要 sudo root 权限。
storage

提供 APM 的存储驱动程序的状态。

注意：

在发行版 3.2 中引入。
stop 停止所有 APM 服务。要运行此命令，您需要 sudo 权限。
unlink 取消链接与上下文关联的组件。要运行此命令，您需要 sudo 权限。
注意：

在发行版 3.2 中引入。
version 显示 APM 实例中每个正在运行的微服务的版本以及 APM 实用程序。它还列出了系统上所有可用的 APM 软件版本。

使用以下常规语法发出命令：

  • 对于简短选项：

  • 对于长选项：

要将命令定位到特定群集上下文，请使用选项 context 。

要显示带有简要说明的可用命令列表，请使用 h 或 help 选项：

要显示特定命令的选项，请执行以下操作：

要指定 --no-color 选项以禁用彩色文本输出（用于区分日志和不同的微服务）：

使用 APM 安装实用程序将 APM 升级到新版本

使用此过程可升级到新版本的 APM，该版本安装在由 BBE Cloudsetup 实用程序或 Red Hat OpenShift Container Platform Console 创建的集群上。此过程假定您的系统上正在运行 APM。

  1. 从瞻博网络软件下载页面将 APM 软件包下载到跳转主机。

    APM 以压缩压缩包映像 （.tgz） 的形式提供。文件名包含作为名称一部分的版本号。版本号的格式为：<Major>.<Minor>.<Maintenance>

    • major 是产品的主要版本号。
    • minor 是产品的次要版本号。
    • maintenance 是修订号。
  2. 通过输入以下内容，解压缩跳转主机上的 APM tarball （.tgz） 文件：
  3. 解压缩压缩包后，运行加载程序脚本。
  4. 使用link命令链接到群集。命令link将加载的 APM 软件包与群集相关联，以准备安装。

    • context-name 是 Kubernetes 上下文（群集名称）。

    • apm-version 是软件版本。

  5. 如果您要在 Red Hat OpenShift Container Platform 集群上升级 APM，请使用 OpenShift CLI 登录，然后继续执行下一步。
    如果要在 BBE Cloudsetup 创建的集群上安装 APM，请继续执行下一步。
  6. 您必须使用容器注册表进行身份验证，才能推送 APM 容器映像。您向注册表进行身份验证的方式会有所不同，具体取决于您是在 BBE Cloudsetup 创建的集群上还是在 Red Hat OpenShift Container Platform 集群上安装 APM（有关详细信息，请参阅相应的文档）。
  7. 运行setup以完成任何其他环境值。

    • context-name 是 Kubernetes 上下文（集群名称）。

    • update 仅提示缺少值（主要在加载新软件版本后使用）。

  8. 显示正在运行的数据库以查看哪个 Pod 是主 Pod，并确定是否升级持久状态数据库 （DB）：
  9. 显示新包中的数据库版本：
    注意：

    例如，数据库版本 6.2.14-debian-12-r21 晚于正在运行的版本 （6.2.13），因此您需要升级数据库。
  10. 如果不是jnpr-apm-redis-0主数据库，则启动数据库切换。
  11. 推出新的数据库版本。
  12. 使用sudo -E apm rollout –-context context-name –service service-name --version software-version command.按以下顺序输入命令：
  13. 验证所有微服务是否都在运行新版本的软件：

在不使用 APM 实用程序的情况下将 APM 升级到新版本

本节中的说明介绍了在所选的预先存在的 Kubernetes 集群上安装 APM 的升级步骤。此过程是一个手动过程，不使用 APM 安装包附带的 APM 实用程序。

  1. 从瞻博网络软件下载页面将 APM 软件包下载到跳转主机。

    APM 以压缩压缩包映像 （.tgz） 的形式提供。文件名包含作为名称一部分的版本号。版本号的格式为：<Major>.<Minor>.<Maintenance>

    • major 是产品的主要版本号。
    • minor 是产品的次要版本号。
    • maintainance 是修订号。
  2. 通过输入以下内容，解压缩跳转主机上的 APM tarball （.tgz） 文件：
  3. APM 所需的容器映像存储在 images 子目录中。您必须将映像推送到注册表，从中提取计划的应用程序映像。根据所使用的容器注册表类型，命令可能会有所不同。以下命令演示了将容器映像推送到注册表的一种方法：
  4. 要准备要升级的 APM，请为每个微服务创建新的 YAML 配置文件。（微服务的配置文件中的字段如表3所示。
    注意：

    在初始安装过程中，您可能创建了一个 values.yaml，其中包含所有微服务的信息。单个 values.yaml 位于 apm/apm/charts/address_pool_manager 文件夹中的伞形图下。本节中的过程仅介绍在为每个微服务创建单独的 YAML 配置文件时如何升级。

    为每个微服务创建一个新的 values.yaml 文件，方法是复制该文件，然后保存新文件。根据 Kubernetes 集群的信息更新每个文件。
    以下是微服务及其 values.yaml 文件位置：

    • redis 微服务 - 位于 apm/apm/charts/redis

    • 管理 微服务 - 位于 apm/apm/charts/mgmt

    • addrman 微服务 - 位于 apm/apm/charts/addrman

    • entman 微服务 - 位于 apm/apm/charts/entman。

    • Provman 微服务 - 位于 apm/apm/charts/provman

  5. 运行依赖项更新命令：
  6. 在对每个微服务的新values.yaml文件进行所有所需的更改后，微服务必须与新values.yaml文件一起部署。

    运行以下命令：

  7. 通过运行 Kubernetes 命令行工具命令kubectl get pods验证 APM 安装，并验证 APM Pod 是否正在运行。
  8. 验证服务是否存在。运行 Kubernetes Command Line Tool 命令kubectl get services。

使用 APM 实用程序启动或停止 APM 服务

apm使用实用程序脚本启动或停止所有 APM 服务。服务按依赖项顺序启动。基本服务（db 和 mgmt）首先开始，然后是其他服务。服务按依赖关系的相反顺序停止。

  • 要启动所有 APM 服务，请执行以下操作：

    注意：

    我们建议您使用 sudo -E apm start ––services 选项来启动单个服务或一组服务，仅用于故障排除。在瞻博网络支持代表的指导下使用。请谨慎使用，因为此命令类似于重新启动到出厂默认设置。
    注意：

    当您执行 apm setup 命令时，APM 从其初始设置开始。执行命令时 apm stop ，任何持久状态都将丢失。可以使用 apm save-config 命令保存当前配置。保存的配置是下次启动 APM 时使用的配置。

  • 要停止所有 APM 服务，请执行以下操作：

使用 Kubernetes 命令行工具重新启动 APM 服务

kubectl delete pods使用 Kubernetes 命令重新启动 APM 服务。例如：

注意：

要确定 Pod 名称，可以使用 kubectl get pods -n jnpr-apm Kubernetes 命令（请参阅 使用 Kubernetes 命令行工具检查 APM 服务的状态）。

使用 APM 实用程序设置密钥

您可以在安装过程中设置密钥，也可以运行以 sudo -E apm setup --context context-name --secrets 设置密钥或更新密钥。

注意：

如果为机密名称输入值，则不会要求你提供密钥或认证文件。

使用 APM 实用程序显示数据库信息

命令 apm db-info 显示 APM 数据库微服务的当前状态，包括当前版本、有状态集 Pod 及其角色。

apm db-info [--context context-name] [-o|--output json]

使用 Kubernetes 命令行工具显示正在运行的数据库

kubectl exec使用 Kubernetes 命令显示正在运行的数据库 （DB），以查看哪个 Pod 是主 Pod 并确定是否升级持久状态数据库。您应该在主 Redis 服务器实例和辅助 Redis 服务器实例上运行。kubectl exec例如：

使用 Kubernetes 命令行工具执行数据库切换

要强制持久状态数据库 （DB） 主 Pod 切换到符合条件的备份 Pod，请执行以下操作：

  1. kubectl get pods运行Kubernetes 命令以确定哨兵 Pod 的名称。
  2. 选择三个哨兵 Pod 中的任何一个以配合kubectl exec命令使用。以下示例使用 jnpr-apm-redis-sentinels-0 sentinel pod。运行以下命令后，redis 实例的角色将受到重视（redis-0 是辅助实例，redis-1 是主实例）。

使用 APM 实用程序检查 APM 服务的状态

apm status使用实用程序脚本检查表 2 中列出的每个 APM 服务（功能组件）的状态。状态显示服务是正在运行、已退出还是尚未启动。它还会在 Kubernetes Pod 上显示服务名称。您可以比较服务的正常运行时间，以快速查看是否有任何服务已重新启动。

表 2：使用 status 命令显示的服务

微服务

Pod 前缀

addrman - 地址管理器

JNPR-APM-ADDRMAN

mgmt — CLI 管理

JNPR-APM-管理

redis （远程词典服务器）—由一组提供持久数据库的 Pod 组成。

jnpr-apm-redis

entman - 实体管理器

jnpr-apm-entman

provman - 调配经理

jnpr-apm-provman

要检查状态，请执行以下操作：

  1. 显示服务状态。
  2. （可选）以 JavaScript 对象表示法 （JSON） 格式呈现版本信息，这对于编写脚本接口很有用。

例如：

使用 Kubernetes 命令行工具检查 APM 服务的状态

使用 Kubernetes 命令行工具检查 表 2 中列出的每个 APM 服务（功能组件）的状态。状态显示服务是正在运行、已退出还是尚未启动。它还会在 Kubernetes Pod 上显示服务名称。您可以比较服务的正常运行时间，以快速查看是否有任何服务已重新启动。

表 3：使用 status 命令显示的服务

微服务

Pod 前缀

addrman - 地址管理器

JNPR-APM-ADDRMAN

mgmt — CLI 管理

JNPR-APM-管理

redis （远程词典服务器）—由一组提供持久数据库的 Pod 组成。

jnpr-apm-redis

entman - 实体管理器

jnpr-apm-entman

provman - 调配经理

jnpr-apm-provman

要检查状态，请运行以下命令：

例如：

使用 APM 实用程序显示 APM IP 地址

apm ip使用实用程序脚本显示编排 APM Pod 所需的 Kubernetes 对象。例如：

使用 Kubernetes 命令行工具显示 APM IP 地址

kubectl get services使用 Kubernetes 命令显示编排 APM Pod 所需的 Kubernetes 对象。例如：

使用 APM 实用程序显示日志记录

apm logs使用实用程序脚本显示 APM 运行时发生的事件的日志。您还可以使用 BBE 事件收集和可视化实用程序来显示自 APM 启动以来收集和存储的基于文件的日志。BBE 事件收集和可视化是一个基于云的集中式实用程序，它提供了一种捕获跨越 APM 微服务生命周期的 APM 日志的方法。设置 APM 时，您可以链接到 BBE 事件收集和可视化日志记录实用程序。请参阅《宽带边缘事件收集和可视化安装指南》。

显示 APM 日志记录

BBE 事件收集和可视化是一个基于云的集中式实用程序，它提供了一种捕获跨越 APM 微服务生命周期的 APM 日志的方法。如果您设置了 BBE 事件集合和可视化，则在 APM 设置期间，您可以指向 BBE 事件集合和可视化来执行日志记录。BBE Event Collection and Visualization 具有基于 Web 的 OpenSearch 功能界面，用于对收集的系统日志事件进行高级搜索、聚合、查看和数据分析。

apm logs使用实用程序脚本显示 APM 运行时发生的事件的日志。事件日志包括以下非详尽列表中显示的事件：

  • 池域注册事件

  • 地址分配失败

  • 网络实体连接失败

  • 启动消息

  • 网络实体重新同步事件

  • 池和分区利用率阈值和耗尽警告

默认情况下，APM 将日志发送到服务的标准输出 （stdout）。输出显示所有服务或指定服务的循环缓冲区。您还可以启用日志记录以跟踪正在运行的服务的日志输出。遵循日志输出会创建一个打开的会话，该会话会连续将日志流式传输到 stdout。

APM 日志记录功能掩盖了收集日志信息的命令的底层复杂性 kubectl log 。您仍然可以使用命令 kubectl log ，但这不在本文档的讨论范围之内。

注意：

可以使用第三方应用程序捕获和重定向容器的 stdout 流。请参阅您的第三方文档以获取帮助。您还可以使用不同的日志记录驱动程序配置 Docker 以重定向 stdout。请参阅 Docker 文档以获取帮助。

要显示所有服务的 APM 日志，请执行以下操作：

最佳实践：

apm logs ––services仅当在瞻博网络支持代表的指导下进行故障排除时，才使用选项。

要遵循所有服务的日志，请指定以下选项 （-f）：

要在 Kubernetes Pod 中查看容器先前实例的日志，请指定先前的容器选项 （-p）：

您可以使用标准 Ubuntu 约定将日志重定向到文件或终端和文件。有关更多信息，请参阅 Ubuntu 文档，但您可以使用以下示例作为起点：

  • 仅将所有日志重定向到一个文件。

  • 将所有日志重定向到屏幕和文件。

最佳实践：

仅在瞻博网络支持代表的指导下将该 ––services 选项用于故障排除。

您可以按严重性递增的顺序指定以下任一严重性级别：

表 4：严重性级别
严重性级别 说明
debug 通常仅在您尝试诊断问题时才感兴趣的详细信息。这些日志通常非常频繁。
info 关注的事件或非错误条件。此级别的日志可确认一切正在按预期工作。这些日志通常不是很频繁。
warning 表示发生了一些意外的事情，或者在不久的将来可能会出现一些问题。后者的一个简单示例是 磁盘空间不足 警告，该警告表示您可能很快就会耗尽磁盘空间。在任何一种情况下，软件仍按预期工作，但您可能需要更密切地监视它。这些日志通常不是很频繁。
error 表示更严重的问题阻止了软件执行某些功能，但软件已尽可能优雅地处理了问题以继续运行。
critical 指示程序本身可能无法继续运行的严重错误。

--logset您可以使用选项仅显示 APM 服务的日志，也可以仅显示预构建服务的日志。如果不使用此选项，则仅显示 APM 服务日志。

要仅显示 APM 服务的日志，请执行以下操作：

要显示预构建服务的日志，请执行以下操作：

预构建服务是从其他来源借用的服务，用于为 APM 提供基础架构功能。这些来源包括 MGMT、redis 和 redis-sentinel。例如，redis 提供数据库和消息服务，MGMT 提供配置/CLI 服务等。

使用 Kubernetes 命令行工具显示日志

要显示 APM 运行时发生的所有事件日志，请运行以下命令：

要显示特定微服务的日志，请将标签选择器 （-l jnpr/logset=jnpr-apm） 替换为 Pod 名称。例如：

注意：

要确定 Pod 名称，可以使用 kubectl get pods -n jnpr-apm Kubernetes 命令（请参阅 使用 Kubernetes 命令行工具检查 APM 服务的状态）。

使用 APM 实用程序确定 APM 版本

apm version [--context <context name>] [-o|--output json] [--detail| --compare <software-version>]使用实用程序脚本确定已安装的 APM 版本的版本号。

要显示发行版：

要将指定的软件版本版本与指定上下文的当前部署版本进行比较，请执行以下操作：

-j使用选项以 JavaScript 对象标记 （JSON） 格式呈现版本信息。

使用 Kubernetes 命令行工具存档 APM 配置

要存档当前正在运行的 APM 配置的副本，请输入以下命令：

使用 APM 实用程序卸载和删除 APM

apm使用实用程序脚本卸载 APM 配置。该uninstall命令将恢复您在设置 APM 时执行的操作。使用此命令可将 APM 恢复到安装应用程序后、执行任何设置配置之前的状态。

要卸载 APM，请执行以下操作：

卸载 APM 后，我们建议您使用 Debian 卸载过程移除整个软件包。

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 时使用的卸载过程。您可以使用命令 helm uninstall 卸载 APM 配置。要完全删除 APM，您必须为每个微服务运行 helm uninstall 命令。

要卸载 APM，请运行以下命令：

如何使用 APM 实用程序访问 APM 配置和操作命令

使用 APM 实用程序访问 APM CLI

要访问 CLI 提示符，请输入以下 apm 实用程序脚本命令：

输入问号以查看可用的顶级 CLI 命令。此命令列表是 Junos OS 顶级命令的子集。

有关 Junos OS CLI 基础知识的概述，请参阅 第一天：探索 Junos CLI。有关详细信息，请参阅 CLI 用户指南。

使用 APM 实用程序访问和使用 CLI 配置语句

  1. 使用 APM 实用程序命令apm cli访问顶级 CLI 提示符。
  2. 访问配置模式以配置 APM 以及 APM 用于配置托管路由器的信息。
  3. 输入 CLI 语句以配置 APM 管理的 BNG、池域、池和系统属性。
  4. 保存并激活配置。仅当没有配置语法错误时，此命令才会成功。
  5. （可选）退出配置模式并返回到顶级 CLI 提示符。

使用 APM 实用程序访问和使用 CLI 操作命令

要监控 APM，请查看 APM 配置和统计信息，或手动运行某些操作：

  1. 使用 APM 实用程序命令apm cli访问顶级 CLI 提示符。
  2. 输入特定命令。

    • 使用 show 命令显示统计信息以及分区、BNG、池域和池之间的关系。

    • 使用 request 命令手动启动某些 APM 操作。

如何在不使用 APM 实用程序的情况下使用 APM 命令行工具

本节介绍如何使用 Kubernetes 命令行工具命令执行管理功能。

您可以使用 Kubernetes 命令行工具管理应用程序并访问用于配置地址管理功能的 CLI。

您可以使用 Kubernetes 命令行工具执行以下操作：

  • 创建和删除对象。
  • 提供日志访问权限。
  • 使用 Pod 容器进行交互式会话。
  • 显示 APM 对象的状态。

访问 APM 命令行工具，而无需使用 APM 实用程序

要使用 Kubernetes 命令访问 APM 命令行工具，请输入以下内容：

输入问号以查看可用的顶级 CLI 命令。