APM 安装

如果要安装单个地理位置 APM，则使用本节中的过程。

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

   APM 可作为压缩的 TAR （.tgz） 文件使用。文件名中包含版本号作为名称的一部分。版本号的格式为：<Major>.<Minor>.<Maintenance>

   • Major 是产品的主要版本号。
   • Minor 是产品的次要版本号。
   • Maintenance 是修订号。
2. 在跳转主机上解压 APM TAR （.tgz） 文件，方法是输入：
3. 解压 TAR 文件后运行加载程序脚本。
4. 使用命令 sudo -E apm link --context context-name --version apm-version 链接到群集。该 link 命令将加载的 APM 软件包关联到群集上下文，以准备设置。

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

   • apm-version 是软件版本。

5. 如果您要在红帽 OpenShift 容器平台群集上安装 APM，请使用 OpenShift CLI 登录，然后继续下一步。
   如果您要在 Rancher Kubernetes Engine2 或 BBE Cloudsetup 创建的群集上安装 APM，请继续下一步。
6. 您必须使用容器注册表进行身份验证才能推送 APM 容器镜像。向注册表进行身份验证的方式取决于您是在 Rancher Kubernetes Engine2 创建的群集、BBE Cloudsetup 创建的群集还是红帽 OpenShift 容器平台群集上安装 APM。（有关详细信息，请参阅相应的文档）。
7. 运行 setup 以配置您的安装。该 setup 命令执行以下操作：

   • 收集有关群集环境的信息，例如容器注册表联系信息、保护外部接口所需的密钥和证书、持久存储资源以及与支持 APM 功能相关的其他信息。

   • 建立 Kubernetes 部署的操作参数。

     如果未将该选项或template file-name该选项与bbecloudsetup设置命令一起使用，则需要在设置过程中完成以下提示：

     注意：

     仅使用选项 bbecloudsetup 或选项 template file-name 。您不能同时使用这两个选项。

     • 如果您使用 Rancher Kubernetes Engine2 或 BBE Cloudsetup 创建群集：

       • 外部注册表地址。

       • 外部注册表端口号。

     • 如果您使用的是 Red Hat OpenShift Container Platform 群集：

       • 外部注册表 （FQDN）

       • 内部 （Docker） 注册表地址

       • 内部 （Docker） 注册表端口号

   注意：

   运行 setup时，您可以通过输入 ^d与设置过程进行交互。

   如果要在输入值后更改值，请输入 ^d。输入 ^d后，将删除您之前输入的值，并将默认值用于问题。您可以将该 ^d 操作用于可选的任何设置问题，或者可以为其提供值列表的任何设置问题。

   以下是带有示例输出的设置命令示例：

   注意：

   context context-name 是命令的唯一 setup 必需选项。

   下面列出了可与命令 setup 一起使用的选项：

   • context context-name- 群集的 Kubernetes 上下文名称。

   • h, help- 显示帮助消息并退出。

   • l, log [error, warning, info, debug]- 调整日志级别。

   • no-color- 打印不带颜色的邮件。

   • bbecloudsetup—输入与 BBE Cloudsetup 创建的群集一致的操作参数，以便您在设置过程中不必与 APM 交互（有关群集安装说明，请参阅 BBE Cloudsetup 安装指南 ）。

     注意：

     仅使用选项 bbecloudsetup 或选项 template file-name 。您不能同时使用这两个选项。

   • update- 在设置过程中，系统只会提示您输入缺失值。

   • ssh host:port— 群集的主机名或 IP 地址（群集的任何节点）和用于 SSH 访问 CLI 的开放端口。

     注意：

     启用 SSH 访问需要管理微服务在 特权 模式下运行。

   • secrets—更新 APM 使用的密钥、证书和密钥。

   • verbose- 在每个提示问题之前提供详细说明。

   • configconfig-file-path-name— 您希望 APM 在启动期间使用的初始配置文件的名称。

     注意：

     您可以使用初始配置文件来启动和推出 APM。您可以通过实用程序脚本命令setup上的交换机使用配置文件--config config-file-path-name。

     当 APM 启动或推出时，您在设置过程中提供的配置文件将用于初始化 APM。如果未提供配置文件，APM 将从出厂默认设置开始。如果 BBE 事件收集和可视化应用程序在群集上运行，那么出厂缺省值包括 bbe-ecav syslog 服务器配置。

     提供的配置文件存储在 jumphost 的上下文存储库中。这允许在 APM 启动和停止事件中保留配置。对初始配置的提交不会自动保存到 jumphost 上的永久位置。要更新永久位置的配置，请使用实用程序脚本的 save-config 命令。

     使用该 save-config 命令可确保下次启动和推出 APM 时使用最新配置。要将初始配置恢复到出厂默认设置，请以交互方式进入setup，然后进入 ^d 启动 配置... 问题。

     括号中的操作将更改为 remove。按下以 Enter 接受已部署配置的移除。APM 在执行 stop then rollout 命令序列后恢复到出厂默认配置。

     使用实用程序脚本的 setup 命令更改初始配置文件时，必须执行 stop then rollout 命令序列才能使更改生效。

   • template file-name- YAML 格式的文件，其中包含在设置过程中创建的操作参数文件的子集。设置过程会自动使用在模板文件中输入的值。使用该 template 选项时，无需在设置过程中手动输入模板文件中包含的信息。 表 3 介绍了可在配置文件中 template 输入的信息。

     注意：

     仅使用选项 bbecloudsetup 或选项 template file-name 。您不能同时使用这两个选项。

   • mandatory- 仅在设置过程中询问必填问题。

   • optional- 仅询问设置过程中不需要的问题。

   表 3：安装文件字段说明

   字段	描述
   （选答） 服务帐户名称	用于将某些操作权限绑定到 管理 微服务的 Kubernetes 服务帐户的名称。如果未提供服务帐户名称，APM 会在上线时创建一个名为 apm-svca 的服务帐户。
   外部注册表地址	外部注册表地址是容器映像推送到的 FQDN。
   k8s 的注册表	从中提取容器映像的传输地址或 FQDN：port。
   （选答） APMi 机密	要保护 APMi（推荐），请输入以下一项： APM 命名空间中包含 TLS 密钥数据（根证书颁发机构证书、证书和私钥）的 Kubernetes 密钥的名称 密钥文件（根证书颁发机构证书、证书和私钥） 注意： 如果提供了密钥，则在安装过程中系统不会提示您输入密钥文件。
   启动配置要在部署时挂载到管理 pod 中	用于初始配置的配置文件。如果未提供配置文件，则使用出厂默认配置。
   （选答）运营商备份通信服务地址（仅限 MGeo）	运营商备份通信服务的 IP 地址。输入每个地理位置的群集节点连接到的备份子网中未使用的 IP 地址。此字段仅用于多个地理位置设置。
   网络负载均衡器 APMi 静态 IP 地址	APMi 网络负载平衡器的静态 IP 地址。
   （选答） APMi 端口	APMi 端口号（默认为 20557）。
   （选答） 配置存档服务器	配置 配置存档服务器 选项时，APM 会在每次成功提交后将更新配置的副本存档到外部服务器。 要配置存档配置文件更改的服务器信息，必须输入以下信息： SSH 键信息。提供以下其中一项的信息： APM 命名空间中包含 SSH 私钥数据的 Kubernetes Secret 的名称。 SSH 私钥文件的名称。 注意： 如果提供了密钥名称，系统将不会提示您输入 SSH 私钥文件。 将存档配置文件的服务器的安全复制协议 （SCP） URL。 注意： URL 必须使用以下格式： scp://user-login@server-fqdn:server-port/absolute-file-path （例如 scp://user@host1.mydomain.com:30443/home/user/configs/apm）。 成功提交后，候选配置的 SCP 传输将作为压缩文件传输到存档 URL，其名称如下： apm-identifier_YYYYMMDD_HHMMSS_juniper.conf.n.gz apm-identifier 是 APMi 接口的外部 IP 地址。 YYYYMMDD_HHMMSS 是协调世界时 （UTC） 中的时间戳。 n 是压缩配置回滚文件的编号指定。
   （选答） DBSync 服务类型	apm multi-cluster status APM 实用程序命令通过 Kubernetes 服务从 DBSync 微服务收集要显示的状态。默认情况下，NodePort服务是为此目的创建的。如果选择 LoadBalancer，系统会提示您输入外部 IP 地址，并创建一个包含提供的外部 IP 地址的 MetalLB 池。LoadBalancer系统会为部署时创建的服务分配来自新创建的 MetalLB 池的外部 IP 地址。 注意：此字段仅用于多个地理位置设置。
   首选活动群集	管理微服务最初应在其上变为活动状态的群集（工作负载上下文）的名称。
   用于 APM 配置的存储类的名称	要使用的存储类名称（默认为 jnpr-bbe-storage）。
   要为 APM 配置路径预留的存储量	要保留的存储量。
   （选答） 系统日志详细信息	如果要将 APM 日志信息导出到外部系统日志收集器，请输入以下系统日志服务器信息： IP 地址或全限定域名 端口号 系统日志信息包含在生成的出厂默认配置文件中。如果未使用生成的出厂默认配置文件，而是使用了自己的初始配置文件，则必须包含 system syslog host 包含 syslog 服务器连接详细信息的节。
   （选答） 运营商备份通道 TLS 信息（仅限 MGeo）	操作员备份通道是两个工作负载集群之间的备用子网。该子网用于促进运行状况监控，并在群集间子网（潜航者号隧道穿越）断开连接时协调切换。 输入运维人员备份通道的以下信息： 要保护运维人员备份通道（推荐），请输入以下内容之一： APM 命名空间中包含 TLS 密钥数据（根证书颁发机构证书、证书和私钥）的 Kubernetes 密钥的名称 密钥文件（根证书颁发机构证书、证书和私钥） 每个工作负载群集上操作员备份通道的 IP 地址。如果未提供地址，则不会建立备用通道。建议为每个工作负载群集提供备份地址。备份通道可确保在群集间子网丢失时，多地理位置部署继续正常运行。 注意： 如果提供了密钥，则在安装过程中系统不会提示您输入密钥文件。
   （选答） 初始 APM 配置文件	APM 启动时使用的配置文件。在命令中使用setup该选项时configconfig-file-path-name，请输入文件名。
   （选答） 集群存储类名称	用于创建持久卷声明 （PVC） 的 Kubernetes 存储类的名称。管理微服务使用 PVC 来记录配置状态。在设置过程中看到 Name of the storage class to use for APM config 提示时，请输入 Kubernetes 存储类的名称。
   （选答） 群集存储大小	要为 APM 预留配置路径的存储量，以兆字节 （MiB） 为单位。
   （选答） apm SSH 服务类型	如果指定了 对管理 微服务的 SSH 访问 （ssh <ip>:<port>），则必须指定该服务是应创建为节点端口 （NodePort） 服务还是负载均衡器 （LoadBalancer） 服务。如果选中，将 LoadBalancer 创建一个包含提供的外部 IP 地址的 MetalLB 池。在部署时创建的负载均衡器服务将从新创建的 MetalLB 池中分配外部 IP 地址。 对于单个和多个地理位置设置，您输入 SSH 信息的方式会有所不同。有关您的特定设置，请参阅以下内容： 单一地理位置设置 — 您可以使用命令（选项）ssh提供 SSH 地址setup。如果您提供了带有该ssh选项的 SSH 地址，则设置过程将提示您输入服务类型： Type of apm SSH service -- LoadBalancer -- NodePort 多地理位置设置 — 只能通过模板文件提供 SSH 地址。
   内部 （Docker） 注册表传输地址 （fqdn：port）	内部注册表传输地址是在推出期间从中提取容器映像的地址。此地址通常与外部注册表地址不同。
   （选答） provman 工作进程数	provman 工作进程的数量决定了 provman 如何部署并发进程来处理实体工作负载。我们建议您为每个流程规划 20 个实体。每个进程都可以在其运行的节点上消耗一个 CPU 核心。因此，群集中的节点必须具有足够的 CPU 核心来支持 provman 进程的数量（以及节点上可能运行的任何其他工作负载）。 可以配置 1 到 10 个工作进程（默认为 3）。

