目录结构

Linkis代码层级目录结构，以及安装包目录结构和部署后的目录结构说明，如果想详细了解各个模块，请查看Linkis的相关架构设计

  1. ├── docs
  2. │   ├── configuration //linkis所有模块的配置项文档
  3. │   ├── errorcode //linkis所有模块的错误码文档
  4. ├── linkis-commons //核心抽象，里面放有所有的公用模块
  5. │   ├── linkis-common //通用模块，内置很多通用工具类
  6. │   ├── linkis-hadoop-common
  7. │   ├── linkis-httpclient  //Java SDK顶层接口 对httpclient的进一步封装
  8. │   ├── linkis-module // linkis的服务顶层公用模块 涉及到服务启动时的参数和服务初始化 统一的Restful处理 登录态校验等
  9. │   ├── linkis-mybatis //SpringCloud的Mybatis模块
  10. │   ├── linkis-protocol //服务请求/响应的一些接口和实体类
  11. │   ├── linkis-rpc  //RPC模块，基于Feign实现的复杂双向通信
  12. │   ├── linkis-scheduler //通用调度模块
  13. │   ├── linkis-storage //文件操作工具集
  14. ├── linkis-computation-governance //计算治理服务
  15. │   ├── linkis-client //Java SDK，用户通过Client可直接访问Linkis
  16. │   ├── linkis-computation-governance-common
  17. │   ├── linkis-engineconn
  18. │   ├── linkis-engineconn-manager
  19. │   ├── linkis-entrance //通用底层entrance模块
  20. │   ├── linkis-jdbc-driver //可以类似jdbc sdk方式连接使用linkis
  21. │   ├── linkis-manager
  22. ├── linkis-dist //编译打包最后阶段步骤 整合所有lib包和安装部署脚本配置等
  23. │   ├── bin
  24. │   │   ├── checkEnv.sh
  25. │   │   ├── common.sh
  26. │   │   └── install.sh //安装脚本
  27. │   ├── deploy-config
  28. │   │   ├── db.sh  //数据库配置
  29. │   │   └── linkis-env.sh  //linkis 启动相关配置
  30. │   ├── docker
  31. │   │   └── scripts
  32. │   ├── helm
  33. │   │   ├── charts
  34. │   │   ├── scripts
  35. │   │   ├── README_CN.md
  36. │   │   └── README.md
  37. │   ├── package
  38. │   │   ├── bin
  39. │   │   ├── conf
  40. │   │   ├── db
  41. │   │   └── sbin
  42. │   ├── release-docs
  43. │   │   ├── licenses
  44. │   │   ├── LICENSE
  45. │   │   └── NOTICE
  46. │   ├── src
  47. │   └── pom.xml
  48. ├── linkis-engineconn-plugins // 引擎 
  49. │   ├── elasticsearch 
  50. │   ├── flink
  51. │   ├── hive
  52. │   ├── io_file
  53. │   ├── jdbc
  54. │   ├── openlookeng
  55. │   ├── pipeline
  56. │   ├── presto
  57. │   ├── python
  58. │   ├── seatunnel
  59. │   ├── shell
  60. │   ├── spark
  61. │   ├── sqoop
  62. ├── linkis-extensions // 扩展功能增强插件模块
  63. │   ├── linkis-io-file-client // 对linkis-storage的功能扩展
  64. ├── linkis-orchestrator //服务的编排
  65. │   ├── linkis-code-orchestrator
  66. │   ├── linkis-computation-orchestrator
  67. │   ├── linkis-orchestrator-core
  68. ├── linkis-public-enhancements //公共增强服务
  69. │   ├── linkis-basedata-manager
  70. │   ├── linkis-bml  // 物料库
  71. │   ├── linkis-configuration
  72. │   ├── linkis-context-service //统一上下文
  73. │   ├── linkis-datasource //数据源服务
  74. │   ├── linkis-error-code
  75. │   ├── linkis-instance-label
  76. │   ├── linkis-jobhistory
  77. │   ├── linkis-ps-common-lock
  78. │   ├── linkis-script-dev
  79. │   ├── linkis-udf
  80. │   ├── linkis-variable
  81. ├── linkis-spring-cloud-services //微服务治理
  82. │   ├── linkis-service-discovery
  83. │   ├── linkis-service-gateway //网关Gateway
  84. ├── linkis-web //linkis的管理台代码
  85. │   ├── release-docs
  86. │   │   ├── licenses
  87. │   │   └── LICENSE
  88. │   ├── src
  89. │   ├── config.sh
  90. │   ├── install.sh
  91. │   ├── package.json
  92. │   ├── pom.xml
  93. │   └── vue.config.js
  94. ├── tool
  95. │   ├── dependencies
  96. │   │   ├── known-dependencies.txt
  97. │   │   └── regenerate_konwn_dependencies_txt.sh
  98. │   ├── code-style-idea.xml
  99. │   ├── license-header
  100. │   └── modify_license.sh
  101. ├── CONTRIBUTING_CN.md
  102. ├── CONTRIBUTING.md
  103. ├── linkis-tree.txt
  104. ├── mvnw
  105. ├── mvnw.cmd
  106. ├── pom.xml
  107. ├── README_CN.md
  108. ├── README.md
  109. └── scalastyle-config.xml

