安装包目录结构

1.Linkis1.0的目录调整和优化

Linkis1.0的目录结构与0.X版本相差巨大,0.X的每个微服务都时独立存在的一个根目录,这种目录结构带来的主要的好处是易于区分微服务,便于单个的微服务进行管理,但也存在着一些很明显的问题:

  • 1.微服务目录过于繁杂,切换目录管理不够方便
  • 2.没有统一的启动脚本,导致微服务启停比较麻烦
  • 3.存在大量重复的服务配置,同一个配置经常需要修改多处
  • 4.存在大量重复的Lib依赖,增大了安装包的体积和依赖冲突的风险

因此Linkis1.0中,我们对安装目录结构做了极大程度的优化和调整,减少了微服务目录的数量,降低了重复依赖的jar包,尽可能复用了配置文件和微服务管理脚本,主要体现在以下几个方面:

  1. 不再为每个微服务提供bin文件夹,修改为所有微服务共用。

Bin文件夹修改为安装目录,主要用于安装Linkis1.0和检查环境状态,新增sbin目录,为Linkis提供一键启停,依靠变更参数的方式为所有微服务提供单独启停。

  1. 不再为每个微服务单独提供conf目录,修改为所有微服务共用。

Conf文件夹包含两个方面的内容,一方面是所有微服务共用的配置信息,这类配置信息里面包含了用户根据自身环境自定义配置的信息;另一方面是各个微服务的各自的特殊配置,一般情况下用户不需要自行更改。

  1. 不再为每个微服务提供lib文件夹,修改为所有微服务共用

Lib文件夹中同样包含了两个方面的内容,一方面是所有微服务都需要的公共依赖;另一方面是各个微服务各自需要的特殊依赖。

  1. 不再为每个微服务提供log目录,修改为所有微服务共用

Log目录中包含了所有微服务的日志文件。

2. 目录结构

Linkis1.0简化后的目录结构如下,其中加**标注的文件,为用户安装使用时必定会使用的目录项,其他目录项初次使用无特殊情况无需关心:

  1. ├── bin 安装目录
  2. ├── checkEnv.sh ── 环境变量检测
  3. ├── checkServices.sh ── 微服务状态检测
  4. ├── common.sh ── 部分公共shell函数
  5. ├── install-io.sh ── 用于安装时的依赖替换
  6. └── **install.sh** ── **Linkis安装的主脚本**
  7. ├── conf 配置目录
  8. ├── application-eureka.yml
  9. ├── application-linkis.yml ──微服务通用yml
  10. ├── linkis-cg-engineconnmanager-io.properties
  11. ├── linkis-cg-engineconnmanager.properties
  12. ├── linkis-cg-engineplugin.properties
  13. ├── linkis-cg-entrance.properties
  14. ├── linkis-cg-linkismanager.properties
  15. ├── linkis-computation-governance
  16. └── linkis-client
  17. └── linkis-cli
  18. ├── linkis-cli.properties
  19. └── log4j2.xml
  20. ├── linkis-env.sh ──linkis environment properties
  21. ├── linkis-et-validator.properties
  22. ├── linkis-mg-gateway.properties
  23. ├── linkis.properties ──linkis global properties
  24. ├── linkis-ps-bml.properties
  25. ├── linkis-ps-cs.properties
  26. ├── linkis-ps-datasource.properties
  27. ├── linkis-ps-publicservice.properties
  28. ├── log4j2.xml
  29. ├── proxy.properties(可选)
  30. └── token.properties(可选)
  31. ├── db 数据库DMLDDL文件目录
  32. ├── linkis\_ddl.sql ──数据库表定义SQL
  33. ├── linkis\_dml.sql ──数据库表初始化SQL
  34. └── module ──包含各个微服务的DMLDDL文件
  35. ├── lib lib目录
  36. ├── linkis-commons ──公共依赖包
  37. ├── linkis-computation-governance ──计算治理模块的lib目录
  38. ├── linkis-engineconn-plugins ──所有引擎插件的lib目录
  39. ├── linkis-public-enhancements ──公共增强服务的lib目录
  40. └── linkis-spring-cloud-services ──SpringCloudlib目录
  41. ├── logs 日志目录
  42. ├── linkis-cg-engineconnmanager-gc.log
  43. ├── linkis-cg-engineconnmanager.log
  44. ├── linkis-cg-engineconnmanager.out
  45. ├── linkis-cg-engineplugin-gc.log
  46. ├── linkis-cg-engineplugin.log
  47. ├── linkis-cg-engineplugin.out
  48. ├── linkis-cg-entrance-gc.log
  49. ├── linkis-cg-entrance.log
  50. ├── linkis-cg-entrance.out
  51. ├── linkis-cg-linkismanager-gc.log
  52. ├── linkis-cg-linkismanager.log
  53. ├── linkis-cg-linkismanager.out
  54. ├── linkis-et-validator-gc.log
  55. ├── linkis-et-validator.log
  56. ├── linkis-et-validator.out
  57. ├── linkis-mg-eureka-gc.log
  58. ├── linkis-mg-eureka.log
  59. ├── linkis-mg-eureka.out
  60. ├── linkis-mg-gateway-gc.log
  61. ├── linkis-mg-gateway.log
  62. ├── linkis-mg-gateway.out
  63. ├── linkis-ps-bml-gc.log
  64. ├── linkis-ps-bml.log
  65. ├── linkis-ps-bml.out
  66. ├── linkis-ps-cs-gc.log
  67. ├── linkis-ps-cs.log
  68. ├── linkis-ps-cs.out
  69. ├── linkis-ps-datasource-gc.log
  70. ├── linkis-ps-datasource.log
  71. ├── linkis-ps-datasource.out
  72. ├── linkis-ps-publicservice-gc.log
  73. ├── linkis-ps-publicservice.log
  74. └── linkis-ps-publicservice.out
  75. ├── pid 所有微服务的进程ID
  76. ├── linkis\_cg-engineconnmanager.pid ──引擎管理器微服务
  77. ├── linkis\_cg-engineconnplugin.pid ──引擎插件微服务
  78. ├── linkis\_cg-entrance.pid ──引擎入口微服务
  79. ├── linkis\_cg-linkismanager.pid ──linkis管理器微服务
  80. ├── linkis\_mg-eureka.pid ──eureka微服务
  81. ├── linkis\_mg-gateway.pid ──gateway微服务
  82. ├── linkis\_ps-bml.pid ──物料库微服务
  83. ├── linkis\_ps-cs.pid ──上下文微服务
  84. ├── linkis\_ps-datasource.pid ──数据源微服务
  85. └── linkis\_ps-publicservice.pid ──公共微服务
  86. └── sbin 微服务启停脚本目录
  87. ├── ext ──各个微服务的启停脚本目录
  88. ├── **linkis-daemon.sh** ── **快捷启停、重启单个微服务脚本**
  89. ├── **linkis-start-all.sh** ── **一键启动全部微服务脚本**
  90. └── **linkis-stop-all.sh** ── **一键停止全部微服务脚本**

