集群组件的安装卸载 #

计算节点和存储节点的安装卸载在集群的安装卸载部分做介绍 获取软件： 组件 治理中心（ZooKeeper） 、监控中心（Prometheus）、 日志中心（Elasticsearch Logstash Filebeat）console 内置，无需额外获取。

• 集群组件安装方式描述

自建资源或组件：指通过 console 或者 boot 新建的组件资源

注册资源或组件：指通过 console 注册的组件资源

如下列表中描述的是，生态工具可以完成的组件安装注册卸载的功能。其中安装是通过新建功能完成的，注册是注册功能完成的，注销和卸载是通过删除功能完成的。

• 组件与集群关系说明

如下是集群对组件的独享和共享说明： 独享：集群的独享组件，即集群与组件是一对一的关系，一个组件只能被一个集群使用 共享：集群间的共享组件，即集群与组件是一对多的关系，一个组件可以被多个集群使用 创建集群本质是创建 Engine-Proxy（计算节点）的集群。创建一个可用的集群，计算节点、治理节点、存储节点为必选的，监控中心日志中心为非必选的。

主机的注册与注销 #

主机资源高于计算节点、存储节点、治理中心、日志中心、监控中心；需要在完成资源配置后，再完成组件的配置。主机的注册分为：单台注册、批量注册。

SphereEx-Console 注册单台主机 #

适用场景

单台注册主机，适用于注册少量主机，一台一台操作。

前提条件

主机已经安装操作系统，ssh服务已经开启，可以独立访问

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入监控中心列表
3. 点击右上角 注册 按钮，默认进入 单台注册 的页面
4. 填写信息，具体参数见下表。

SphereEx-Console 注册多台主机 #

适用场景

批量注册主机，适用于批量注册多台主机的场景

前提条件

主机已经安装操作系统，ssh服务已经开启，可以独立访问，目前批量注册主机仅支持用户名口令的方式。

操作步骤

1. 登录 SphereEx-Console
2. 点击 资源->主机 进入监控中心列表
3. 点击右上角 注册 按钮，点击批量注册批量注册主机的页面
4. 点击 点击上传 上传文件，文件格式xlsx；文件最大支持 5M，文件内容最多包含100台主机
5. 点击 点击此处下载模版 可以下载模版
6. 点击右下角 下一步 进入校验页面
7. 模版中的参数见下表。

8. 校验结果为通过的点击 下一步 完成主机的批量注册

SphereEx-Console 注销主机资源 #

适用场景

不需要在 SphereEx-Console 中使用此主机资源

前提条件

主机未被使用，未配置监控，删除主机仅解除对主机的管理，不会删除物理主机

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入监控中心列表。
3. 点击列表操作列中的 删除 按钮。
4. 点击提示框中的 确认 完成主机的注销。

监控中心的安装卸载 #

SphereEx-Boot 安装监控中心 #

前提条件

SphereEx-Boot 主机和部署 Prometheus 的主机需要实现 SSH 互信认证。

说明： 安装 Prometheus 有如下两种方式。

• 指定参数安装

适用场景

当需要对单台主机快速进行 Prometheus 安装时可以直接输入命令进行安装。 操作步骤

1. 在 Prometheus 官网下载好安装包 prometheus-xxx.xxx.tar.gz。

说明：也可以使用 Boot 工具包中的 Prometheus 安装包。

2. 直接输入命令进行安装。

$ spex component install --user "root" --password "123456" --install-dir /root/prometheus --package ./prometheus-2.33.3.linux-amd64.tar.gz --host 127.0.0.1

• 指定配置文件安装

适用场景

当需要在多台主机部署 Prometheus 时，可以使用配置文件进行安装。

操作步骤

a. 在 Prometheus 官网下载好安装包 prometheus-xxx.xxx.tar.gz。

b. 导出配置模板 prometheus-config.yaml。

$ spex component install -t
$ ls 
prometheus-config.yaml

1. prometheus-config.yaml 配置文件样例如下，用户根据实际情况进行配置。

