交互式安装指南

集群环境的需求

要为应用程序设置集群环境，需要下列服务器：

• 一个服务器用于托管 和 （可以将 安装在它自己的专用服务器上）。
• 两个或更多节点用来托管 应用程序实例。
• 两个或更多节点用来托管 QM 应用程序实例。
• 一个服务器用来托管负载均衡器 (HAProxy)。 可为每个应用程序安装单独的负载均衡器，也可以使用同一个负载均衡器将流量路由到多个应用程序。
• 一个服务器用来托管 MQTT 代理 ()。
• 一个服务器用来托管数据库。

注： 是缺省安装在 上的 Java 应用程序。 为了提高性能，请考虑在集群中再添加一台服务器，专用于 。

要设置具有 HAProxy 高可用性的系统，需要下列服务器：

• 一个服务器用来托管 。
• 两个服务器用来托管 （其中一个服务器采用备用方式）。
• 两个或更多节点用来托管 应用程序实例。
• 两个或更多节点用来托管 QM 应用程序实例。
• 两个服务器用来托管负载均衡器 (HAProxy)。
• 两个服务器用来托管 MQTT 代理 ()。
• 一个服务器用来托管数据库。

环境中的所有服务器都必须已配置它们的标准主机名称。 更新 /etc/hosts 文件时，请使用 IP fully-qualified-host-name alias [,alias] 格式。 请注意，标准主机名必须显示在任何别名前面。 否则，可能不会对多个节点启用集群。

有关 系统需求的列表，请参阅系统需求。

设置 HAProxy 负载均衡器

注：不支持在 Windows 平台上安装 HAProxy 负载均衡器。

您必须安装和配置 HAProxy 之后才能激活集群。 有关 HAProxy 的更多信息，请参阅 www.haproxy.org。

注：还可以配置和使用 IHS 而不是 HAProxy，但在集群中仅必须使用这两种方法中的一种方法来进行负载均衡。

I. 安装非 Dockerized 版本的 HAProxy

HAProxy 是正式的 Red Hat Linux 存储库的一部分，可以使用 yum 命令来安装 HAProxy。 您必须具有 root 用户许可权，否则，请使用 sudo 命令来执行安装。

1. 要安装 HAProxy，请打开命令 shell 并输入以下命令：

   yum -y install haproxy