8. 通过运行apm version命令验证 APM 安装。

   • context context-name- 群集的 Kubernetes 上下文名称。

   • detail- 显示所有可用的软件版本。

使用此过程可在单个地理位置设置中配置和启动 APM。

1. Enter rollout 开始 APM 安装。您需要将 rollout 命令与 sudo/as root 一起使用。该 rollout 命令验证新版本所需的所有值是否存在，并将新版本容器映像加载到注册表。用于 sudo -E apm rollout --context context-name 启动 APM 服务。例如：

   • context contex-name- 群集的 Kubernetes 上下文名称。

   注意：

   默认情况下，APM 从您在设置过程中提供的值开始。除非已保存配置，否则初始配置即为设置过程中输入的配置。所有其他持久状态（日志、数据库键等）都将被清除。

2. 输入以 apm status --context context-name [-o|--output json] [--detail] 验证 APM 服务是否已启动并正在运行。例如：
   注意：

   收集服务日志，并在出现以下任一情况时联系瞻博网络技术援助中心 （JTAC）：

   • 服务未运行。

   • 与其他服务相比，该服务的正常运行时间表明它已重新启动。

对于由位于不同地理位置的多个 APM 组成的 APM 设置，请使用本部分中的安装过程。

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

   APM 可作为压缩的 TAR （.tgz） 文件使用。文件名中包含版本号作为名称的一部分。版本号的格式为：<Major>.<Minor>.<Maintenance>

   • major 是产品的主要版本号。
   • minor 是产品的次要版本号。
   • maintainance 是修订号。
