历史版本8 :接入已有项目 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

运维平台版本
功能变更
V1.0-
V1.2

1)运维平台支持接入多个应用

2)运维平台支持接入非容器化部署的应用

3)运维平台支持接入设置了单点集成的应用

4)运维平台支持接入设置了反向代理的应用

V1.3

1)新增支持查看agent版本状态

2)「应用管理」功能更名为「项目管理」

V1.3.1新增「超时检测」
V1.4新增「镜像仓库」

1.2 功能简介

运维平台作为一个运维工具,是对帆软的FineReport、FineBI等应用进行运维的。

因此在使用运维平台之前,需要将需要被管理的应用绑定到运维平台上。

2. 使用前提编辑

2.1 准备运维接口密钥

项目管理的前提是,运维平台获得应用的认可。因此首先要从应用中获取一个运维接口密钥。

管理员登录FineReport、FineBI等应用,点击「管理系统>智能运维>系统检查」。设置一个运维接口密钥,点击「保存」即可。

运维接口密钥请设置为大小写字母或数字,长度在8~14之间。

2.2 开启Nginx配置

Nginx状态监控模块ngx_http_stub_status_module是统计Nginx服务所接收和处理的请求数量的模块。

若需要被管理的应用,并非容器化部署的应用,则需要额外安装该模块。容器化部署的项目无需执行本操作。

2.2.1 安装模块

检查状态监控模块ngx_http_stub_status_module是否已安装。

nginx -V 2>&1 | grep -o with-http_stub_status_module

出现提示「with-http_stub_status_module」则表示已安装ngx_http_stub_status_module模块。

若未出现以上提示,则说明未安装ngx_http_stub_status_module模块,可执行以下命令安装此模块。

wget http://nginx.org/download/nginx-1.13.12.tar.gz
tar xfz nginx-1.13.12.tar.gz
cd nginx-1.13.12/
./configure --with-http_stub_status_module
make
make install

2.2.2 启用模块

启用ngx_http_stub_status_module模块查询Nginx状态。

location /basic_status {
  stub_status on;
  allow 127.0.0.1;  #only allow requests from localhost
  deny all;   #deny all other hosts 
 }

注意事项:

1)Location地址请严格命名为basic_status。

2)allow 127.0.0.1和deny all表示仅允许本地访问。

若需允许Nginx Exporter访问,则可将这两行代码注释,或者将127.0.0.1设置为Nginx Exporter的IP地址。

2.2.3 重启Nginx

重启Nginx

nginx -t
nginx -s reload

验证ngx_http_stub_status_module模块是否已成功启动

curl http://127.0.0.1/basic_status

出现提示「server accepts handled requests」则表示ngx_http_stub_status_module模块已成功启动。

2.3 确保网络连通

请确保运维平台和需要被管理的应用,可以互相访问,若网络不互通,则无法对接。

3. 新增项目编辑

3.1 项目信息设置

管理员登录运维平台,点击「项目管理」,点击「新增项目」按钮,设置相关应用信息,点击「测试连接并保存」,如下图所示:

需要设置的应用信息如下表所示:

信息
说明
项目名称

自定义项目的名称

项目名称不允许为空

项目名称仅支持小写字母、数字

项目名称长度最大为12位

项目服务器地址

FineReport、FineBI等项目的地址

项目服务器地址形如http://IP:port/webroot/decision

项目服务器地址不允许为空

运维接口密钥

2.1节设置的运维接口密钥

运维接口密钥不允许为空

点击「测试连接并保存」,连接成功后提示「连接成功」,点击确定,进入下一步。

3.2 组件信息设置

进入组件信息设置后,自动获取相关组件信息,如下图所示:

获取的组件信息如下表所示:

组件
信息说明

外接数据库组件

禁止修改

MySql组件名称

默认名称为:项目名称_mysql

exporter地址

IP地址

exporter端口端口号

Redis组件

禁止修改

组件名称

默认名称为:项目名称_redis

exporter地址

IP地址

exporter端口端口号
Nginx组件组件名称

默认名称为:项目名称_nginx

禁止修改

exporter地址

IP地址

容器化部署项目不支持修改

非容器化部署项目支持修改

exporter端口

端口号

容器化部署项目不支持修改

非容器化部署项目支持修改

SSL非容器化部署项目支持自行勾选

点击「测试连接并保存」,连接成功后提示「已保存,连接成功」,点击确定,进入下一步。

3.3 服务器信息设置

服务器信息配置用于安装日志采集和服务器信息采集组件。

1)容器化部署项目,自动获取服务器信息,包括服务器的exporter地址和端口、promtail地址和端口。不支持修改。

2)非容器化部署项目,用户可自行配置服务器信息。

  • 如不希望安装可以选择跳过,此时将无法监控服务器状态并进行应用日志采集。

  • 如希望安装,可配置服务器的ssh信息,默认使用root用户,支持指定安装目录,指定后先验证连接信息是否正确,再验证安装目录是否有读写权限,无权限则报错。

配置完成后,点击「测试连接并保存」,连接成功后提示「保存成功」,点击确定,项目新增完毕。

4. 项目管理编辑

项目管理界面,显示所有已绑定的项目,显示项目的相关信息,包括:项目名称、项目类型、存活节点数、部署方式、状态、agent版本状态、项目访问地址

支持管理员增加新项目、删除和编辑已有项目。如下图所示:

信息
说明
项目名称新增项目时,设置的项目名称
项目类型单机/集群
存活节点数项目下存活的节点数量
部署方式finekey部署/非finekey部署
状态可用/不可用
agent版本状态

无需更新:应用agent版本与server版本一致

待更新:当前应用及组件agent版本低于运维平台,点击进行更新

请更新运维平台:当前应用及组件agent版本高于运维平台,请升级运维平台以保证功能正常使用

未检测到agent:无法检测当前应用及组件agent版本

项目访问地址绑定的FineReport、FineBI工程地址
操作

编辑/删除/宕机处理策略/健康诊断

5. 宕机处理策略编辑

对于运维平台管理的项目,支持设置宕机处理策略。如下图所示:

详情请参见:宕机处理策略

6. 健康诊断编辑

在项目管理界面,可点击「健康诊断」按钮,快速直达「健康诊断」界面,如下图所示:

详情请参见:健康诊断

7. 超时检测编辑

项目管理页面支持配置「超时检测」,时间配置范围为1-60,默认为15秒。

超时检测对项目管理、运维工具、日志管理等功能生效。

超时无响应则认为连接异常,超时三次则认为应用状态异常,不再连接,请刷新后再试。

8. 镜像仓库编辑

对于自有K8S平台的用户,管理员可在「镜像仓库」中配置仓库地址、用户名及密码,以方便后续进行exporter、应用及组件的镜像使用。