2. 缺省情况下，HAProxy 安装在 /usr/local/haproxy/etc/haproxy 目录中。 请转至 HAProxy 安装目录，并备份 haproxy.cfg 文件。 例如，创建 haproxy.cfg.backup 文件。
3. 打开 haproxy.cfg 文件进行编辑，并根据需要对其进行配置。 使用以下示例作为参考。 有关配置语言和可用选项的更多详细信息，请参阅 HAProxy 配置手册。
   
   

   注：如果 的前端具有 HAProxy，请参阅此 Depolyment Wiki 文档的 haproxy.cfg 样本文件。

   用于 集群的 haproxy.cfg 样本文件

   # ---------------------------------------------------------------------
   # 可能的 Web 应用程序的示例配置。 请参阅
   # 联机完整配置选项。
   #
   # http://haproxy.1wt.eu/download/1.6/doc/configuration.txt
   #
   # ---------------------------------------------------------------------
   
   # ---------------------------------------------------------------------
   # 全局设置
   # ---------------------------------------------------------------------
   全局
   # 如果不使用 dockerized 版本，那么
   # 要使这些消息在 /var/log/haproxy.log 中结束，您将
   # 需要:
   #
   # 1) 配置 syslog 以接受网络日志事件。 具体做法是
   # 在'-r' 选项到
   # /etc/sysconfig/rsyslog
   #
   # 2) 配置 local2 事件到 /var/log/haproxy.log
   # 文件。 A line like the following can be added to
   # /etc/sysconfig/rsyslog
   #
   # local2.* /var/log/haproxy.log
   #
   # 3) uncomment the line below and comment the other log line
   #log 127.0.0.1 local2
   log /dev/log local2
   
   chroot /var/lib/haproxy
   pidfile /var/run/haproxy.pid
   maxconn 6000
   user haproxy
   group haproxy
   daemon
   
   # turn on stats unix socket
   stats socket /var/lib/haproxy/stats
   
   tune.ssl.default-dh-param 2048
   
   #---------------------------------------------------------------------
   # common defaults that all the 'listen' and 'backend' sections will
   # use if not designated in their block
   #---------------------------------------------------------------------
   defaults
   mode http
   option dontlognull
   option http-keep-alive
   option redispatch
   retries 3
   timeout http-request 10s
   timeout queue 1m
   timeout connect 10s
   timeout client 2h
   timeout server 2h
   timeout http-keep-alive 10s
   timeout check 10s
   maxconn 6000
   
   #---------------------------------------------------------------------
   # main frontend which proxys to the backends
   #---------------------------------------------------------------------
   frontend lanneluc-proxy
   bind *:80
   bind *:9443 ssl crt /etc/haproxy/ssl/proxy.pem no-sslv3
   log global
   option httplog
   mode http
   capture cookie SERVERID len 32
   redirect scheme https if !{ ssl_fc }
   maxconn 2000 # The expected number of the users of the system.
   # 将套接字限制为此数目的并发连接。 无关的
   # 连接将保留在系统的待办事项中，直到连接
   # 释放为止。 如果未指定，那么限制将与前端的
   # maxconn 相同。
   default_backend ccm
   
   
   backend ccm
   
   option forwardfor
   http-request set-header X-Forwarded-Port %[dst_port]
   http-request add-header X-Forwarded-Proto https if { ssl_fc }
   fullconn 1000 # 如果未指定、HAProxy
   
   
   balance leastconn
   Cookie SERVERID insert indirect nocache secure attr "SameSite=None"
   
   # minconn = 100、服务器将始终接受至少 100 个，
   # 但不超过 "maxconn "的连接。 应与 Liberty
   # server.xml
   中的设置相同。
   # 将对超额进行排队。 The total for all nodes should be equal to maxxcon
   # on 'frontend'
   server ccm1 node1.host.com:9443 minconn 100 maxconn 500 ssl check cookie ccm1 verify none
   server ccm2 node2.host.com:9443 minconn 100 maxconn 500 ssl check cookie ccm2 verify none
   server ccm3 node3.host.com:9443 minconn 100 maxconn 500 ssl check cookie ccm3 verify none
   server ccm4 node5.host.com:9443 minconn 100 maxconn 500 ssl check cookie ccm4 verify none
   
   # Uncomment the following section if your MessageBroker is fronted by HAProxy (for example if in High Availability mode)
   #
   # # connect MessageBroker cluster in tcp mode (N servers if HA mode, or a single server if IoT MessageBroker just must be fronted by proxy)
   # listen MessageBroker
   # bind *:1883
   # mode tcp
   # balance leastconn
   # option tcplog
   # server MessageBroker1 [MessageBroker server 1 URI]:1883 check
   # server MessageBroker2 [MessageBroker server 2 URI]:1883 check
   # # connect MessageBroker cluster in HTTP mode to allow gathering of MQTT statistics (6.0.6 and newer only) (N servers if HA mode, or a single server if IoT MessageBroker just must be fronted by proxy)
   # listen MessageBroker_REST
   # bind *:9089 ssl crt /etc/haproxy/ssl/msigh.pem no-sslv3 # Port (9089) must match that configured in MessageBroker, and the same port needs to be specified in MQTTStatsService advanced property
   # mode http
   # option tcp-check # Must tell HAProxy to use TCP port to do health checks
   # balance leastconn
   # # Same number of entries and same servers as in the section above:
   # server MessageBroker_REST1 [MessageBroker server 1 URI]:9089 check port 1883 # Same ports (1883 and 9089) as used elsewhere in this file.
   # server MessageBroker_REST2 [MessageBroker server 2 URI]:9089 check port 1883 # 与本文件其他地方使用的端口（1883 和 9089）相同。
   
   listen statistics
   bind *:1936
   stats uri /
   stats admin if TRUE
   stats enable
   stats hide-version
   stats auth root:clu8ter8
   统计刷新 5s
   

   用于 QM 集群的 haproxy.cfg 样本文件

   # ---------------------------------------------------------------------
   # 可能的 Web 应用程序的示例配置。 请参阅
   # 联机完整配置选项。
   #
   # http://haproxy.1wt.eu/download/1.6/doc/configuration.txt
   #
   # ---------------------------------------------------------------------
   
   # ---------------------------------------------------------------------
   # 全局设置
   # ---------------------------------------------------------------------
   全局
   # 如果不使用 dockerized 版本，那么
   # 要使这些消息在 /var/log/haproxy.log 中结束，您将
   # 需要:
   #
   # 1) 配置 syslog 以接受网络日志事件。 具体做法是
   # 在'-r' 选项到
   # /etc/sysconfig/rsyslog
   #
   # 2) 配置 local2 事件到 /var/log/haproxy.log
   # 文件。 A line like the following can be added to
   # /etc/sysconfig/rsyslog
   #
   # local2.* /var/log/haproxy.log
   #
   # 3) uncomment the line below and comment the other log line
   #log 127.0.0.1 local2
   log /dev/log local2
   
   chroot /var/lib/haproxy
   pidfile /var/run/haproxy.pid
   maxconn 6000
   user haproxy
   group haproxy
   daemon
   
   # turn on stats unix socket
   stats socket /var/lib/haproxy/stats
   
   tune.ssl.default-dh-param 2048
   
   #---------------------------------------------------------------------
   # common defaults that all the 'listen' and 'backend' sections will
   # use if not designated in their block
   #---------------------------------------------------------------------
   defaults
   mode http
   option dontlognull
   option http-keep-alive
   option redispatch
   retries 3
   timeout http-request 10s
   timeout queue 1m
   timeout connect 10s
   timeout client 2h
   timeout server 2h
   timeout http-keep-alive 10s
   timeout check 10s
   maxconn 6000
   
   #---------------------------------------------------------------------
   # main frontend which proxys to the backends
   #---------------------------------------------------------------------
   frontend lanneluc-proxy
   bind *:80
   bind *:9443 ssl crt /etc/haproxy/ssl/proxy.pem no-sslv3
   log global
   option httplog
   mode http
   capture cookie SERVERID len 32
   redirect scheme https if !{ ssl_fc }
   maxconn 2000 # The expected number of the users of the system.
   # 将套接字限制为此数目的并发连接。 无关的
   # 连接将保留在系统的待办事项中，直到连接
   # 释放为止。 如果未指定，那么限制将与前端的
   # maxconn 相同。
   default_backend qm
   
   
   backend qm
   
   option forwardfor
   http-request set-header X-Forwarded-Port %[dst_port]
   http-request add-header X-Forwarded-Proto https if { ssl_fc }
   fullconn 1000 # 如果未指定、HAProxy
   
   
   balance leastconn
   cookie SERVERID insert indirect nocache secure attr "SameSite=None"
   
   # minconn = 100、服务器将始终接受至少 100 个，
   # 但不超过 "maxconn "的连接。 应与 QM Liberty 相同
   # server.xml
   # maxconn = 500，即发送到服务器的最大连接数。
   # 将对超额进行排队。 The total for all nodes should be equal to maxxcon
   # on 'frontend'
   server qm1 node1.host.com:9443 minconn 100 maxconn 500 ssl check cookie ccm1 verify none
   server qm2 node2.host.com:9443 minconn 100 maxconn 500 ssl check cookie qm2 verify none
   server qm3 node3.host.com:9443 minconn 100 maxconn 500 ssl check cookie qm3 verify none
   server qm4 node5.host.com:9443 minconn 100 maxconn 500 ssl check cookie qm4 verify none
   
   # Uncomment the following section if your MessageBroker is fronted by HAProxy (for example if in High Availability mode)
   #
   # # connect MessageBroker cluster in tcp mode (N servers if HA mode, or a single server if IoT MessageBroker just must be fronted by proxy)
   # listen MessageBroker
   # bind *:1883
   # mode tcp
   # balance leastconn
   # option tcplog
   # server MessageBroker1 [MessageBroker server 1 URI]:1883 check
   # server MessageBroker2 [MessageBroker server 2 URI]:1883 check
   # # connect MessageBroker cluster in HTTP mode to allow gathering of MQTT statistics (6.0.6 and newer only) (N servers if HA mode, or a single server if IoT MessageBroker just must be fronted by proxy)
   # listen MessageBroker_REST
   # bind *:9089 ssl crt /etc/haproxy/ssl/msigh.pem no-sslv3 # Port (9089) must match that configured in MessageBroker, and the same port needs to be specified in MQTTStatsService advanced property
   # mode http
   # option tcp-check # Must tell HAProxy to use TCP port to do health checks
   # balance leastconn
   # # Same number of entries and same servers as in the section above:
   # server MessageBroker_REST1 [MessageBroker server 1 URI]:9089 check port 1883 # Same ports (1883 and 9089) as used elsewhere in this file.
   # server MessageBroker_REST2 [MessageBroker server 2 URI]:9089 check port 1883 # 与本文件其他地方使用的端口（1883 和 9089）相同。
   
   listen statistics
   bind *:1936
   stats uri /
   stats admin if TRUE
   stats enable
   stats hide-version
   stats auth root:clu8ter8
   统计刷新 5s
   

   必须确保已正确输入该配置文件中的若干重要条目：

   • /etc/haproxy/ssl/proxy.pem：此条目所引用的证书必须可用于 HAProxy，以便代理服务器可以检查通过 SSL 加密的流量。 会话亲缘关系需要此功能，会话亲缘关系是 中重要的集群组成部分。
   • balance leastconn：这是均衡策略。 cookie SERVERID insert indirect nocache secure attr "SameSite=None" 设置可确保用户登录信息在不同会话之间传递。 如果没有此设置，那么用户在浏览到任何需要用户验证的 URL 之后，将需要再次登录。
   • 后端服务器：将 ccmxqmx 替换为应用程序名称，并将 nodex.host.com:9443 替换为服务器 URL。
   • minconn、maxconn 和 fullconn：最小连接数、最大连接数和完全连接数参数。
   • 管理界面：

     侦听统计信息
     bind *: 1936
     stats uri/
     stats admin if TRUE
     stats enable
     stats hide-version
     stats auth root:clu8ter8
     stats 刷新 5s
     

     后续章节中详细说明了这些条目。