2. 在跳转主机上解压 APM TAR （.tgz） 文件，方法是输入：
3. 解压 TAR 文件后运行加载程序脚本。
4. 使用命令 sudo -E apm link 链接到群集。在准备运行 setup时，该 link 命令获取工作负载群集上下文列表，并将它们关联到加载的APM软件包。

   • context multi-cluster-context-name- 多地理位置设置的上下文名称。是 multi-cluster-context-name 应用于 link 命令的用户定义字符串，用作两个工作负载群集的通用参考。

   • workload-contexts workload-1-context-name workload-2-context-name- 两个工作负载上下文名称。

   • version software-release— APM 软件版本，如输出所示 apm_loader 。

   图 1 显示了不同上下文在多群集设置中的位置。

   图 1：多地理位置集群
5. 使用 RHOCP 群集时，您可以在使用 OpenShift CLI 对 OpenShift 群集和三个 RHOCP 群集（管理和两个工作负载群集）进行身份验证后与其交互。

   有关要运行的命令的示例，请参阅以下内容：

6. 为了推送 APM 容器镜像，您必须在多群集设置中向每个群集上的注册表进行身份验证。通过以 系统用户 （在 BBE Cloudsetup 配置文件中输入的 系统用户 ）的身份向群集的注册表传输地址（在 BBE Cloudsetup 配置文件中作为系统地址提供的 FQDN）发出 docker 登录名，向注册表进行身份验证。

   有关要运行的命令的示例，请参阅以下内容：

