1. 概述
1.1 版本说明
运维平台版本 | 功能变更 |
---|---|
V1.5.6 | 运维平台瘦身,取消内置和安装部分冗余运维组件镜像:loki、promtail、sherlock、nacos-server、skywalking_ui |
V1.5.7 | elasticsearch、skywalking_oap组件安装后默认启动 |
V1.11.0 | 新增浏览器版本检测提醒 |
V1.12.0 | 部署成功提示工程地址,方便用户访问 |
V1.14.0 | 若检测挂载磁盘空间不足,可快速更换部署路径,无需手动更改yaml |
V1.15.0 | 调整部分运维组件默认端口,防止与运维项目冲突
|
V2.0.0 | 降低资源要求 1)删除node_exporter、nginx_exporter、elasticsearch_exporter组件,功能合并至ops-agent,用于收集ops所在服务器的指标信息、收集nginx、elasticSearch组件的指标信息 2)新增pushgateway组件,临时存储ops-agent收集到的指标,并供prometheus获取 3)支持部署基础版运维平台,不部署elasticSearch、skywalking_oap组件,不启用链路追踪相关功能 |
V2.6.0 | 部署运维平台时,支持通过修改finekey.yaml文件中的参数值,切换运维平台语言 |
V2.8.0 | 1)部署运维平台时,新增对finekey.yaml文件进行前置校验和错误提示 2)支持切换默认语言为俄文 |
V2.11.0 | 支持切换默认语言为韩文、日文 |
V2.14.0 | 部署运维平台时,支持通过修改finekey.yaml文件中的timezone参数值,切换容器时区配置 |
1.2 应用场景
运维平台是帆软软件推出的,为企业提供帆软应用稳定运行和全方位运维管理的解决方案。
运维平台可以帮助用户解决,管理帆软应用(FineReport、FineBI、FineDataLink)的过程中,遇到的一些痛点和挑战,详情请参见:运维平台简介
如需标准部署帆软项目(FineBI、FineReport、FineDataLink),必须基于运维平台进行。
1.3 功能简介
本文介绍,如何部署运维平台。
本文主要提供给服务器资源较为紧张的客户,如能提供全新服务器用于部署,可参考:快速入门
2. 准备服务器
请按照以下文档,依次检查所准备的服务器是否满足部署运维平台的需求。
文档 | 说明 |
---|---|
了解运维平台标准版与基础版 | 基础版运维平台资源要求低,部分功能不支持使用。 标准版运维平台支持全量功能,但资源要求较高 用户需要按照实际情况选择 |
了解运维平台组件作用 | FineOps运维平台,由多个运维组件共用构成 用户应当在部署前了解每个运维组件的作用 |
准备运维平台服务器 | 确认部署运维平台的服务器的内存、磁盘、操作系统等 确认运维平台是否已有docker以及版本 确认服务器需要为运维组件预留的端口 确认服务器需要对外开放的端口 准备安装运维平台的合适位置确认部署运维平台的用户权限是否满足需求 |
3. 准备finekey工具
3.1 获取finekey安装包
点击可跳转至下载页下载安装包:运维平台安装包下载
有三种类型的安装包,用户可根据服务器环境和自身诉求自行选择:
注:如希望使用在线版安装包,且只开放指定外网网址,请确保镜像仓库所在服务器支持访问以下外网地址:帆软云端镜像仓库
(运维平台自带的镜像仓库与运维平台在同一服务器下)
安装包类型 | 说明 |
---|---|
在线版安装包 | 1)服务器可访问外网,支持下载运维组件镜像,安装包体积小 2)支持从云端下载帆软应用相关组件镜像,可通过运维平台可视化部署工程 3)可对接已有帆软应用工程 |
纯净版离线安装包 | 1)服务器为内网,内置全部运维组件镜像,安装包体积大 2)未内置帆软应用相关组件镜像,无法通过运维平台可视化部署工程 3)用于对接已有帆软应用工程 |
全量版离线安装包 | 1)服务器为内网,内置全部运维组件镜像,安装包体积大 2)内置帆软应用相关组件镜像,可通过运维平台可视化部署工程 3)可对接已有帆软应用工程 |
3.2 上传finekey安装包
获得工具包后,需要将它上传到 Linux,上传文件的方法请自行查阅相关资料。
本文示例是将工具包上传到了 CentOS 7.6.1810 的 /home/ops 路径下,如下图所示:
3.3 解压finekey安装包
1)先使用 cd 命令进入工具包所在文件夹下。
2)根据下载的安装包类型,键入命令进行解压:
安装包类型 | 解压语句 |
---|---|
在线版安装包 | tar -xvf finekey-operation-online.tar |
纯净版离线安装包 | tar zxvf finekey-operation-lite.tar.gz |
全量版离线安装包 | tar zxvf finekey-operation-all.tar.gz |
解压后的文件如下表所示:
文件夹/文件 | 文件说明 | |
---|---|---|
finekey/bin | 运行finekey的可执行文件 | |
finekey/conf | finekey.yaml | 新部署运维平台配置文件 |
finekey.push.yaml | 拉取镜像配置文件 | |
finekey/resources | 资源文件,镜像包放在其中images文件夹中 |
3.4 配置finekey.yaml文件
yaml文件指的是工具解压目录下conf文件夹里的finekey.yaml,该文件是控制后面整个自动部署流程的。
如完全采用默认部署配置(包括安装目录、组件端口,仓库配置等),用户可不对yaml文件做任何配置,可以直接在当前宿主机本地部署。
如需更改运维平台相关配置、组件占用端口等,可以打开yaml文件自行配置,yaml文件的配置需要在启动FineKey之前完成。
1)文件内容说明
配置 | 配置项 | 说明 |
---|---|---|
基础配置 | node | 内容说明: node为部署运维平台的服务器信息,包括 ip,port,user,password 修改说明: 1)如果finekey工具与运维平台处于同一台服务器、部署用户与当前终端用户一致,则无需修改此部分内容 2)推荐使用名为root的服务器超管用户进行部署,如使用其他用户,请确保满足 部署运维平台的用户权限 3)如果ssh方式为密钥,则需要将password配置注释,新增一行密钥路径,请填写绝对路径,不支持相对路径 keypath: /密钥绝对路径/密钥文件名称 |
dataRootPath | 内容说明: 运维平台部署成功后的根挂载目录 修改说明: 1)默认安装目录为~/data,即安装用户主目录下的data文件夹,而不是/data文件夹 例如使用root用户部署,则~/data代表的目录为/root/data 2)如需修改挂载目录,请填写绝对路径,不支持相对路径 请确保挂载目录所在分区,剩余磁盘空闲空间≥100G | |
repo | 内容说明: 默认全新安装一个registry镜像仓库 可指定仓库端口,默认5000,其他信息无需修改 修改说明: 如自备了镜像仓库,可输入自备仓库的port、url、username、password、ssl | |
online | 内容说明:是否在线安装 修改说明: 不建议修改该配置项,该配置项与下载的安装包类型有关,详情请参见3.1节 false:离线安装 true:在线安装 | |
language | 内容说明:运维平台界面的语言设置 修改说明: CN:简体中文 TW:繁体中文 EN:英文 RU_sv:俄文 KR:韩文 JA:日文 | |
timezone | 内容说明:容器时区设置 修改说明: 默认无需配置,默认值为 Asia/Shanghai 如需指定时区,请将#注释符号删掉,然后填写标准 IANA 时区 建议与所准备的项目服务器时区一致 | |
bip | 内容说明:docker默认容器网段 修改说明:默认无需配置,如需指定网段,请将#注释符号删掉,然后填写指定网段 | |
fip | 内容说明:运维组件容器内网段 修改说明:默认无需配置,如需指定网段,请将#注释符号删掉,然后填写指定网段 | |
组件配置 | components | 内容说明: components下,配置的是 运维平台组件 中列举的待安装的组件 除镜像仓库registry外,运维平台的所有组件均由帆软进行了自定义适配优化,因此不支持用户自备对接 这些组件可以自定义访问端口,参数为:portMapping: {访问用的端口: 镜像中固定的端口 } 修改说明: 1)请根据 运维平台服务器网络 排查端口是否可用,是否开放,并按需修改yaml文件中的端口 2)端口portMapping为{映射端口:容器内端口} ,其中映射端口可改,容器内端口不要修改,不要删除。 3)如果修改了components下的组件配置,需要将components和组件前面的#注释符号删掉 示例:修改ops的端口8081为8088
#组件端口配置|Component port configuration #components: # nginx: # portMapping: {80: 8080} # # ops: # portMapping: {8081: 8080}
#组件端口配置|Component port configuration components: # nginx: # portMapping: {80: 8080} # ops: portMapping: {8088: 8080} |
2)文件示例
node:
ip: localhost #节点ip|Node IP
port: 22 #节点ssh端口|Node SSH port
user: #节点ssh用户|Node SSH username
password: #节点ssh密码|Node SSH password
dataRootPath: ~/data
repo:
port: 5000 #待安装的registry仓库端口|Registry Port
#指定已有repo|Specifies an existing container registry
url: #已有repo的url|Registry URL
username: #已有repo的用户名|Registry username
password: #已有repo的密码|Registry password
ssl: true #是否有ssl设置|Repository with SSL set or not
online: false #在线安装|Online installation
language: CN #语言设置 CN/TW/EN/RU_sv|Language Setting CN/TW/EN/RU_sv/KR/JA
#timezone: "Asia/Shanghai" #时区设置
#bip: 10.16.0.1/16 #docker默认容器网段
#fip: 10.17.0.1/16 #运维组件容器内网段
#组件端口配置|Component port configuration
#components:
# nginx:
# portMapping: {80: 8080}
#
# ops_agent:
# portMapping: {9071: 9070}
#
# skywalking_oap:
# portMapping: {11800: 11800, 12800: 12800}
#
# elasticsearch:
# portMapping: {9200: 9200}
# password: elasticadmin
4. 部署操作
4.1 启动部署
1)使用 cd 命令进入工具解压目录下 bin 文件夹
2)键入如下命令执行自动化部署:
注1:请严格按照文档所述命令执行,不要自行变更为sudo ./finekey之类的命令。否则可能导致部署失败。
部署版本 | 命令 |
---|---|
标准版运维平台 | ./finekey |
基础版运维平台 | ./finekey --lite |
3)整个部署过程需要花费一段时间,请耐心等待。
注1:开始部署前,会自动对finekey.yaml文件内容进行校验,如果存在必填项未设置、校验值错误、非预设组件等,会直接报错提示并终止部署。
注2:如果部署过程中出现报错,请参考 容器化部署常见问题 ,查看有无对应的解决方案。
请注意~/data目录不代表/data目录,而是对应用户主目录下的/data目录。例如使用root用户部署,则~/data代表的目录为/root/data
注3:如果部署过程中,检测到挂载目录磁盘可用空间不足100G,会提示「The current path capacity check failed, Please re-enter the path」
用户无需退出部署环节,手动修改yaml文件。可直接输入满足条件的目录,继续部署。
4.2 完成部署
当出现 deployment success!bye~ 提示时,表示已经成功部署。
在该行提示中,会展示运维平台的工程地址,可复制,用于下一步访问。如下图所示:
注1:地址中的IP,是服务器内网IP。如需使用外网访问,请自行调整为外网IP。
注2:地址中的端口,是部署时设置的Nginx组件占用的端口。
若为root用户部署,默认端口为80,运维平台访问地址中可以省略端口,直接用IP访问,访问地址为http://ip/ops/decision
若为非root用户部署,默认端口为8090,访问地址为http://ip:8090/ops/decision
若finekey.yaml文件中,手动修改了nginx端口,访问地址为http://ip:nginx端口/ops/decision
4.3 访问工程
部署完成后,服务会自动启动,此时可以在浏览器地址栏输入上一步获取的工程地址,访问运维平台。
1)选择浏览器
请使用以下版本的浏览器访问运维平台,否则可能导致界面展示异常。
浏览器类型 | 推荐版本 |
---|---|
Chrome | 88以上版本 |
Edge | 88以上版本 |
Safari | 14以上版本 |
Firefox | 78以上版本 |
IE | 不支持 |
如使用不符合版本要求的浏览器进行访问,部分界面会出现弹窗提醒「检测到当前浏览器版本过低,可能导致部分组件显示异常,建议升级浏览器版本」。
2)访问工程
在浏览器地址栏输入上一节获取的工程地址,访问FineOps运维平台。
例如本文示例,浏览器地址栏键入:http://IP/ops/decision,即可访问运维平台,如下图所示: