1. 概述编辑
1.1 版本说明
运维平台版本 | 功能变动 |
---|---|
V1.5 | - |
1.2 应用场景
FineOps运维平台是帆软软件推出的,为企业提供帆软应用稳定运行和全方位运维管理的解决方案。
帮助用户解决,管理帆软应用(FineReport、FineBI)的过程遇到一些痛点和挑战,详情请参见:运维平台产品简介
1.3 功能简介
本文介绍,如何部署FineOps运维平台。
2. 部署须知编辑
2.1 部署方案简介
FineOps运维平台,由很多组件构成。不同组件对应了运维平台中的不同功能。请用户选择适合自己的部署方案。
部署方案 | 适用对象 | 说明 |
---|---|---|
完全独立部署 启用运维平台全部功能 | 用户有足够服务器资源、系统用量大或关注使用性能 用户对运维平台可用性要求更高 | 1)独立服务器部署运维平台,即在该服务器中不再部署其他工程/产品 2)需要确保服务器环境满足运维平台全部组件运行条件,即服务器配置要求最低4C16G 3)部署完成后,需要手动启用elasticSearch、skywalking_ui、skywalking_oap、sherlock、nacos组件 |
启用运维平台全部功能 | 用户有足够服务器资源、系统用量大或关注使用性能 | 1)需要确保服务器环境满足运维平台全部组件运行条件,即服务器配置要求最低4C16G 2)部署完成后,需要手动启用elasticSearch、skywalking_ui、skywalking_oap、sherlock、nacos组件 |
启用运维平台基础功能 | 用户服务器资源相对紧张、业务用量及性能要求不高 | 需要确保服务器环境满足运维平台部分组件运行条件,即部署但不运行elasticSearch、skywalking_ui、skywalking_oap、sherlock、nacos组件,运维平台服务器配置要求最低4C8G |
2.2 部署内容简介
FineOps运维平台,由很多组件构成。每个组件对应的功能和配置如下表所示:
下表列出的为组件正常运行的最低配置要求。推荐配置一般为最低配置的两倍,请根据服务器实际情况自行调整。
类型 | 组件 | 组件说明 | CPU限制 | 内存限制 | 内存配置xmx |
---|---|---|---|---|---|
运维平台相关 | ops | 作用:运维平台容器,对其他容器进行运维 影响:必须启用该组件 | 2Core | - | - |
ops-agent | 作用:每个运维平台配套一个ops_agent,与物理节点绑定,用于管理组件,容器化升级也是由该组件完成 影响:必须启用该组件 | 1Core | - | 1G | |
nginx | 作用:nginx服务的容器,提供负载转发服务,所有服务的入口、使用都从这个入口访问 影响:必须启用该组件 | 1Core | - | - | |
日志 | loki | 作用:用于进行日志分析 影响:如不启用该组件,无法正常使用「日志分析」功能 | 1Core | 1G | - |
promtail | 作用:收集项目的日志信息 影响:如不启用该组件,无法正常使用「日志分析」功能 | 1Core | 1G | - | |
sherlock | 作用:用于进行日志分析的解析服务 影响:默认安装但不启用该组件。如不启用该组件,无法对「日志分析」提供解析服务 | 1Core | 2G | - | |
监控告警 | grafana | 作用:用于展示监控仪表板 影响:如不启用该组件,「监控与告警」功能中的仪表板无法查看 | 1Core | 1G | - |
prometheus | 作用:收集exporter的数据,提供给监控仪表板 影响:如不启用该组件,「监控与告警」功能中的仪表板无数据,「监控与告警」功能中的告警规则无法使用 | 1Core | 1G | - | |
alertmanager | 作用:告警容器,用于告警规则,修改、触发等 影响:如不启用该组件,「监控与告警」功能中的告警功能无法使用 | 1Core | 1G | - | |
链路追踪 | elasticsearch | 作用:对运维项目中FineReport、FineBI、外接数据库、业务库和其他外置组件的请求进行采集 影响:默认安装但不启用该组件。如不启用该组件,「链路追踪」功能无法使用 | 1Core | - | 2G |
skywalking_ui | 作用:链路追踪展示界面端 影响:默认安装但不启用该组件。如不启用该组件,「链路追踪」功能无法使用 | 1Core | - | 1G | |
skywalking_oap | 作用:链路追踪的数据上报和分析整理服务端 影响:默认安装但不启用该组件。如不启用该组件,「链路追踪」功能无法使用 | 1Core | - | 2G | |
指标收集 | node_exporter | 作用:服务器物理节点的exporter,收集物理服务器的各种指标信息,运维平台所在节点安装一个node_exporter 影响:如不启用该组件,「监控与告警」功能中的仪表板无数据 | 0.1Core | 0.1G | - |
nginx_exporter | 作用:nginx服务的exporter,收集nginx的指标信息 影响:如不启用该组件,「监控与告警」功能中的仪表板无数据 | 0.1Core | 0.1G | 0.1G | |
elasticsearch_exporter | 作用:elasticSearch的exporter,收集elasticSearch的指标 影响:如不启用该组件,「监控与告警」功能中的仪表板无数据 | 0.1Core | 0.1G | - | |
其他 | nacos-server | 作用:一个动态服务发现、配置管理和服务管理平台,支持注入到其他服务中 影响:默认安装但不启用该组件。预留组件,停用该组件暂不产生功能影响 | 2Core | - | 2G |
registry | 作用:存放docker镜像的仓库 影响:若用户自有仓库,无需启用该组件;若用户无镜像仓库,可启用该组件,作为「镜像管理」的仓库 | 1Core | - | - |
3. 准备部署环境编辑
3.1 确认组件运行环境
FineKey容器化部署工具的运行,对服务器环境有一些要求,如下表所示:
1)启用运维平台全部功能
即部署且运行全部组件。
配置 | 要求 |
---|---|
系统版本 | CentOS 7.3 及以上 Ubuntu 18.04.4 及以上 |
系统内核 | 3.10及以上 |
硬件配置 | 剩余空闲磁盘容量:最低 100G 剩余空闲物理内存:最低 16G CPU架构:仅支持 X64 |
2)启用运维平台基础功能
即部署但不运行elasticSearch、skywalking_ui、skywalking_oap、sherlock、nacos组件,不使用链路追踪功能。
配置 | 要求 |
---|---|
系统版本 | CentOS 7.3 及以上 Ubuntu 18.04.4 及以上 |
系统内核 | 3.10及以上 |
硬件配置 | 剩余空闲磁盘容量:最低 100G 剩余空闲物理内存:最低 8G CPU架构:仅支持 X64 |
3.2 确认组件端口可用性
请确认FineOps运维平台组件的默认端口是否可用。
请确认默认的映射端口端口是否已被使用,如已被使用,请安排好其他空闲端口,并在4.5节步骤中修改yaml文件。
请确认准备使用的端口是否开放了防火墙、安全组等,确保可连接。
注1:端口portMapping为{映射端口:容器内端口} ,其中映射端口可改,容器内端口修改无效。
注2:检查端口是否被占用的命令:lsof -i:端口
组件 | 安装默认配置 |
---|---|
ops | 端口:{8081: 8080} |
ops-agent | 端口:{9070:9070} |
nginx | root用户:{80: 8080} 非root用户:{8090: 8080} |
loki | 端口:{3100:3100} |
promtail | 端口:{9080:9080} |
sherlock | 端口:{3110:3110} |
grafana | 端口:{3000:3000} |
prometheus | 端口:{9090:9090} |
alertmanager | 端口:{9093:9093} |
elasticsearch | 端口:{9200:9200} 用户:elastic(不支持修改) 密码:elasticadmin |
skywalking_ui | 端口:{8082:8080} |
skywalking_oap | 端口:{11800:11800} 端口:{12800:12800} |
node_exporter | 端口:{9100:9100} |
nginx_exporter | 端口:{9113: 9113} |
elasticsearch_exporter | 端口:{9114:9114} |
nacos | 端口:{8848:8848} |
registry | 端口:5000 |
3.3 确认docker状态
请先确认服务器上是否已安装了docker,若已安装,请确保docker正在运行。
1)确认是否安装docker:
执行命令:docker version
若安装了docker,则会返回版本。
2)若安装了docker:
执行命令:systemctl status docker
确认docker是running状态
3.4 确认用户权限
推荐使用root用户运行FineKey容器化部署工具。
如需使用非root用户运行FineKey容器化部署工具,至少需要拥有执行以下命令的权限:cp、groupadd、gpasswd、systemctl、kill、sysctl
4. 准备FineKey工具编辑
4.1 获取FineKey安装包
「运维平台」目前仍处于内测阶段。
如需试用运维平台,请填写表单申请:运维平台申请表
或微信扫描下方二维码,进入运维平台产品试用报名入口。
有两种类型的安装包,用户可根据服务器环境自行选择:
在线安装包:安装包体积小,服务器环境需支持访问外网,方便在部署过程中拉取云端组件镜像。
离线安装包:安装包体积大,服务器环境无需支持访问外网,组件镜像全部内置在安装包中。
4.2 上传FineKey安装包
获得工具包后,需要将它上传到 Linux,上传文件的方法请自行查阅相关资料。
本文示例是将工具包上传到了 CentOS 7.6.1810 的 /home 路径下,如下图所示:
4.3 解压FineKey安装包
1)先使用 cd 命令进入工具包所在文件夹下。
2)键入如下命令进行解压:
tar zxvf finekey-operation.tar.gz
解压后的文件如下表所示:
文件夹/文件 | 文件说明 | |
---|---|---|
finekey/bin | 运行finekey的可执行文件 | |
finekey/conf | finekey.yaml | 新部署运维平台配置文件 |
finekey.push.yaml | 拉取镜像配置文件 | |
finekey/resources | 资源文件,镜像包放在其中images文件夹中 |
4.4 配置finekey.yaml文件
yaml文件指的是工具解压目录下conf文件夹里的finekey.yaml,该文件是控制后面整个自动部署流程的。
如无个性化或特殊的部署需求,用户可不对yaml文件做任何配置,可以直接在当前宿主机本地部署。
如需更改运维平台相关配置、组件占用端口等,可以打开yaml文件自行配置,yaml文件的配置需要在启动FineKey之前完成。
1)文件内容说明
配置 | 配置项 | 说明 |
---|---|---|
基础配置 | limit | 1)如需启用运维平台全部功能,建议将minMemoryCapacity限制修改为16,即服务器剩余空闲物理内存最低16G 2)如只启用运维平台基础功能,不建议调整该限制 |
depoloymentType | 请勿修改,代表只部署2.2节列举的全部组件,不部署frbi相关组件 如需部署FineReport、FineBI,请在运维平台部署完成后,使用界面化部署FineReport、FineBI等工程组件,详情请参见:部署新项目 | |
nodes | 值为部署的FineOps运维平台相关配置 包括:ip,port,user,password 如果ssh方式为密钥,则将password配置注释,新增keypath: 密钥绝对路径/密钥文件 | |
dataRootPath | 根挂载目录 请确保挂载目录所在分区,磁盘空闲空间≥100G 默认安装目录为~/data,即安装用户所在data目录 | |
repo | 1)全新安装一个registry镜像仓库,可指定仓库端口,默认5000 2)如已有镜像仓库,可输入指定仓库的url、username、password、ssl | |
online | 是否在线安装: false:离线安装 true:在线安装 不建议修改该配置项,该配置项与下载的安装包类型有关,详情请参见4.1节 | |
组件配置 | - | components下,配置的是2.2节列举的待安装的组件 每个组件都可以自定义端口,参数为:portMapping: {访问用的端口: 镜像中固定的端口 } 安装的组件和默认端口如3.2节,请排查端口是否可用,是否开放,并按需修改yaml文件中的端口。 |
2)文件示例
limit: { minDiskCapacity: 100 , minMemoryCapacity: 8 } #只部署运维平台,默认的限制只需要要求100G磁盘和8G内存
deploymentType: 2
nodes:
- ip: localhost #机器ip
port: 22 #机器ssh端口
user: #节点ssh用户
password: #节点ssh密码
dataRootPath: ~/data
repo:
port: 5000 #待安装的registry仓库端口
#指定已有repo
url: #已有repo的url
username: #已有repo的用户名
password: #已有repo的密码
ssl: true #已有repo是否安全仓库
online: false #在线安装
#组件端口配置
#components:
# nginx:
# portMapping: {80: 8080}
#
# ops:
# portMapping: {8081: 8080}
#
# ops_agent:
# portMapping: {9070: 9070}
#
# grafana:
# portMapping: {3000: 3000}
#
# prometheus:
# portMapping: {9090: 9090}
#
# alertmanager:
# portMapping: {9093: 9093}
#
# loki:
# portMapping: {3100: 3100}
#
# promtail:
# portMapping: {9080: 9080}
#
# nginx_exporter:
# portMapping: {9113: 9113}
#
# skywalking_oap:
# portMapping: {11800: 11800, 12800: 12800}
#
# skywalking_ui:
# portMapping: {8082: 8080}
#
# elasticsearch:
# portMapping: {9200: 9200}
# password: elasticadmin
#
# elasticsearch_exporter:
# portMapping: {9114: 9114}
5. 部署操作编辑
5.1 启动部署
1)使用 cd 命令进入工具解压目录下 bin 文件夹
2)键入如下命令执行自动化部署:
./finekey
3)整个部署过程需要花费一段时间,请耐心等待,如果部署过程中出现报错,请参考 容器化部署常见问题 ,查看有无对应的解决方案。
5.2 完成部署
当出现 deployment success!bye~ 提示时,表示已经成功部署,如下图所示:
5.3 访问工程
部署完成后,服务会自动启动,此时可以在浏览器地址栏输入:http://{ip}/ops/decision(请把{ip}换成自己的主机IP),访问FineOps运维平台。
例如本文示例,浏览器地址栏键入:http://192.168.110.254/ops/decision,即可访问运维平台,如下图所示:
注:由于默认Nginx端口为80,所以运维平台访问地址中才能省略端口,直接用IP访问。
若为非root用户部署,默认端口为8090,访问地址为http://ip:8090/ops/decision
若finekey.yaml文件中,手动修改了Nginx端口,访问地址为http://ip:Nginx端口/ops/decision