Linkis安装包解压后的目录结构

下载官方发布的编译完整包，解压后的目录结构如下:

  2. ├── bin
  3. │   ├── checkEnv.sh ── 环境变量检测
  4. │   ├── common.sh ── 部分公共shell函数
  5. │   └── install.sh ── Linkis安装的主脚本
  6. ├── deploy-config
  7. │   ├── db.sh       //数据库连接配置
  8. │   └── linkis-env.sh //相关环境配置信息
  9. ├── docker
  10. ├── helm
  11. ├── licenses  
  12. ├── linkis-package  //微服务相关的启动配置文件，依赖，脚本，linkis-cli等
  13. │   ├── bin
  14. │   ├── conf
  15. │   ├── db
  16. │   ├── lib
  17. │   └── sbin
  18. ├── NOTICE
  19. ├── LICENSE
  20. ├── README_CN.md
  21. └── README.md

安装后${LINKIS_HOME}目录结构

  1. ├── bin              ──  linkis-cli  用于向Linkis提交任务的Shell命令行程序
  2. │   ├── linkis-cli
  3. │   ├── linkis-cli-hive
  4. │   ├── linkis-cli-pre
  5. │   ├── linkis-cli-spark-sql
  6. │   ├── linkis-cli-spark-submit
  7. │   └── linkis-cli-sqoop
  8. ├── conf 配置目录
  9. │   ├── application-eureka.yml
  10. │   ├── application-linkis.yml    ── 微服务通用yml
  11. │   ├── linkis-cg-engineconnmanager.properties
  12. │   ├── linkis-cg-engineplugin.properties
  13. │   ├── linkis-cg-entrance.properties
  14. │   ├── linkis-cg-linkismanager.properties
  15. │   │── linkis-cli
  16. │   │   ├── linkis-cli.properties
  17. │   │   └── log4j2.xml
  18. │   ├── linkis-env.sh    ── linkis 环境变量配置
  19. │   ├── linkis-mg-gateway.properties
  20. │   ├── linkis.properties  ── linkis 服务的全局配合，所有微服务启动都会加载使用
  21. │   ├── linkis-ps-publicservice.properties
  22. │   ├── log4j2.xml
  23. ├── db 数据库DML和DDL文件目录
  24. │   ├── linkis_ddl.sql ── 数据库表定义SQL
  25. │   ├── linkis_dml.sql ── 数据库表初始化SQL
  26. │   └── module    ── 包含各个微服务的DML和DDL文件
  27. │   └── upgrade   ── 针对每个版本 增量DML/DDL
  28. ├── lib lib目录
  29. │   ├── linkis-commons ── 公共依赖包 大多服务启动时(linkis-mg-gateway除外) -cp 路径参数 都会加载这个目录
  30. │   ├── linkis-computation-governance ──计算治理模块的lib目录
  31. │   ├── linkis-engineconn-plugins ──所有引擎插件的lib目录
  32. │   ├── linkis-public-enhancements ──公共增强服务的lib目录
  33. │   └── linkis-spring-cloud-services ──SpringCloud的lib目录
  34. ├── logs 日志目录
  35. │   ├── linkis-cg-engineconnmanager-gc.log
  36. │   ├── linkis-cg-engineconnmanager.log
  37. │   ├── linkis-cg-engineconnmanager.out
  38. │   ├── linkis-cg-engineplugin-gc.log
  39. │   ├── linkis-cg-engineplugin.log
  40. │   ├── linkis-cg-engineplugin.out
  41. │   ├── linkis-cg-entrance-gc.log
  42. │   ├── linkis-cg-entrance.log
  43. │   ├── linkis-cg-entrance.out
  44. │   ├── linkis-cg-linkismanager-gc.log
  45. │   ├── linkis-cg-linkismanager.log
  46. │   ├── linkis-cg-linkismanager.out
  47. │   ├── linkis-cli
  48. │   │   ├── linkis-client.hadoop.log.20220409162400037523664
  49. │   ├── linkis-mg-eureka-gc.log
  50. │   ├── linkis-mg-eureka.log
  51. │   ├── linkis-mg-eureka.out
  52. │   ├── linkis-mg-gateway-gc.log
  53. │   ├── linkis-mg-gateway.log
  54. │   ├── linkis-mg-gateway.out
  55. │   ├── linkis-ps-publicservice-gc.log
  56. │   ├── linkis-ps-publicservice.log
  57. │   └── linkis-ps-publicservice.out
  58. ├── pid 所有微服务的进程ID
  59. │   ├── linkis_cg-engineconnmanager.pid ──引擎管理器微服务
  60. │   ├── linkis_cg-engineconnplugin.pid ──引擎插件微服务
  61. │   ├── linkis_cg-entrance.pid ──引擎入口微服务
  62. │   ├── linkis_cg-linkismanager.pid ──linkis管理器微服务
  63. │   ├── linkis_mg-eureka.pid ──eureka微服务
  64. │   ├── linkis_mg-gateway.pid ──gateway微服务
  65. │   └── linkis_ps-publicservice.pid ──公共微服务
  66. └── sbin 微服务启停脚本目录
  67.      ├── ext ──各个微服务的启停脚本目录
  68.      ├── linkis-daemon.sh ── 快捷启停、重启单个微服务脚本
  69.      ├── linkis-start-all.sh ── 一键启动全部微服务脚本
  70.      └── linkis-stop-all.sh ── 一键停止全部微服务脚本