4. 打开命令 Shell，并输入以下命令来启用该服务：

   systemctl enable haproxy

5. 输入以下命令来启动该服务：

   service haproxy start

二. 安装证书

HAProxy 需要证书来解析已加密的流量。 您可以使用自签名证书。 下列命令将为您的测试环境创建自签名证书，但在必要时，您必须获取实际证书。

OpenSSL 将提示您输入证书的详细信息，例如主机名等。 双引号是可选的。 主机名 (CN) 是安装了 HAProxy 的服务器的主机名：

cd /usr/local/haproxy/etc
openssl genrsa -des3 -out ssl/proxy.key 2048
openssl req -new -key "ssl/proxy.key" -out "ssl/proxy.csr"
openssl x509 -req -days 365 in "ssl/proxy.csr" -signkey "ssl/proxy.key" -out "ssl/proxy.crt"
cat ssl/proxy.crt ssl/proxy.csr > ssl/proxy.pem

三. 使用负载均衡规则

HAProxy 提供了若干负载均衡算法。 在配置示例中，使用了 balance leastconn 选项。 balance leastconn 选项指示 HAProxy 将流量定向至连接数最少的后端服务器。

四. 配置后端服务器

后端服务器是配置文件中以 "server" 开头的行。 这些条目指示 HAProxy 将流量重定向至节点。 在配置示例中，有 4 个节点。 请将 nodex.host.com 部分替换为 或 服务器（副本）所安装在的服务器（节点）的实际主机名。

可以对 HAProxy 进行预配置，以使其后端服务器（节点）数与您计划具有的 或 节点数一样多。 对于初始设置阶段，通过注释掉除第一行之外的所有其他服务器行，从一个节点上的一个 或 实例开始进行设置：

示例：

服务器 ccm1 node1.host.com: 9443 minconn 100 maxconn 500 ssl check cookie ccm1 verify none
#server ccm2 node2.host.com: 9443 minconn 100 maxconn 500 ssl check cookie ccm2 verify none
#server ccm3 node3.host.com: 9443 minconn 100 maxconn 500 ssl check cookie ccm3 verify none
#server ccm4 node5.host.com: 9443 minconn 100 maxconn 500 ssl check cookie ccm4 verify none

QM 示例：

服务器 qm1 node1.host.com: 9443 minconn 100 maxconn 500 ssl check cookie qm1 verify none
#server qm2 node2.host.com: 9443 minconn 100 maxconn 500 ssl check cookie qm2 verify none
#server qm3 node3.host.com: 9443 minconn 100 maxconn 500 ssl check cookie qm3 verify none
#server qm4 node5.host.com: 9443 minconn 100 maxconn 500 ssl check cookie qm4 verify none

配置 HAProxy 之后，如果它正在作为服务运行，那么可以通过输入以下命令来启动、停止和重新启动它：

sudo service haproxy start|stop|restart|reload

V. 优化连接数

minconn、maxconn 和 fullconn 参数用来对服务器进行微调以及控制服务器可以处理的同时存在的连接数。 如果建立了更多连接，那么将对超额的连接进行缓存。 可能很难确定这些参数的最佳连接数，因为最佳连接数取决于期望用户数和服务器响应能力，而这可能会受到可用资源量和网络带宽等的影响。 可以根据预期要使用集群应用程序的用户数，对连接数进行微调。

这些数目还与 的配置方式相关。 默认情况下，运行 的 实例配置为 coreThreads="100" ，这是处理传入请求的最低线程数。 最大值受到可用系统资源量的限制。 因此，minconn 参数应设置为 coreThreads 设置的值。 后端部分（即，每个后端服务器都有一个后端部分）中的 maxconn 值应设置为服务器能够处理并且对性能或响应时间不会有任何不良影响的最大用户数。 在先前提供的配置示例中，maxconn 值在每个后端都设置为 500。 所有后端 maxconn 值的总计应该等于配置文件的前端部分中设置的 maxconn 值。 例如，如果有四个节点，每个节点设置为 maxconn=500，那么前端中的 maxconn 值应设置为 2000。

六. 访问监视控制台和日志

配置文件中的最后部分指定如何访问 HAProxy 监视控制台。 该控制台显示节点数和节点状态以及传入流量和传出流量。 对于运行良好的集群，如果已使所有节点在几乎相同的时间联机，那么会话数（Total 和 lbTotal）应该大致相同，并且不同节点上所传输的字节数应该相差不大。 应当没有错误或警告。

HAProxy 会在以下目录中保留一个日志文件：/var/log/haproxy.log。 此日志文件包含有关哪些请求已重定向至哪些后端服务器的信息以及其他 HAProxy 信息，例如，会话亲缘关系 Cookie 和响应代码。

可选：设置 HAProxy 高可用性

可选：设置定制负载均衡

HAProxy 提供了用于适用和调整其行为的不同参数，其中包括名为 weight 的属性，您可以使用此属性来标识用于负载均衡的服务器。 此属性仅用于第一个会话请求，因为此会话的所有其他请求都将通过会话亲缘关系路由至同一服务器。 权重必须是 1 到 256 之间的值。 如果未设置 weight 属性，那么会使用缺省值 1。

可以将 weight 属性添加至后端中的任何服务器声明，如以下行中所示：

后端 ccm
...
server ccm1 node1.host.com:9443 minconn 100 maxconn 500 ssl check weight 50 cookie ccm1 verify none

后端 qm
...
server qm1 node1.host.com:9443 minconn 100 maxconn 500 ssl check weight 50 cookie qm1 验证无

weight 参数使您可以为服务器定义特定权重。 但是，每当您要变更权重时，都必须编辑 haproxy.cfg 文件。 为了避免打开 haproxy.cfg 文件来变更权重，可以使用套接字接口，以在 HAProxy 服务器处于运行状态时变更权重。 使用以下过程来安装 Socat 程序，该程序允许您将消息发送至 HAProxy TCP 统计信息套接字：

过程

1. 要安装 Socat，请在 Shell 中输入以下命令：

   yum -y install socat

2. 打开 haproxy.cfg 文件并进行编辑，以声明套接字并设置其许可权和级别。 请将下列行添加至 haproxy.cfg 的 general 部分。 在以下示例中，使用了 /var/lib/haproxy/stats.sock 目录中的套接字。 仅允许在 haproxy.cfg 文件中声明为 HAProxy 用户的用户连接至套接字方式 600。 访问级别设置为 administrator，以允许使用套接字来更新 weight 参数：

   stats 套接字 /var/lib/haproxy/stats.sock mode 600 level admin
   stats timeout 2m

3. 重新启动 HAProxy 服务器。
4. 根据服务器活动来确定节点的正确权重。 可以从所有节点收集系统数据，然后根据所收集的数据来计算权重。 根据系统数据计算正确的权重之后，可以创建脚本，并将该权重用于所有节点。 在以下示例中，ccm 是后端的名称，ccm1 是服务器节点的名称，新权重设置为 50：

   echo "set weight ccm/<serverName> <newWeight>" | socat unix-connect:/var/lib/haproxy/stats.sock stdio
   ex: echo "set weight ccm/ccm1 50" | socat unix- connect:/var/lib/haproxy/stats.sock stdio

5. 根据服务器活动来确定节点的正确权重。 可以从所有节点收集系统数据，然后根据所收集的数据来计算权重。 根据系统数据计算正确的权重之后，可以创建脚本，并将该权重用于所有节点。 在以下示例中，qm 是后端的名称，qm1 是服务器节点的名称，新权重设置为 50：

   echo "set weight qm/<serverName> <newWeight>" | socat unix-connect:/var/lib/haproxy/stats.sock stdio
   ex: echo "set weight qm/qm1 50" | socat unix- connect:/var/lib/haproxy/stats.sock stdio

设置

注：不支持在 Windows 平台上安装

为物联网 (IoT) 和移动环境提供快速安全的双向消息传递。 是高性能 MQTT 代理。

I. 安装非 Dockerized 版本的

过程

要安装非 Dockerized 版本的 ，请完成下列步骤：

1. 从 ibm.com下载最新 5.0 所需的软件包。

   注：需要具有 IBM 标识才能访问这些文件。 如果您不具有 IBM 标识，那么系统将提示您创建 IBM 标识，然后才能下载 。

2. 请遵循 文档中的指示信息来安装非 Dockerized (RPM) 版本。

II.登录 Web UI

有关完整的指示信息，请参阅 文档。

三. 配置

使用称为集线器的组织配置对象来定义配置策略。

过程

1. 通过遵循前一任务中的过程登录到 Web UI 之后，创建新的集线器，然后创建并分配连接策略、消息传递策略和端点。
2. 创建新的连接策略。 请提供名称和描述。 输入客户机标识，然后选择 MQTT 作为协议。 在指定允许 MQTT 客户机使用的资源下，选中允许使用具有持久预订的客户机和允许使用持久消息复选框。
3. 转至消息传递策略选项卡，并创建新的主题策略。 提供新的主题策略的名称和描述。 输入客户机标识，然后选择 MQTT 作为协议。 在主题字段中输入一个星号 (*)，并在权限下，选中发布和预订复选框。 在订户设置下，确保输入 10000 作为最大消息数值，并选择废弃旧消息作为最大消息数行为值。
4. 最后，创建新端点。 请提供名称和描述。 在端口字段中，指定客户机（ 或 节点）用来进行连接以发布和预订消息的端口。 稍后，将此端口添加至 server.startup 文件。 选择 MQTT 作为协议。 将最大消息大小设置为 4096。 在连接策略和消息传递策略下，添加您在先前步骤中创建的连接策略和消息传递策略（主题策略）。

四. 监视预订

可以使用 Web UI 来查看预订监视统计信息。 要访问监视预订，请转至 "预订" 页面，方法是选择 监视 > 预订。

在“监视”视图中，您可以看到所有 MQTT 客户机（节点）、所预订和发布的主题、活动使用者、消息数以及缓冲区大小。 可以使用各种选项对数据进行过滤。

V. 可选： 高可用性

要实现 高可用性（主节点和备用节点），请参阅 文档中的下列主题：

• High Availability overview
• Configuring your system for high availability
• Configuring MessageSight by using the Web UI
• Configuring MessageSight by using REST Administration APIs

集群应用程序的 ()

对于可以支持集群的 () 应用程序（例如 或 ），分布式数据由一个称为 的独立 Web 应用程序管理。

() 是一个小型 Java 应用程序，包含主要 JAR 文件 distributedCache.jar、针对配置属性的 distributedCache.cfg 文件和 jarlib 目录中的必需依赖关系。 微服务为集群 () 应用程序的分布式数据提供集中管理和存储位置。 集群操作需要 ；如果 无法访问，那么所有集群应用程序将处于“等待”状态，直到 恢复联机。 本身并不是 应用程序，它可能与 应用程序具有不同的配置需求。

安装注意事项