install_user: root # 用户名
install_password: root # 用户密码
prometheus:
  file: /root/prometheus-x.x.x.tar.gz # prometheus 安装包路径
  servers:
    - host: 10.0.1.1 # 部署主机 IP
      install_dir: /root/prometheus/ # 单独设置安装目录

2. 配置好 prometheus-config.yaml 配置文件，使用如下命令进行安装。

$ spex component install -f ./prometheus-config.yaml

SphereEx-Console 安装监控中心 #

适用场景

需要使用 SphereEx-Console 中的监控功能。

注意事项

安装监控中心的前提条件：主机已经注册，注册使用的主机用户的账号有目录的读写权限。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入监控中心列表。
3. 点击右上角 新建 按钮。
4. 填写信息，具体参数见下表。

5. 点击 确定，完成监控中心的安装。

SphereEx-Console 卸载监控中心 #

适用场景

不需要 SphereEx-Console 中的监控功能。

注意事项

• 删除监控中心需要保证监控中心未被使用，且被停止。
• 点击 删除 会提示是否卸载软件，删除时选择卸载软件的监控中心将无法被 console 再次管理。

操作步骤

1. 登录SphereEx-Console。
2. 在控制台左上角选择 资源 > 监控中心。
3. 单击列表中操作列中的 删除 按钮。
4. 点击提示框中的 确认，完成监控中心的卸载

治理中心的注册、注销、安装、卸载 #

SphereEx-Console 注册治理中心 #

适用场景

将用户环境中已有的 ZooKeeper 注册到 SphereEx-Console。

注意事项

用户环境中已经 ZooKeeper 已经安装，可以正常提供服务。

操作步骤

1. 登录 SphereEx-Console。
2. 在控制台左上角选择 资源 > 治理中心。
3. 单击右上角 注册 按钮。
4. 填写信息，具体参数见下表。

5. 点击 注册主机 完成主机注册，信息填写参考主机的注册部分。
6. 点击提示框中的 确认，完成治理中心的注册。

SphereEx-Console 注销治理中心 #

适用场景

从 SphereEx-Console 中删除注册的 ZooKeeper。

注意事项

ZooKeeper 不会被停止或卸载，直接可以删除，监控配置将被删除，监控插件将被卸载。

操作步骤

1. 登录 SphereEx-Console。
2. 在控制台左上角选择 资源 > 治理中心。
3. 单击列表中操作列的 删除 按钮。
4. 点击提示框中的 确认，完成治理中心的注销。

• SphereEx-Console 安装治理中心

适用场景

通过 SphereEx-Console 安装 ZooKeeper。

注意事项

主机已经被注册，注册使用的主机用户的账号有目录的读写权限。

操作步骤

1. 登录SphereEx-Console。
2. 在控制台左上角选择 资源 > 治理中心。
3. 单击右上角 新建 按钮。
4. 填写信息，具体参数见下表。

治理中心基本信息：

节点信息：

5. 点击提示框中的确认，完成治理中心的安装。

SphereEx-Console 卸载治理中心 #

适用场景

从 SphereEx-Console 中删除通过 SphereEx-Console 安装的 ZooKeeper。

注意事项

ZooKeeper 需要先被停止，根据勾选判断是否卸载 ZooKeeper 软件，监控配置将被删除，监控插件将被卸载。

操作步骤

1. 登录 SphereEx-Console。
2. 在控制台左上角选择 资源 > 治理中心。
3. 单击列表中操作列的 删除 按钮。
4. 点击提示框中的 确认，完成治理中心的卸载。

日志中心的安装与卸载 #

SphereEx-Console 安装日志中心 #

适用场景

需要使用 SphereEx-Console 中的日志管理功能。

注意事项

主机已经注册，注册使用的主机用户的账号有目录的读写权限。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->日志中心 进入监控中心列表。
3. 点击右上角 新建 按钮。
4. 填写信息，具体参数见下表。 基本信息：

Elasticsearch（必填）信息：

Logstash（必填）信息：

