1. 概述
1.1 版本
运维平台版本 | 功能变更 |
---|---|
V1.5.5 | - |
V1.5.6 | 部署过程中,不再安装冗余组件promtail、rocketmq_namesrv、rocketmq_broker |
V1.6.0 | 1)为了确保集群日志存储的稳定性: 容器化部署集群项目时,elasticsearch套件不再可选安装,而是必须安装 安装elasticsearch时,同步在每一个工程节点安装filebeat组件 2)部署项目时,工程外挂目录新增help文件夹 |
V1.9.0 | 部署交互界面优化 |
V1.10.0 | 部署进度界面优化,细分展示镜像拉取和组件部署进度 |
V1.11.0 | 1)项目名称限制放宽,新增支持英文大写、中文 2)部署新集群项目时,支持使用外部共享目录作为文件服务器 3)项目配置中,访问路径支持为空 |
V1.14.0 | 部署的配置库组件,由MySQL5调整为MySQL8 |
V1.15.0 | 1)节点配置时,支持填写外网IP,以适配不支持内网访问、仅可外网映射的服务器 2)支持在部署过程中「中止部署」,自动停止本次部署并回退已有操作 3)部署的FineBI组件,默认Xmx限制提升,降低oomkill风险 优化前:默认Xmx=机器内存减掉8G后的内存大小 优化后:默认Xmx=机器内存减掉10G后的内存大小 |
V2.0.0 | 1)降低资源要求,删除node_exporter、nginx_exporter、elasticsearch_exporter组件,功能合并至ops-agent,用于收集项目服务器的指标信息、收集组件的指标信息 2)部署单机项目,默认部署nginx组件,方便后续配置SSL和扩容 |
V2.3.0 | 1)运维平台部署项目,限制应用服务数量,最高部署5节点集群 3)部署新项目交互优化,调整组件端口配置的操作位置,以防忘记检查 |
V2.4.0 | 对于日志服务组件,支持对接自备的8.X版本的elasticsearch |
V2.6.0 | 新增「环境检测」环节,对项目部署环境进行检测并提示 |
V2.7.1 | 支持部署FineBI6.1版本项目 |
V2.8.0 | 针对多项目管理场景,部署/接入多个项目时,判断运维平台服务器是否需要增加资源,以保证稳定性 |
V2.9.0 | 支持部署低资源要求的「体验环境」新项目,适用于产品体验、功能测试等极少用量的场景 |
V2.11.0 | 对于FineBI6.1项目,bi-engine-master和bi-minio组件部署在第一个添加的主应用节点中 |
V2.12.0 | 1)项目设置和节点配置环节,新增部署时区设置和校验,确保服务器时区与部署时区一致 2)部署列表环节,新增端口冲突提示,并提供可用端口建议 |
1.2 功能简介
运维平台支持部署并直接接入全新FineReport、FineBI、FineDataLink项目。
本文将介绍,如何使用 运维平台 部署全新的帆软FineReport、FineBI、FineDataLink项目。
注:本文面向服务器资源不足或端口限制较高的用户,操作步骤较为详细,篇幅较长。
如能准备充足资源的全新服务器,可参考快速指南进行部署:部署新帆软项目
2. 前置准备
操作步骤 | 说明 | |
---|---|---|
1 | 部署运维平台 | 帆软应用依赖运维平台进行部署 因此用户需要提前部署好FineOps运维平台 |
2 | 选择帆软产品 | 帆软提供多种产品:FineBI、FineReport、FineDataLink 因此用户需要先确认所需的产品类型 运维平台部署的项目,不仅仅包括工程,还包括配套的外接配置库、集群组件、运维组件等,用户需要自行了解每个组件的作用,并判断是否安装 |
3 | 准备服务器 | 按照所选定的产品,准备对应的部署环境 FineBI: FineReport: FineDataLink: |
4 | 确认镜像仓库 | 部署新项目中的各个组件,是需要通过镜像进行部署的。要么镜像仓库已有镜像,要么支持从云端拉取镜像 |
5 | 确认运维平台xmx配置 | 运维平台与项目对接,会占用一些运维平台服务器资源 如检测到运维平台的配置不足,将无法部署新项目,会提示「当前运维平台配置已经达到上限,将影响接入或部署新项目,请尽快调大ops的xmx配置」 1)请点击「运维平台管理>运维组件」,在「ops」组件处点击「更改配置」 2)根据提示配置xmx值,以保证能接入新项目 |
3. 部署新项目
本节正式进入部署新项目的操作环节。请在开始部署前务必确认上文的所有内容,否则可能会部署失败!
3.1 新增项目
管理员登录 FineOps 运维平台,点击「部署新项目」。
注:运维平台与项目对接,会占用一些运维平台服务器资源。一个运维平台默认支持对接10个工程节点(集群按照多个节点计算)
由于部署新项目后,运维平台会与该项目自动对接。因此如检测到运维平台的配置不足,在部署新项目时会进行提示。
如「部署新项目」按钮灰化,出现提示「当前运维平台配置已经达到上限,无法再接入新项目,请尽快调大ops的xmx配置」,请根据提示调整配置。
3.2 项目设置
项目设置是配置项目的类型、需要安装的组件、占用的端口等信息。
进入「项目设置」界面,输入相关项目信息,点击「下一步」,如下图所示:
各配置项如下表所示:
信息 | 说明 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
项目名称 | 自定义项目的名称 项目名称不允许为空 项目名称仅支持中文、英文大小写、数字 项目名称长度最大为12位 项目名称不允许与已有项目重名 | ||||||||||||||||
应用类型 | V2.7.0及之前版本运维平台,支持选择:FineReport、FineBI6.0、FineDataLink V2.7.1及之前版本运维平台,支持选择:FineReport、FineBI6.1、FineDataLink | ||||||||||||||||
应用服务数量 | 对于单个FineReport/FineDataLink项目,支持部署 1~5 应用服务 对应单个FineBI6.1项目,强制部署1master组件,所选应用服务为bi和worker组件数量,强制1:1/1:2配比,确保工程均衡 | ||||||||||||||||
访问路径 | 应用的访问链接为{域名/IP}/{访问路径}/decision 支持用户自定义应用的访问路径,访问路径默认为webroot 需要注意: 如需配置短域名/IP访问工程,请务必配置访问路径为空,项目部署成功后无法更改 此时工程对应的root目录访问路径为:http://IP:端口/root 详情请参见:使用IP/域名访问项目 | ||||||||||||||||
部署类型 | V2.9.0及之后版本新增该配置,支持在低资源环境下部署测试工程,适用于产品体验、功能测试等极少用量的场景
详情可参见:了解运维项目测试版与正式版 | ||||||||||||||||
部署时区 | 请填写部署组件所用的时区,请填写标准 IANA 时区格式 建议与所准备的项目服务器时区一致 如输入值非 IANA 时区格式,提示「请输入正确的时区信息」 | ||||||||||||||||
基础组件 | 即可选安装的组件,支持不部署/部署帆软准备的组件/对接用户自行准备的组件 此处不包括必须安装的组件 各种组件的作用请参考:了解运维项目组件作用 需要注意:
|
3.3 节点配置-新增主应用节点
配置完需要的组件和端口后,即可进入「节点配置」。
首先需要新增主应用节点,即为添加主应用服务器的相关信息。
注1:对于多应用服务项目,有多个主应用节点,因此本章操作需要反复执行多次
注2:对于FineBI6.1项目,bi-web和bi-engine-worker组件均衡部署在所有主应用节点中,bi-engine-master和bi-minio组件部署在第一个添加的主应用节点中。
因此请第一个添加资源较大的服务器为主应用节点。
1)点击「新增节点」,选择节点类型为「主应用」,填写相关设置项,点击「测试连接」。
具体节点设置如下图所示:
节点设置 | 说明 |
---|---|
节点类型 | 请选择「主应用」 注:帆软项目需要独占服务器,即该主应用服务器上不建议部署其他工程或内容,包括运维平台 |
主机 | 请输入节点主机IP(内网IP) 注:同一项目中,主机不支持重复添加多次 |
端口 | 请输入节点端口号,默认为22 |
用户名 | 请输入有sudo权限的服务器用户名 |
验证方法 | 支持两种:密码、公钥 注1:密码密钥仅用于部署项目,部署结束后无需使用,项目与运维平台的对接依赖平台配置。 因此后续如修改了服务器密码,不会对运维监控产生影响。 注2:如选择公钥方式验证 请上传后缀为.key的私钥文件(例如id_rsa.key) 请勿上传其他后缀格式的私钥文件,请勿上传公钥文件(例如id_rsa.pub) |
挂载路径 | 请输入节点安装目录的服务器路径,即前置准备环节设置的挂载目录 默认为~/data,~代表所使用的服务器用户的主目录 注:可在终端使用该用户账号访问服务器,输入echo $HOME命令查看该用户的主目录路径 |
外网IP | 选填项 如果服务器不支持内网访问,仅支持外网映射,请务必填写可联通的外网IP |
2)效果预览
若主机用户名等信息校验成功,即可添加一个主应用节点。多个节点均添加完成后,如下图所示:
注1:若网络环境不满足前置准备环节要求,节点连接失败,则出现报错提醒,无法正确新增节点。
注2:若服务器配置不符前置准备环节最低要求,则出现报错提醒,无法正确新增节点。
注3:若服务器时区与项目设置中的部署时区不一致,则出现弹窗提示「节点时区和部署时区不一致」,可点击「修改部署时区」进行调整。
3.4 节点配置-新增组件节点
接着要新增组件节点,即为添加组件服务器的相关信息。(若用户准备了多个组件服务器,本章操作需要反复执行多次)。
1)点击「新增节点」,选择节点类型为「组件」,填写相关设置项,点击「测试连接」。
具体节点设置如下图所示:
节点设置 | 说明 |
---|---|
节点类型 | 请选择「组件」 注1:如配置了多个组件节点,则组件随机部署在各个节点 注2:帆软项目需要独占服务器,即该组件服务器上不建议部署其他工程或内容,包括运维平台 |
主机 | 请输入节点主机IP(内网IP) 注:同一项目中,主机不支持重复添加多次 |
端口 | 请输入节点端口号,默认为22 |
用户名 | 请输入有sudo权限的服务器用户名 |
验证方法 | 支持两种:密码、公钥 注1:密码密钥仅用于部署项目,部署结束后无需使用,项目与运维平台的对接依赖平台配置。 因此后续如修改了服务器密码,不会对运维监控产生影响。 注2:如选择公钥方式验证 请上传后缀为.key的私钥文件(例如id_rsa.key) 请勿上传其他后缀格式的私钥文件,请勿上传公钥文件(例如id_rsa.pub) |
挂载路径 | 请输入节点安装目录的服务器路径,即前置准备环节设置的挂载目录 默认为~/data,~代表所使用的服务器用户的主目录 注:可在终端使用该用户账号访问服务器,输入echo $HOME命令查看该用户的主目录路径 |
外网IP | 选填项 如果服务器不支持内网访问,仅支持外网映射,可以填写可联通的外网IP |
2)效果预览
若主机用户名等信息校验成功,即可添加一个组件节点。如下图所示:
注1:若网络环境不满足前置准备环节要求,节点连接失败,则出现报错提醒,无法正确新增节点。
注2:若服务器配置不符合前置准备环节最低要求,则出现报错提醒,无法正确新增节点。
3.5 部署列表
节点配置完成后,点击「下一步」,进行「部署列表」确认界面。
此步骤包括两项内容:用户自定义组件配置、运维平台检测服务器资源
1)用户自定义组件配置
用户可在该界面,对每一个组件的端口、用户名密码进行调整
请务必修改mysql、redis、minio、elasticsearch、nacos、nacos_mysql组件的密码,这些组件的默认密码随机生成,部署成功后无法修改。
如忘记相关组件用户名和密码,可通过导出部署信息找回,详情请参见:导出项目部署信息
2)运维平台检测服务器资源
运维平台会自动检测每台服务器的可用资源,以及待部署组件所需的服务器资源
如服务器资源不足,会飘红提示,无法进入下一步,必须对服务器进行扩容增配后重新尝试部署。
如在节点配置中使用了非root用户,在部署列表步骤中,不支持使用1024以下端口,因为非root用户无权使用。
如提示「组件端口冲突,请调整相关部署配置!」,说明存在所设置的组件端口不可用,或多个组件使用同一端口。
运维平台会自动检测并提示可用端口,建议根据提示修改端口。
3.6 环境检测
配置完成后,点击「开始检测」,会对部署环境进行检测,并出具检测报告,支持下载到本地查看。
如不满足部署环境强制要求,将无法进入部署环境,请根据检测结果优化后重新检测。
相关检测项的解决方案可参考:部署项目环境检测解决方案
3.7 开始部署
通过环境检测后,点击「开始部署」,即可进入部署过程。
1)如果本地没有相关组件镜像,部署前会自动从云端拉取镜像。
2)镜像准备完毕后,开始逐个部署组件,若部署失败则显示失败原因。
注1:部署过程中,用户可点击「隐藏至后台进行」,正常进行运维平台其他操作。
注2:部署过程中,支持在部署过程中点击「中止部署」按钮,停止部署并回退所有已有部署操作。
3)项目部署成功后,出现提示「项目部署成功」。
3.8 效果预览
通过运维平台成功部署的新项目,自动接入运维平台的项目管理列表中,可进行相关运维操作。
其中的访问地址,即为该运维项目的访问地址。点击即可在浏览器新窗口访问该地址,进入工程初始化配置界面。