github
/
DolphinScheduler
mirror of https://gitee.com/dolphinscheduler/DolphinScheduler.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

[doc] Update project directory structure in docs (#10107)

3.1.0-release
Eric Gao 3 years ago committed by GitHub
parent
0abfb5e744
commit
7a8f3f1810
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 163 additions and 80 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 119
      docs/docs/en/architecture/configuration.md
  2. 124
      docs/docs/zh/architecture/configuration.md

119
docs/docs/en/architecture/configuration.md
Unescape View File

@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .] [Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
``` ```
├─bin DS application commands directory ├── LICENSE
│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application │
│ ├─start-all.sh startup all DS services with configurations ├── NOTICE
│ ├─stop-all.sh shutdown all DS services with configurations │
├─conf configurations directory ├── licenses directory of licenses
│ ├─application-api.properties API-service config properties │
│ ├─datasource.properties datasource config properties ├── bin directory of DolphinScheduler application commands, configrations scripts
│ ├─zookeeper.properties ZooKeeper config properties │   ├── dolphinscheduler-daemon.sh script to start or shut down DolphinScheduler application
│ ├─master.properties master-service config properties │   ├── env directory of scripts to load environment variables
│ ├─worker.properties worker-service config properties │   │   ├── dolphinscheduler_env.sh script to export environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...] when you start or stop service using script `dolphinscheduler-daemon.sh`
│ ├─quartz.properties quartz config properties │   │   └── install_env.sh script to export environment variables for DolphinScheduler installation when you use scripts `install.sh` `start-all.sh` `stop-all.sh` `status-all.sh`
│ ├─common.properties common-service [storage] config properties │   ├── install.sh script to auto-setup services when you deploy DolphinScheduler in `psuedo-cluster` mode or `cluster` mode
│ ├─alert.properties alert-service config properties │   ├── remove-zk-node.sh script to cleanup ZooKeeper caches
│ ├─config environment variables config directory │   ├── scp-hosts.sh script to copy installation files to target hosts
│ ├─install_config.conf DS environment variables configuration script [install or start DS] │   ├── start-all.sh script to start all services when you deploy DolphinScheduler in `psuedo-cluster` mode or `cluster` mode
│ ├─env load environment variables configs script directory │   ├── status-all.sh script to check the status of all services when you deploy DolphinScheduler in `psuedo-cluster` mode or `cluster` mode
│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...] │   └── stop-all.sh script to shut down all services when you deploy DolphinScheduler in `psuedo-cluster` mode or `cluster` mode
│ ├─org mybatis mapper files directory │
│ ├─i18n i18n configs directory ├── alert-server directory of DolphinScheduler alert-server commands, configrations scripts and libs
│ ├─logback-api.xml API-service log config │   ├── bin
│ ├─logback-master.xml master-service log config │   │   └── start.sh script to start DolphinScheduler alert-server
│ ├─logback-worker.xml worker-service log config │   ├── conf
│ ├─logback-alert.xml alert-service log config │   │   ├── application.yaml configurations of alert-server
├─sql .sql files to create or upgrade DS metadata │   │   ├── common.properties configurations of common-service like storage, credentials, etc.
│ ├─create create SQL scripts directory │   │   ├── dolphinscheduler_env.sh script to load environment variables for alert-server
│ ├─upgrade upgrade SQL scripts directory │   │   └── logback-spring.xml configurations of alert-service log
│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script │   └── libs directory of alert-server libs
│ ├─dolphinscheduler_mysql.sql MySQL database init script │
│ ├─soft_version current DS version-id file ├── api-server directory of DolphinScheduler api-server commands, configrations scripts and libs
├─script DS services deployment, database create or upgrade scripts directory │   ├── bin
│ ├─create-dolphinscheduler.sh DS database init script │   │   └── start.sh script to start DolphinScheduler api-server
│ ├─upgrade-dolphinscheduler.sh DS database upgrade script │   ├── conf
│ ├─monitor-server.sh DS monitor-server start script │   │   ├── application.yaml configurations of api-server
│ ├─scp-hosts.sh transfer installation files script │   │   ├── common.properties configurations of common-service like storage, credentials, etc.
│ ├─remove-zk-node.sh cleanup ZooKeeper caches script │   │   ├── dolphinscheduler_env.sh script to load environment variables for api-server
├─ui front-end web resources directory │   │   └── logback-spring.xml configurations of api-service log
├─lib DS .jar dependencies directory │   ├── libs directory of api-server libs
├─install.sh auto-setup DS services script │   └── ui directory of api-server related front-end web resources
│
├── master-server directory of DolphinScheduler master-server commands, configrations scripts and libs
│   ├── bin
│   │   └── start.sh script to start DolphinScheduler master-server
│   ├── conf
│   │   ├── application.yaml configurations of master-server
│   │   ├── common.properties configurations of common-service like storage, credentials, etc.
│   │   ├── dolphinscheduler_env.sh script to load environment variables for master-server
│   │   └── logback-spring.xml configurations of master-service log
│   └── libs directory of master-server libs
│
├── standalone-server directory of DolphinScheduler standalone-server commands, configrations scripts and libs
│   ├── bin
│   │   └── start.sh script to start DolphinScheduler standalone-server
│   ├── conf
│   │   ├── application.yaml configurations of standalone-server
│   │   ├── common.properties configurations of common-service like storage, credentials, etc.
│   │   ├── dolphinscheduler_env.sh script to load environment variables for standalone-server
│   │   ├── logback-spring.xml configurations of standalone-service log
│   │   └── sql .sql files to create or upgrade DolphinScheduler metadata
│   ├── libs directory of standalone-server libs
│   └── ui directory of standalone-server related front-end web resources
│  
├── tools directory of DolphinScheduler metadata tools commands, configrations scripts and libs
│   ├── bin
│   │   └── upgrade-schema.sh script to initialize or upgrade DolphinScheduler metadata
│   ├── conf
│   │   ├── application.yaml configurations of tools
│   │   └── common.properties configurations of common-service like storage, credentials, etc.
│   ├── libs directory of tool libs
│   └── sql .sql files to create or upgrade DolphinScheduler metadata
│  
├── worker-server directory of DolphinScheduler worker-server commands, configrations scripts and libs
│ ├── bin
│ │   └── start.sh script to start DolphinScheduler worker-server
│ ├── conf
│ │   ├── application.yaml configurations of worker-server
│ │   ├── common.properties configurations of common-service like storage, credentials, etc.
│ │   ├── dolphinscheduler_env.sh script to load environment variables for worker-server
│ │   └── logback-spring.xml configurations of worker-service log
│ └── libs directory of worker-server libs
│
└── ui directory of front-end web resources
``` ```
## Configurations in Details ## Configurations in Details