5. 点击 确定，完成日志中心的安装。

SphereEx-Console 卸载日志中心 #

适用场景

不需要使用 SphereEx-Console 中的此日志中心了。

注意事项

• 删除日志中心需要保证日志中心未被使用，且被停止。
• 点击删除会提示是否卸载软件，删除时选择卸载软件的日志中心将无法被 console 再次管理。

操作步骤

1. 登录 SphereEx-Console。
2. 在控制台左上角选择 资源 > 日志中心。
3. 单击列表中操作列中的 删除 按钮。
4. 点击提示框中的 确认，完成日志中心的卸载。

数据库资源的注册与注销 #

SphereEx-Console 注册数据库资源 #

适用场景

将用户环境中已有的数据库注册到 SphereEx-Console 中管理。

前提条件

数据库已经安装，可以正常提供服务；允许 SphereEx-Console 访问的数据库账号已经被创建。数据库的权限，需要根据业务用户自行规划。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入数据库列表。
3. 点击右上角 注册 按钮。
4. 填写信息，具体参数见下表。

5. 点击 注册主机 完成主机注册，信息填写参考主机的注册部分。
6. 点击提示框中的 确认，完成数据库的注册。

SphereEx-Console 注销数据库资源 #

适用场景

不需要在 SphereEx-Console 中使用此数据库资源。

前提条件

从 SphereEx-Console 中删除主机仅解除对数据库资源的管理，不会删除物理数据库。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入监控中心列表。
3. 点击列表操作列中的 删除 按钮。
4. 点击提示框中的 确认 完成数据库的注销。

集群组件的管理 #

计算节点和存储节点的管理在该部分做介绍。

主机资源管理 #

主机为集群的基础资源，只能使用 Console 管理。

功能列表如下：

探活 #

适用场景

探活主机

前提条件

主机已经被注册。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入主机列表。
3. 点击列表操作列中的 探活 按钮 完成主机探活。

指定主机刷新 #

适用场景

指定主机刷新

前提条件

主机已经被注册

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入主机列表。
3. 点击列表操作列中的 刷新 按钮 完成刷新。

所有主机刷新 #

适用场景

列表中所有主机刷新

前提条件

主机已经被注册

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入主机列表。
3. 点击右上角 刷新 按钮 完成刷新。

修改 #

适用场景

指定主机信息的修改

前提条件

主机已经被注册，未被使用时所有信息可以修改，已经被使用后主机IP不可以被修改。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->主机 进入主机列表。
3. 点击列表操作列中的 修改 按钮 进入主机修改页面。
4. 填写如下信息完成主机信息的修改：

5. 点击提示框中的 确认 完成主机的修改。

配置监控 #

请参考主机监控告警

监控中心管理 #

查看监控插件 #

适用场景

查看内置的监控插件信息。

前提条件

无

操作步骤

1. 登录 SphereEx-Console
2. 点击 资源->监控中心 进入列表
3. 点击右上角 监控插件 按钮进入监控插件列表页面
4. 点击右上角 返回 按钮返回监控中心列表页面

探活 #

适用场景

探活监控中心

前提条件

监控中心已经被安装

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入列表。
3. 点击列表操作列中的 探活 按钮 完成探活。

指定监控中心刷新 #

适用场景

指定监控中心刷新。

前提条件

监控中心已经被安装。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入监控中心列表。
3. 点击列表操作列中的 刷新 按钮 完成刷新。

修改 #

适用场景

指定监控中心信息的修改，可以修改监控中心名称和描述。

前提条件

监控中心已经被安装。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入列表。
3. 点击列表操作列中的 修改 按钮 进入修改页面。
4. 填写如下信息：

5. 点击 确认 按钮完成完成监控中心信息的修改。

启动 #

适用场景

启动指定监控中心

前提条件

监控中心已经被安装，监控中心不可重复启动，启动已经启动的监控中心会提示已启动。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入监控中心列表。
3. 点击列表操作列中的 启动 按钮 完成启动。

停止 #

适用场景

停止指定监控中心