必须已安装，且在集群应用程序的所有节点都可以访问的机器上运行。 缺省情况下，微服务安装在 () 机器上的 server/clustering/cache 目录下，且在执行 启动顺序时启动，或者在集群应用程序要求它时按需启动。 如果尚未设置 URL 高级属性设置，那么集群应用程序将调用 ，以发现微服务的状态。 然后， 尝试查找正在运行的 进程，并启动未在运行的 。 在生产环境中， 通常是位于代理（例如 ）后端的后端服务器，或者为提高性能而将它安装在专用服务器上。 在这些情况下，必须手动启动 ，并且必须设置集群应用程序 URL 服务属性。

注：为了获得最佳性能，应将 移至一个独立于 的专用服务器。

要移动 或者重新配置 URL，请完成下列步骤：

1. 确定要访问 的 URL。 请注意有关 URL 的下列重要因素：
   • URL 可以 http 或者 https 开头，这取决于在 distributedCache.cfg 文件中是否启用了 SSL。
   • 如果服务器的前端是代理，请使用代理 URL。
   • 如果端口被屏蔽，那么应从 URL 中省略该端口。 否则，10001 是缺省端口，也可以在 distributedCache.cfg 文件中配置缺省端口。
   • 不需要 URL 末尾的上下文路径。

URL 示例：

https://myproxy.company.com/
https://myserver.company.com:10001/

注：如果您在启用集群之前执行下列步骤，那么在您复制应用程序节点时会将变更传播到其他节点。

2. 登录到 或 应用程序管理 UI ，然后转至 应用程序 > 高级属性。
3. 搜索 URL，在“当前值”字段中输入 服务器的 URL。
4. 滚动到页面顶部并单击保存。
5. 转至安装了 应用程序的服务器，并将 server/clustering/cache 目录及其所有子目录复制到新 主机上的某个位置。 请注意， 主机必须安装了 JVM 1.8 或更高版本。
6. 打开 server/clustering/cache/distributedCache.cfg 文件进行编辑。
7. 在 [AuthServer] 部分，在 as_trusted_url 中添加 URL，以便可以将它向 正确注册。 例如：

as_trusted_url = $S{AuthServer.as_trusted_url, https://myserver.company.com:10001}

注意：在 server/clustering/cache/distributedCache.cfg文件中，请勿将带有斜线尾部的 URL 用于 as_trusted_url 属性的值。

配置属性核对表

根据安装拓扑，可以在 distributedCache.cfg 文件中设置下列配置属性。

• 应该将微服务安装在具有读/写访问权的位置。 如果您将微服务安装在只读位置，那么必须变更 logDir 属性以指向一个可写位置。
• 请检查 [REST] 部分，必要时更新属性。
• 如果认证设置为 OIDC（对于 ），那么务必更新 [AuthServer] 属性。 您在 as_trusted_url 中使用的 URL 必须与前一节在“高级属性”中所指定的 URL 相匹配。 请勿向此属性追加上下文根 (/dcm)。
• 如果是通过 LDAP 服务器进行认证，那么务必更新 [UserRegistry] 属性。 请注意，配置文件中的 LDAP 设置与您在安装 期间使用的设置稍有不同，这是因为 是微服务，而不是完整 应用程序。 每个设置的格式在 distributedCache.cfg 文件中以注释形式提供。 例如， 中的 group_roles_mapping 属性设置为：

JazzProjectAdmins=LDAPJazzAdmins,JazzAdmins=LDAPJazzAdmins,JazzUsers=LDAPJazzUsers,JazzDWAdmins=LDAPJazzAdmins,JazzGuests=LDAPJazzUsers

但是，在 中，该属性设置为：

{"LDAPJazzAdmins":"JazzProjectAdmins,JazzAdmins,JazzDWAdmins","LDAPJazzUsers":"JazzUsers,JazzDWAdmins"}

简而言之，在 中，您对 LDAP 组映射指定 Jazz 角色，而在 中，您对 Jazz 角色映射指定 LDAP组。 请注意，如果未正确设置这些属性，那么在 日志控制台中将显示以下错误消息：

The user registry settings may be set incorrectly. Please refer to the cfg file UserRegistry section.

• 如果您打算监视微服务发布的性能计数器，那么在 [Counters] 下，将 Enabled 属性设置为 true，并在 broker 属性中提供 MQTT 代理 URL。 通过 MQTT 代理程序发布其计数器。 启用此项属性后，就可以在集群应用程序的管理 UI 内部计数器页面中看到计数器。 此外，在配置文件中启用了计数器时，http://_HOST_NAME:10001/dcm/counters URL 将随需应变地显示计数器数据（端口只有在未屏蔽时才适用）。 由 [Logging] 部分下的 snapshotFrequency 属性来控制发布频率。 还可以在本地记录 的使用情况统计信息。 为此，请将 logSnapshotStats 设置为 true。

以安全方式运行

缺省情况下，以 SSL 方式运行 。 这由 [REST] 部分中的 useSsl 属性来控制。 在 [REST-SslContextFactory] 部分指定了其他 SSL 相关配置。 请确保在 keyStorePath 中指定正确的文件名和路径。

配置样本

下面是一些样本配置，供您参考。 请注意，这些样本仅指出了一些重要参数，而未指出整个配置。

样本 1， 满足下列条件：

• 从 主机上的缺省位置运行，
• 前端没有任何代理，
• 向 LDAP 服务器进行 OSLC 认证。

#===========================================
# REST settings
#===========================================
[REST]

port = $E{CACHE_PORT, 10001}

stylesheet = styles/devops.css

saveConfigAction = RESTART_SERVER

useSsl = true

authType = OIDC

#===========================================
# AuthServer settings
#===========================================
[AuthServer]

auth_url = $S{AuthServer.auth_url, https://JAS_HOST:9643/oidc/endpoint/jazzop}

client_id = dcm

client_name =

as_admin_id = $S{AuthServer.as_admin_id, ADMIN}

as_admin_pass = $S{AuthServer.as_admin_pass, ADMIN}

as_trusted_url = $S{AuthServer.as_trusted_url, https://JTS_HOST:10001}

#============================================
# LDAP UserRegistry settings.
#============================================
[UserRegistry]

base_group_DN = dc=jazz,dc=domain

group_name_property = cn

group_roles_mapping = {"LDAPJazzAdmins":"JazzProjectAdmins,JazzAdmins,JazzDWAdmins","LDAPJazzUsers":"JazzUsers,JazzDWAdmins"}

样本 2， 满足下列条件：

• 配置为从另一台机器运行，而不是从 主机中的缺省位置运行，
• 前端有代理服务器，并且对代理中的 屏蔽了端口，
• 由非 LDAP 服务器认证。

#============================================
# REST settings
#============================================
[REST]

port = $E{CACHE_PORT, 10001}

stylesheet = styles/devops.css

saveConfigAction = RESTART_SERVER

useSsl = true

authType = OIDC

#============================================
# AuthServer settings
#============================================
[AuthServer]

auth_url = $S{AuthServer.auth_url, https://JAS_HOST:9643/oidc/endpoint/jazzop}

client_id = dcm

client_name =

as_admin_id = $S{AuthServer.as_admin_id, ADMIN}

as_admin_pass = $S{AuthServer.as_admin_pass, ADMIN}

as_trusted_url = $S{AuthServer.as_trusted_url, https://IHS_HOST}

IHS 环境

如果 的前端有代理服务器，那么必须将它配置为将 请求转发至正在运行 的相应主机和端口。 缺省情况下， 集群期望在端口 10001 上安全配置的 与 在同一主机上运行。

要修改 IHS 配置，请对下列文件进行变更：

a) httpd.conf - 添加以下条目来侦听缺省 端口 (10001)。 可以在 distributedCache.cfg 中变更缺省 端口。 请注意，仅当您打算将端口作为 URL 的一部分时，才需要进行以下变更。 如果您打算从 URL 屏蔽 端口，那么不需要在 httpd.conf 文件中进行任何变更。

监听 10001
<VirtualHost *:10001>
SSLEnable
SSLServerCert <IHS服务器证书别名>
</VirtualHost>

b) plugin-cfg.xml - 添加以下条目以将端口 10001 上的请求转发至相应的 服务器。 请注意， 只需要转发 /jsa 和 /dcm 上下文根。

<ServerCluster CloneSeparatorChange="false" GetDWLMTable="false" IgnoreAffinityRequests="true" LoadBalance="Round Robin" Name="microservice_Cluster" PostBufferSize="64" PostSizeLimit="-1" RemoveSpecialHeaders="true" RetryInterval="60">
<服务器 ConnectTimeout="0" ExtendedHandshake="false" MaxConnections="-1" 名称="微服务" ServerIOTimeout="9000" WaitForContinue="false">
<Transport Hostname="<JTS_HOSTNAME>"端口="10001" 协议="https">
<Property Name="keyring" Value="<File Path of keystore file (kdb)>"/>
<Property Name="stashfile" Value="<File Path of stash file file (sth)>"/>
</Transport>
</Server>
</ServerCluster>

<UriGroup Name="microservice_Cluster_URIs">
<UriAffinityCookie="JSESSIONID" AffinityURLIdentifier="jsessionid" Name="/jsa/*"/>
<Uri；Uri AffinityCookie="JSESSIONID" AffinityURLIdentifier="jsessionid" Name="/dcm/*"/>
</UriGroup>

<路由 ServerCluster="microservice_Cluster" UriGroup="microservice_Cluster_URIs" VirtualHostGroup="default_host"/>

c) 更新密钥库数据库文件，以根据 plugin-cfg.xml 文件的密钥库更新对 证书添加一个条目。

运行

启动和停止微服务所需要的所有文件和脚本都在 server/clustering/cache 目录中。 要运行微服务，您必须安装了 JVM V1.8 或更高版本。 可以使用所包括的脚本来启动微服务，也可以使用以下命令来启动微服务：

java –Xms2G –Xmx3G -jar distributedCache.jar

可以通过该命令根据需要来变更 JVM Xms 和 Xmx 参数的值。

注：

• _Install_Dir 是 的安装目录：server/clustering/cache 和 JRE_Install_Dir 是 JVM 1.8 或更高版本的安装目录。
• 启动脚本会将当前文件夹变更为 的文件夹。 这允许 查找 SSL 密钥库文件以及其他必需的依赖项。 如果是通过其他某些方法来启动 ，那么并非所有配置都可以正常运行。
• 当 启动时，它将在 主目录 (server/clustering/cache) 下创建一个名为 service.lck 的文件。 同样，当 正常关闭时，停止脚本将删除此 service.lck 文件。 如果您正在使用其他方法来关闭 ，service.lck 文件可能仍然存在于该目录中。 在重新启动 之前，务必删除 service.lck 文件，否则 可能无法正常启动。

启动微服务：

要确定微服务，请打开命令窗口Shell，并输入下列命令：

cd Path_To__Folder
start distributedCache。start.bat JRE_Bin_Path

cd PATH_To__Folder
./distributedCache.start.sh JRE_Bin_Path > /dev/null &

其中：

Path_To__Folder 是 的安装位置，JRE_Bin_Path 是 JRE/Bin 文件夹所在的位置。 JRE_Bin_Path 为可选。 如果未指定此路径，那么系统会认为 正在从其缺省位置运行，并使用 应用程序所提供的 JRE。

停止微服务：

要停止微服务，请打开命令窗口Shell，并输入下列命令：

cd Path_To__Folder
distributedCache。stop.bat JRE_Bin_Path

cd Path_To__Folder
./distributedCache.stop.sh JRE_Bin_Path

其中：

• Path_To__Folder 是 的安装位置，JRE_Bin_Path 是 JRE/Bin 文件夹所在的位置。 JRE_Bin_Path 为可选。 如果未指定此路径，那么系统会认为 正在从其缺省位置运行，并使用 应用程序所提供的 JRE。

从 注销

() 用于认证 。 要注册微服务，在 distributedCache.cfg 文件中的 AuthServer 和 UserRegistry 部分配置了若干参数，如前一节中所述。 将在首次启动后自动向 注册。 在 向 注册之后，在 distributedCache.cfg 文件中会更新下列属性：client_secret 和 registration_completed = true。 缺省情况下， 将在 上注册，并且 client_id 为 dcm。 如果您需要更新 的 注册，那么可以删除现有 注册，然后再次向 注册 ：

1. 停止 。
2. 编辑 distributedCache.cfg 文件。
1. 将 client_secret 重置为缺省值。

   client_secret = $S{AuthServer.client_secret}

2. 移除或者注释掉 registration_completed = true 属性。
3. 复查配置文件中的 [AuthServer] 和 [UserRegistry] 部分所提到的其他属性，需要时相应地更新它们。
3. 使用 JAS 所提供的 rmclient 实用程序从 注销 ：

cd JAS_Install_Dir\cli
rmclient.bat -a AUTH_SERVER_URL -u ADMIN:ADMIN dcm

cd JAS_Install_Dir/cli
./rmclient -a AUTH_SERVER_URL -u ADMIN:ADMIN dcm

其中 AUTH_SERVER_URL 是配置文件中所指定的 auth_url。 ADMIN:ADMIN 参数是由用户标识和密码组成的管理用户凭证，用户标识与密码之间用冒号分隔。 dcm 是用于微服务注册的 Authorization Server 客户机标识。

4. 当您启动 时，它将使用已更新的属性向 重新注册它本身。

对集群进行故障诊断

使所有应用程序与 同步

在完成 定制设置之后，您可能会看到一个或多个应用程序的以下诊断故障消息：

应用程序：https://JTS_HOST:9443/ccm/rootservices 中"/ccm "的发现资源的 OAuth 域与条目不同。

来自发现资源的 OAuth 域：[https://JTS_HOST:9443/ccm] 应用程序 OAuth 域：[]

此错误的原因可能是存储库工具 (repotools) 命令中的应用程序未完全同步。 要解决此问题，请完成下列步骤以手动使这些应用程序同步：

1. 首先，获取需要与 同步的应用程序标识。 打开命令 shell窗口，并输入以下命令：

   cd Jazz_Install_Dir/\server
   ./repotools-jtsrepotools-jts -listFriends repositoryURL=https://JTS_HOST:9443/jts adminUserId=adminUserId adminPassword=管理员密码

2. 从前一步骤获得应用程序标识，然后输入以下命令：

   ./repotools-jtsrepotools-jts -synchFriend repositoryURL=https://JTS_HOST:9443/jts adminUserId=adminUserId adminPassword=adminPassword friendId=FriendID_From_PreviousStep

3. 在成功完成 repotools 命令之后，返回到 诊断页面，并运行诊断以确保不再发生错误。

通过代理接受请求的所有 "内容"

如果您已在集群环境的前端安装了 或其他类似的代理服务器，那么必须确保已启用此功能，以接受所有 HTTP 请求（例如 GET、PUT 和 POST 等）中的内容（有效内容）。 如果未启用此功能，那么您可能会在代理服务器中接收到 HTTP 400 错误请求 错误，因为某些 HTTP GET 请求是随有效内容一起发送并被代理拒绝的。

为避免此类错误，请在代理服务器的 plugin-cfg.xml 文件中设置 AcceptAllContent="true" 。

在日志文件中废弃 HAProxy 消息

或 集群成员与 之间的请求数可能快速增多并填满磁盘空间。 可以修改 rsyslog 配置文件，以便在记录消息时废弃某些 HAProxy 消息。 为此，在要废弃的行的末尾添加波浪号 (~)。 示例：

:msg, regex, "/map/" ~
local2.* /var/log/haproxy.log
& stop