124
docs/docs/zh/architecture/configuration.md
Unescape View File

@ -9,50 +9,90 @@
本文主要讲述dolphinscheduler的配置文件.其他部分先不做赘述. 本文主要讲述dolphinscheduler的配置文件.其他部分先不做赘述.
[注:以下 dolphinscheduler 简称为DS.] [注:以下 dolphinscheduler 简称为DS.]
```
├─bin DS命令存放目录
│ ├─dolphinscheduler-daemon.sh 启动/关闭DS服务脚本
│ ├─start-all.sh 根据配置文件启动所有DS服务
│ ├─stop-all.sh 根据配置文件关闭所有DS服务
├─conf 配置文件目录
│ ├─application-api.properties api服务配置文件
│ ├─datasource.properties 数据库配置文件
│ ├─zookeeper.properties zookeeper配置文件
│ ├─master.properties master服务配置文件
│ ├─worker.properties worker服务配置文件
│ ├─quartz.properties quartz服务配置文件
│ ├─common.properties 公共服务[存储]配置文件
│ ├─alert.properties alert服务配置文件
│ ├─config 环境变量配置文件夹
│ ├─install_config.conf DS环境变量配置脚本[用于DS安装/启动]
│ ├─env 运行脚本环境变量配置目录
│ ├─dolphinscheduler_env.sh 运行脚本加载环境变量配置文件[如: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
│ ├─org mybatis mapper文件目录
│ ├─i18n i18n配置文件目录
│ ├─logback-api.xml api服务日志配置文件
│ ├─logback-master.xml master服务日志配置文件
│ ├─logback-worker.xml worker服务日志配置文件
│ ├─logback-alert.xml alert服务日志配置文件
├─sql DS的元数据创建升级sql文件
│ ├─create 创建SQL脚本目录
│ ├─upgrade 升级SQL脚本目录
│ ├─dolphinscheduler_postgre.sql postgre数据库初始化脚本
│ ├─dolphinscheduler_mysql.sql mysql数据库初始化脚本
│ ├─soft_version 当前DS版本标识文件
├─script DS服务部署,数据库创建/升级脚本目录
│ ├─create-dolphinscheduler.sh DS数据库初始化脚本
│ ├─upgrade-dolphinscheduler.sh DS数据库升级脚本
│ ├─monitor-server.sh DS服务监控启动脚本
│ ├─scp-hosts.sh 安装文件传输脚本
│ ├─remove-zk-node.sh 清理zookeeper缓存文件脚本
├─ui 前端WEB资源目录
├─lib DS依赖的jar存放目录
├─install.sh 自动安装DS服务脚本
``` ```
├── LICENSE
│
├── NOTICE
│
├── licenses licenses存放目录
│
├── bin DolphinScheduler命令和环境变量配置存放目录
│   ├── dolphinscheduler-daemon.sh 启动/关闭DolphinScheduler服务脚本
│   ├── env 环境变量配置存放目录
│   │   ├── dolphinscheduler_env.sh 当使用`dolphinscheduler-daemon.sh`脚本起停服务时，运行此脚本加载环境变量配置文件 [如：JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
│   │   └── install_env.sh 当使用`install.sh` `start-all.sh` `stop-all.sh` `status-all.sh`脚本时，运行此脚本为DolphinScheduler安装加载环境变量配置
│   ├── install.sh 当使用`集群`模式或`伪集群`模式部署DolphinScheduler时，运行此脚本自动安装服务
│   ├── remove-zk-node.sh 清理zookeeper缓存文件脚本
│   ├── scp-hosts.sh 安装文件传输脚本
│   ├── start-all.sh 当使用`集群`模式或`伪集群`模式部署DolphinScheduler时，运行此脚本启动所有服务
│   ├── status-all.sh 当使用`集群`模式或`伪集群`模式部署DolphinScheduler时，运行此脚本获取所有服务状态
│   └── stop-all.sh 当使用`集群`模式或`伪集群`模式部署DolphinScheduler时，运行此脚本终止所有服务
│
├── alert-server DolphinScheduler alert-server命令、配置和依赖存放目录
│   ├── bin
│   │   └── start.sh DolphinScheduler alert-server启动脚本
│   ├── conf
│   │   ├── application.yaml alert-server配置文件
│   │   ├── common.properties 公共服务（存储等信息）配置文件
│   │   ├── dolphinscheduler_env.sh alert-server环境变量配置加载脚本
│   │   └── logback-spring.xml alert-service日志配置文件
│   └── libs alert-server依赖jar包存放目录
│
├── api-server DolphinScheduler api-server命令、配置和依赖存放目录
│   ├── bin
│   │   └── start.sh DolphinScheduler api-server启动脚本
│   ├── conf
│   │   ├── application.yaml api-server配置文件
│   │   ├── common.properties 公共服务（存储等信息）配置文件
│   │   ├── dolphinscheduler_env.sh api-server环境变量配置加载脚本
│   │   └── logback-spring.xml api-service日志配置文件
│   ├── libs api-server依赖jar包存放目录
│   └── ui api-server相关前端WEB资源存放目录
│
├── master-server DolphinScheduler master-server命令、配置和依赖存放目录
│   ├── bin
│   │   └── start.sh DolphinScheduler master-server启动脚本
│   ├── conf
│   │   ├── application.yaml master-server配置文件
│   │   ├── common.properties 公共服务（存储等信息）配置文件
│   │   ├── dolphinscheduler_env.sh master-server环境变量配置加载脚本
│   │   └── logback-spring.xml master-service日志配置文件
│   └── libs master-server依赖jar包存放目录
│
├── standalone-server DolphinScheduler standalone-server命令、配置和依赖存放目录
│   ├── bin
│   │   └── start.sh DolphinScheduler standalone-server启动脚本
│   ├── conf
│   │   ├── application.yaml standalone-server配置文件
│   │   ├── common.properties 公共服务（存储等信息）配置文件
│   │   ├── dolphinscheduler_env.sh standalone-server环境变量配置加载脚本
│   │   ├── logback-spring.xml standalone-service日志配置文件
│   │   └── sql DolphinScheduler元数据创建/升级sql文件
│   ├── libs standalone-server依赖jar包存放目录
│   └── ui standalone-server相关前端WEB资源存放目录
│  
├── tools DolphinScheduler元数据工具命令、配置和依赖存放目录
│   ├── bin
│   │   └── upgrade-schema.sh DolphinScheduler元数据创建/升级脚本
│   ├── conf
│   │   ├── application.yaml 元数据工具配置文件
│   │   └── common.properties 公共服务（存储等信息）配置文件
│   ├── libs 元数据工具依赖jar包存放目录
│   └── sql DolphinScheduler元数据创建/升级sql文件
│  
├── worker-server DolphinScheduler worker-server命令、配置和依赖存放目录
│ ├── bin
│ │   └── start.sh DolphinScheduler worker-server启动脚本
│ ├── conf
│ │   ├── application.yaml worker-server配置文件
│ │   ├── common.properties 公共服务（存储等信息）配置文件
│ │   ├── dolphinscheduler_env.sh worker-server环境变量配置加载脚本
│ │   └── logback-spring.xml worker-service日志配置文件
│ └── libs worker-server依赖jar包存放目录
│
└── ui 前端WEB资源目录
```
# 配置文件详解 # 配置文件详解

Write Preview
Loading…
Cancel
Save