前提条件

监控中心已经被安装，监控中心不可重复停止，启动已经停止的监控中心会提示已停止，监控中心停止后，监控功能将无法使用。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->监控中心 进入监控中心列表。
3. 点击列表操作列中的 停止 按钮，完成停止。

治理中心管理 #

探活 #

适用场景

探活治理中心

前提条件

治理中心已经被安装或注册

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入列表。
3. 点击列表操作列中的 探活 按钮 完成探活。

指定治理中心刷新 #

适用场景

指定治理中心刷新

前提条件

治理中心已经被注册或安装

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入主机列表。
3. 点击列表操作列中的 刷新 按钮，完成刷新。

所有治理中心刷新 #

适用场景

列表中所有治理中心刷新

前提条件

治理中心已经被注册或安装。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入主机列表。
3. 点击右上角 刷新 按钮，完成刷新。

修改 #

适用场景

指定治理中心信息的修改，可以修改监控中心名称和描述。

前提条件

治理中心已经被安装或注册

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入列表。
3. 点击列表操作列中的 修改 按钮，进入修改页面。
4. 填写如下信息：

5. 点击确认按钮完成完成治理中心信息的修改

查看操作日志 #

适用场景

查看在 SphereEx-Console 平台内操作治理中心的日志。

前提条件

无

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入列表。
3. 点击操作列 日志 按钮进入查看操作日志页面。 可以从事件和日志两个维度查看操作的日志。
4. 点击右上角 刷新 按钮刷新页面内容。
5. 点击右上角 返回 按钮返回列表页面。

管理节点 #

节点探活 #

适用场景

探活治理中心节点

前提条件

治理中心中心已经被安装或注册

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->治理中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮 进入节点列表页面。

d. 点击节点列表中操作列 探活 按钮完成节点探活。

e. 点击右上角 返回 按钮返回治理中心列表。

节点刷新 #

适用场景

刷新治理中心节点

前提条件

治理中心已经被安装或注册。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入列表。
3. 点击列表操作列中的 管理节点 按钮 进入节点列表页面。
4. 点击节点列表中操作列 刷新 按钮完成节点刷新。
5. 点击右上角 返回 按钮返回治理中心列表。

配置监控 #

请参考治理中心监控 注册的治理中心，无法配置监控

启动 #

适用场景

启动指定治理中心

前提条件

• 治理中心已经被安装，不可重复启动，启动已经启动的治理中心会提示已启动。
• 当治理中心为注册的组件时，无法通过 SphereEx-Console 启动。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入监控中心列表。
3. 点击列表操作列中的 启动 按钮，完成启动。

停止 #

适用场景

停止指定治理中心

前提条件

• 治理中心已经被安装，不可重复停止，停止已经停止的治理中心会提示已停止。
• 当治理中心为注册的组件时，无法通过 SphereEx-Console 停止。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->治理中心 进入监控中心列表。
3. 点击列表操作列中的 停止 按钮 完成停止。

日志中心管理 #

查看 Filebeat #

适用场景

查看内置的Filebeat插件信息

前提条件

无

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->日志中心 进入列表。
3. 点击右上角 Filebeat 按钮进入 Filebeat 插件列表页面。
4. 点击右上角 返回 按钮返回日志中心列表页面。

管理节点 #

添加节点 #

适用场景

为一个日志中心添加节点

前提条件

主机已经注册，注册使用的主机用户的账号有目录的读写权限。

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击操作列 管理节点 按钮进入节点列表页面。

d. 点击右上角 添加节点 按钮进入添加节点页面。

e. 填写信息，具体参数见下表。

Elasticsearch

Logstash

f. 点击 确定 日志中心添加节点的功能。

g. 点击右上角 返回 按钮返回日志中心列表页面。

节点探活 #

适用场景

探活日志中心节点

前提条件

日志中心已经被安装

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮 进入节点列表页面。

d. 点击节点列表中操作列 探活 按钮完成节点探活。

节点刷新 #

适用场景

刷新日志中心节点

前提条件