在执行完Linkis安装后，所有配置项位于conf目录下， 如果需要进行配置项修改，修改配置${LINKIS_HOME}/conf/*properties文件后，重启对应的服务， 如：sh sbin/linkis-daemon.sh start ps-publicservice。 如果修改的是公共配置文件application-eureka.yml/application-linkis.yml/linkis.properties，需要重启所有服务sh sbin/linkis-start-all.sh

所有微服务名称如下：

  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-publicservice 公共服务

微服务简称：

简称英文全称中文全称
cgComputation Governance计算治理
mgMicroservice Covernance微服务治理
psPublic Enhancement Service公共增强服务
  1. # 一次性启动所有微服务：
  3.      sh linkis-start-all.sh
  5. # 一次性关停所有微服务
  7.      sh linkis-stop-all.sh
  9. # 启动单个微服务（服务名需要去掉linkis前缀如：mg-eureka）
  11.      sh linkis-daemon.sh start service-name
  13.      例如: sh linkis-daemon.sh start mg-eureka
  15. # 关闭单个微服务
  17.      sh linkis-daemon.sh stop service-name
  19.      例如: sh linkis-daemon.sh stop mg-eureka
  21. # 重启单个微服务
  23.      sh linkis-daemon.sh restart service-name
  25.      例如: sh linkis-daemon.sh restart mg-eureka
  26. # 查看单个微服务的状态
  28.      sh linkis-daemon.sh status service-name
  30.      例如: sh linkis-daemon.sh status mg-eureka