7. 运行 setup 以配置您的安装。该 setup 命令执行以下操作：

   • 收集有关群集环境的信息，例如容器注册表联系信息、保护外部接口所需的密钥和证书、持久存储资源以及与支持 APM 功能相关的其他信息。

   • 建立 Kubernetes 部署的操作参数。

     如果未将该 template file-name 选项与 setup 命令一起使用，则需要在设置过程中完成以下提示：

     • 如果您使用 Rancher Kubernetes Engine2 或 BBE Cloudsetup 创建群集：

       • 外部注册表地址。

       • 外部注册表端口号。

     • 如果您使用的是 Red Hat OpenShift Container Platform 群集：

       • 外部注册表 （FQDN）

       • 内部 （Docker） 注册表地址

       • 内部 （Docker） 注册表端口号

     • 出现提示时，为每个工作负载群集输入以下内容：

       • 群集的名称

       • 群集注册表地址和端口号

   注意：

   运行 setup时，您可以通过输入 ^d与设置过程进行交互。

   如果要在输入值后更改值，请输入 ^d。输入 ^d后，将删除您之前输入的值，并将默认值用于问题。您可以将该 ^d 操作用于可选的任何设置问题，或者可以为其提供值列表的任何设置问题。

   以下是设置命令示例：

   注意：

   要在多地理位置设置中通过 SSH 设置 CLI 访问，必须使用模板文件（使用 template 命令中的 setup 选项）。这使您能够配置两个工作负载群集地址。

   要配置 SSH，请将每个工作负载群集的以下信息（YAML 格式）添加到您在设置过程中提供的模板文件中：

   有关模板文件中的 SSH 配置的更多信息，请参阅以下内容：

   • ip-address- 用于从跳转主机管理群集的 IP 地址。

   • cluster-name- 命令输出 kubectl get clusters 中显示的工作负载群集的名称。

   • available-port-value- 如果在字段中type输入该NodePort选项，则端口值必须是未在任何工作负载群集节点上使用的 TCP 端口。最佳做法是避免使用已在使用的端口（如常用的 SSH 端口 22），但低于临时端口范围（端口 49152 及更高版本）。这可以避免与节点本身可能发生端口争用。

   • service-name- 您希望创建的服务使用的名称。最佳做法是在名称中包含应用程序名称、用途和工作负载群集（例如，apm-ssh-workload1）。

   下面列出了可与命令 setup 一起使用的选项：

   • context multi-cluster-context-name- 多地理位置设置的上下文名称。是 multi-cluster-context-name 应用于 link 命令的用户定义字符串，用作两个工作负载群集的通用参考。

   • h, help- 显示帮助消息并退出。

   • l, log [error, warning, info, debug]- 调整日志级别。

   • no-color- 打印不带颜色的邮件。

   • update- 在设置过程中，系统只会提示您输入缺失值。

   • secrets—更新 APM 使用的密钥、证书和密钥。

   • verbose- 在每个提示问题之前提供详细说明。

   • configfile-name— 您希望 APM 在启动期间使用的初始配置文件的名称。

   • template file-name- YAML 格式的文件，其中包含在设置过程中创建的配置文件的子集。设置过程会自动使用在模板文件中输入的值。使用该 template 选项时，无需在设置过程中手动输入模板文件中包含的信息。仅当使用 Red Hat OpenShift Container Platform 创建群集或创建多地理位置群集时，才应使用该 template 选项。 表 3 介绍了需要在配置文件中 template 输入的信息。

   • mandatory- 仅在设置过程中询问必填问题。

   • optional- 仅询问设置过程中不需要的问题。