3. 配置项修改

在执行完bin目录下的install.sh完成Linkis安装后,需要进行配置项修改,所有配置项位于con目录下,通常情况下需要修改db.sh、linkis.properties、linkis-env.sh三个配置文件,项目安装和配置可以参考文章《Linkis1.0安装》

4. 微服务启停

修改完配置项之后即可在sbin目录下启动微服务,所有微服务名称如下:

  1. ├── linkis-cg-engineconnmanager 引擎管理服务
  2. ├── linkis-cg-engineplugin 引擎插件管理服务
  3. ├── linkis-cg-entrance 计算治理入口服务
  4. ├── linkis-cg-linkismanager 计算治理管理服务
  5. ├── linkis-mg-eureka 微服务注册中心服务
  6. ├── linkis-mg-gateway Linkis网关服务
  7. ├── linkis-ps-bml 物料库服务
  8. ├── linkis-ps-cs 上下文服务
  9. ├── linkis-ps-datasource 数据源服务
  10. └── linkis-ps-publicservice 公共服务

微服务简称

简称英文全称中文全称
cgComputation Governance计算治理
mgMicroservice Covernance微服务治理
psPublic Enhancement Service公共增强服务

以往启停单个微服务需要进入到各个微服务的bin目录下,执行start/stop脚本,在微服务较多的情况下启停比较麻烦,增加了很多额外的切换目录操作,Linkis1.0将所有的微服务启停相关的脚本放置在了sbin目录下,只需要执行单个入口脚本即可。

在Linkis/sbin目录下

  1. 1. 一次性启动所有微服务:
  2. sh linkis-start-all.sh
  3. 2. 一次性关停所有微服务
  4. sh linkis-stop-all.sh
  5. 3. 启动单个微服务(服务名需要去掉linkis前缀如:mg-eureka
  6. sh linkis-daemon.sh start service-name
  7. 例如: sh linkis-daemon.sh start mg-eureka
  8. 4. 关闭单个微服务
  9. sh linkis-daemon.sh stop service-name
  10. 例如: sh linkis-daemon.sh stop mg-eureka
  11. 5. 重启单个微服务
  12. sh linkis-daemon.sh restart service-name
  13. 例如: sh linkis-daemon.sh restart mg-eureka
  14. 6. 查看单个微服务的状态
  15. sh linkis-daemon.sh status service-name
  16. 例如: sh linkis-daemon.sh status mg-eureka