日志中心已经被安装

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮进入节点列表页面。

d. 点击节点列表中操作列 刷新 或页面右上角 刷新 按钮完成制定节点和全部节点的刷新。

查看节点日志 #

适用场景

查看在 SphereEx-Console 平台内操作日志中心节点的日志。

前提条件

无

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮进入节点列表页面。

d. 点击操作列 日志 按钮进入查看操作日志页面。

可以从事件和日志两个维度查看操作的日志。

e. 点击右上角 刷新 按钮刷新页面内容。

f. 点击右上角 返回 按钮返回节点列表页面。

启动节点 #

适用场景

启动日志中心节点

前提条件

已经启动的节点，启动为灰色不可点

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮进入节点列表页面。

d. 点击列表操作列中的 启动 按钮，完成启动。

停止节点 #

适用场景

停止日志中心节点

注意事项

• 停止节点可能导致日志中心不可用，请谨慎操作。已经停止的节点，停止为灰色不可点。
• 当停止最后一个节点后，日志中心将停止。

操作步骤

a. 登录 SphereEx-Console。

b. 点击 资源->日志中心 进入列表。

c. 点击列表操作列中的 管理节点 按钮进入节点列表页面。

d. 点击列表操作列中的 停止 按钮，完成停止。

卸载日志中心节点 #

适用场景

缩容日志中心

注意事项

• 只有停止的节点才可以删除；正在被使用的节点无法删除。
• 点击删除会提示是否卸载软件，删除时不勾选卸载软件的日志中心节点将无法被 console 再次管理理，当只剩下最后一个节点时，将无法卸载，只能通过操作日志中心完成卸载。

操作步骤

a. 登录 SphereEx-Console。

b. 在控制台左上角选择 资源 > 日志中心。

c. 单击列表中操作列中的 删除 按钮。

d. 点击提示框中的 确认，完成日志中心节点的卸载。

查看日志中心日志 #

适用场景

查看在 SphereEx-Console 平台内操作日志中心的日志。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->日志中心 进入列表。
3. 点击操作列 日志 按钮进入查看操作日志页面。 可以从事件和日志两个维度查看操作的日志。
4. 点击右上角 刷新 按钮刷新页面内容。
5. 点击右上角 返回 按钮返回列表页面。

启动 #

适用场景

启动日志中心

前提条件

如果节点已经启动，启动为灰色不可点。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->日志中心 进入列表。
3. 点击列表操作列中的 启动 按钮，完成启动。

停止 #

适用场景

停止日志中心

注意事项

停止日志中心，日志中心将不可用，请谨慎操作。已经停止的日志中心，停止为灰色不可点。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->日志中心 进入列表。
3. 点击列表操作列中的 管理节点 按钮进入节点列表页面。
4. 点击列表操作列中的 停止 按钮，完成停止。

数据库资源管理功能说明 #

Console 目前仅支持MySQL数据库的管理。

探活 #

适用场景

探活数据库实例

前提条件

数据库实例已经被注册。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入主机列表。
3. 点击列表操作列中的 探活 按钮，完成探活。

指定数据库实例刷新 #

适用场景

指定数据库实例刷新

前提条件

数据库实例已经被注册。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入主机列表。
3. 点击列表操作列中的 刷新 按钮，完成刷新。

所有数据库实例刷新 #

适用场景

列表中所有数据库实例刷新

前提条件

数据库实例已经被注册。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入主机列表。
3. 点击右上角 刷新 按钮，完成刷新。

修改 #

适用场景

指定数据库实例信息的修改

前提条件

数据库实例已经被注册，修改数据库用户名和口令，不影响正在使用的存储节点，修改后注册的存储节点将使用新用户名和口令。

操作步骤

1. 登录 SphereEx-Console。
2. 点击 资源->数据库 进入主机列表。
3. 点击列表操作列中的 修改 按钮进入主机修改页面。
4. 填写如下信息完成信息的修改：

5. 点击提示框中的 确认 完成修改。

配置监控 #

请参考数据库监控