8. 通过运行apm version命令验证 APM 安装。

   • context multi-cluster-context-name- 多地理位置设置的上下文名称。是 multi-cluster-context-name 应用于 link 命令的用户定义字符串，用作两个工作负载群集的通用参考。

   • detail- 显示所有可用的软件版本。

使用此过程可在多地理位置设置中配置和启动 APM。

1. Enter rollout 开始 APM 安装。APM 实用程序允许您为 APM 多地理位置设置中的所有微服务推出不同的软件版本。您需要将命令 rollout 与 sudo 作为 root 一起使用。该 rollout 命令还验证新版本所需的所有值是否存在，并将新版本容器映像加载到注册表。例如：

   • context multi-cluster-context-name- 多地理位置设置的上下文名称。是 multi-cluster-context-name 应用于 link 命令的用户定义字符串，用作两个工作负载群集的通用参考。

   • service service-name- 要部署的微服务名称。

   • version software-release- 要部署的软件版本（默认为链接到群集的版本）。

   注意：

   上，不需要首次部署service。用于serviceversion推出（升级）特定服务的特定版本。

   注意：

   默认情况下，APM 从您在设置过程中提供的值开始。除非已保存配置，否则初始配置是设置期间提供的配置。所有其他持久状态（日志、数据库键等）都将被清除。

2. 输入以 apm status --context multi-cluster-context-name --detail 验证 APM 服务是否已启动并正在运行。例如：
   注意：

   收集服务日志，并在出现以下任一情况时联系瞻博网络技术援助中心 （JTAC）：

   • 服务未运行。

   • 与其他服务相比，服务的正常运行时间表明它已重新启动。