diff --git a/docs/docs/deploy_guide/compile_deploy.md b/docs/docs/deploy_guide/compile_deploy.md index e78400d66f..166def04d0 100644 --- a/docs/docs/deploy_guide/compile_deploy.md +++ b/docs/docs/deploy_guide/compile_deploy.md @@ -6,9 +6,11 @@ title: 编译部署 --- :::tip 提示 -如果你只想部署 Dinky，可以跳过本章节，直接查看[常规部署](./normal_deploy)章节 +1. 如果你只想部署 Dinky，可以跳过本章节，直接查看[常规部署](./normal_deploy)章节 -如果你想对 Dinky 做二次开发，参考[本地调试](../developer_guide/local_debug)章节,从而搭建开发环境。开发完成之后，再参考本章节，进行编译。 +2. 如果你想对 Dinky 做二次开发，参考[本地调试](../developer_guide/local_debug)章节,从而搭建开发环境。开发完成之后，再参考本章节，进行编译。 + +3. 自 Dinky v1.0.0 版本开始，Dinky 在打包时仅支持单个版本的打包方式,即: 你只能选择一个 Flink 版本进行打包,而不能同时打包多个版本。 ::: @@ -45,17 +47,14 @@ Clone 完成后, 等待 IDEA 自动下载依赖(前提 IDEA 已经正确配置 请注意: 有关于各个 Profile 的详细介绍,请查看 [Profile 说明](../developer_guide/local_debug#Profile-说明) ::: -- 全版本 Profile -![localdebug_package_all_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_package_all_profile.png) +- 打包 Profile -- 单版本 Profile +> 注意: 需要勾选 web,否则无法打包前端资源 ![locadenug_single_package_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/locadenug_single_package_profile.png) -- 非全版本 Profile 多选 -![localdebug_not_all_profile_package](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_not_all_profile_package.png) :::danger 注意 @@ -94,14 +93,9 @@ git clone https://github.com/DataLinkDC/dinky.git ```bash cd /opt/dinky-source-code -# 全版本 Profile, 注意 scala 支持 2.11 和 2.12, 请根据实际情况进行选择,jdk 支持 8/11,请根据实际情况进行选择 -mvn -DskipTests=true clean package -P prod,flink-all,jdk11,scala-2.12,aliyun,!dev,!flink-single-version,!jdk-1.8 - -# 单个版本 Profile, 注意 scala 支持 2.11 和 2.12, 请根据实际情况进行选择,jdk 支持 8/11,请根据实际情况进行选择 -mvn clean package -DskipTests=true -P prod,jdk11,flink-single-version,scala-2.12,aliyun,flink-1.16,!dev,!jdk-1.8 +# 编译打包 Profile, 注意 scala 支持 2.11 和 2.12, 请根据实际情况进行选择,jdk 支持 8/11,请根据实际情况进行选择,不选jdk11默认使用系统内的jdk8 +mvn clean package -DskipTests=true -Pprod,jdk11,flink-single-version,scala-2.12,aliyun,flink-1.16,web -# 非全版本 Profile 多选,注意 scala 支持 2.11 和 2.12, 请根据实际情况进行选择,jdk 支持 8/11,请根据实际情况进行选择 -mvn -DskipTests=true clean package -P flink-1.18,flink-1.17,prod,jdk11,flink-single-version,scala-2.12,aliyun,!dev,!jdk-1.8 ``` :::danger 注意 diff --git a/docs/docs/deploy_guide/docker_deploy.md b/docs/docs/deploy_guide/docker_deploy.md index a0bb8256f9..9d0485da5c 100644 --- a/docs/docs/deploy_guide/docker_deploy.md +++ b/docs/docs/deploy_guide/docker_deploy.md @@ -5,6 +5,13 @@ id: docker_deploy title: Docker 部署 --- +:::danger 注意 + +Dinky v1.0.0 的 Docker 镜像正在开发中，敬请期待。以下步骤目前由于镜像未发布，无法使用。请耐心等待。如您对 Docker 镜像有兴趣，欢迎加入我们的开发群，一起参与开发。 + +::: + + ## Docker 快速使用教程 本教程使用三种不同的方式通过 Docker 完成 Dinky 的部署，如果你想要快速体验，推荐使用 standalone-server 镜像， 如果你想要体验比较完整的服务，推荐使用 docker-compose 启动服务。如果你已经有自己的数据库服务 你想要沿用这些基础服务，你可以参考沿用已有的 Mysql 、 Hadoop 和 Flink 服务完成部署。 diff --git a/docs/docs/developer_guide/local_debug.md b/docs/docs/developer_guide/local_debug.md index 6ce1e28f81..b360dc2897 100644 --- a/docs/docs/developer_guide/local_debug.md +++ b/docs/docs/developer_guide/local_debug.md @@ -8,10 +8,11 @@ title: 本地调试 :::tip 前置知识: + - Flink, Java, Maven, Node, React, Ant Design Pro - MySQL/PostgreSQL/H2 - IntelliJ IDEA -::: + ::: ## 前置条件 @@ -90,33 +91,34 @@ npm run dev 由于目前 Dinky 各个模块未发布到 Maven 中央仓库，所以需要先进行 Install 编译。从而在本地仓库中生成相应的依赖。 -如果你是第一次编译 Dinky，那么请勾选以下 Maven Profile,然后双击下图中的`生命周期 -> Install`进行编译。如果在 Install/Package 过程中报错代码格式化问题,请参考 [代码格式化](contribution/code_format)章节 +如果你是第一次编译 Dinky，那么请勾选以下 Maven Profile,然后双击下图中的`生命周期 -> Install`进行编译。如果在 +Install/Package 过程中报错代码格式化问题,请参考 [代码格式化](contribution/code_format)章节 ::: ![localdebug_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_profile.png) ### Profile 说明 -| Profile | 说明 | -|:-------------:|:-------------------------------------------------------------------------------------------------------------------------:| -| dev | 开发环境/本地调试，默认不选中,此功能主要用于本地调试或者二次开发,用于加载相关依赖 | -| aliyun | 加速依赖下载 | -| fast | 主要用于跳过代码检查和代码格式化
注意:如果 JDK 环境为 1.8/8 需要勾选此 profile,否则会报错
如果 JDK 环境为 11 无需勾选 | -| flink-1.14 | 用于指定 Flink 版本为 1.14,dev 下只能单选,prod 下可以多选,如需单独勾选此版本，需要勾选 flink-single-version | -| flink-1.15 | 用于指定 Flink 版本为 1.15,dev 下只能单选,prod 下可以多选,如需单独勾选此版本，需要勾选 flink-single-version | -| flink-1.16 | 用于指定 Flink 版本为 1.16,dev 下只能单选,prod 下可以多选,如需单独勾选此版本，需要勾选 flink-single-version | -| flink-1.17 | 用于指定 Flink 版本为 1.17,dev 下只能单选,prod 下可以多选,如需单独勾选此版本，需要勾选 flink-single-version | -| flink-1.18 | 用于指定 Flink 版本为 1.18,dev 下只能单选,prod 下可以多选,如需单独勾选此版本，需要勾选 flink-single-version | -| jdk 11 | 用于指定 JDK 版本为 11,前提是本地已经安装了 JDK 11 | -| mac | 用于适配在 mac 系统上进行调试 | -| maven-central | 用于指定 maven 仓库为中央仓库 | -| prod | 生产环境，默认选中,此功能主要用于编译打包,此 profile 会将部分依赖排除掉,不会打进最终 tar.gz 包内 | -| scala-2.11 | 用于指定 Scala 版本为 2.11,只能单选 | -| scala-2.12 | 用于指定 Scala 版本为 2.12,只能单选 | -| web | 默认情况下不勾选,同样会进行打包,此种方式适用于前后端不分离场景
如需前后端分离部署,请勾选此 profile ,会将前端编译产物打包进最终的 tar.gz 包内,目录为 html ,分离后如需 Nginx 代理,请在配置文件自行配置 | - +| Profile | 说明 | +|:-------------:|:----------------------------------------------------------------------------------:| +| dev | 开发环境/本地调试，默认不选中,此功能主要用于本地调试或者二次开发,用于加载相关依赖 | +| aliyun | 加速依赖下载 | +| fast | 主要用于跳过代码检查和代码格式化
注意:如果 JDK 环境为 jdk8 需要勾选此 profile,否则会报错
如果 JDK 环境为 11 无需勾选 | +| flink-1.14 | 用于指定 Flink 版本为 1.14,只能单选,需要勾选 flink-single-version | +| flink-1.15 | 用于指定 Flink 版本为 1.15,只能单选,需要勾选 flink-single-version | +| flink-1.16 | 用于指定 Flink 版本为 1.16,只能单选,需要勾选 flink-single-version | +| flink-1.17 | 用于指定 Flink 版本为 1.17,只能单选,需要勾选 flink-single-version | +| flink-1.18 | 用于指定 Flink 版本为 1.18,只能单选,需要勾选 flink-single-version | +| jdk 11 | 用于指定 JDK 版本为 11,前提是本地已经安装了 JDK 11,如果没有安装 jdk11,则默认使用本地的 jdk8 | +| mac | 用于适配在 mac 系统上进行调试 | +| maven-central | 用于指定 maven 仓库为中央仓库 | +| prod | 生产环境，默认选中,此功能主要用于编译打包,此 profile 会将部分依赖排除掉,不会打进最终 tar.gz 包内 | +| scala-2.11 | 用于指定 Scala 版本为 2.11,只能单选 | +| scala-2.12 | 用于指定 Scala 版本为 2.12,只能单选 | +| web | 打包前端资源,需要勾选 | :::warning 注意 + - 其他差异化配置为自己的 Maven 的 settings.xml 文件中的 profile 配置,请忽略 - 如果无JDK11环境, 默认使用JDK8,如果需要使用JDK11,请在IDEA中配置JDK11环境 - 注意 Profile 之间的冲突,如 flink-1.14 和 flink-1.15 不能同时勾选,否则会报错 @@ -137,32 +139,23 @@ Dinky开发环境配置有两种模式，分别是 provided 环境和 compile ### 打包部署 Profile -#### 全版本 Profile - -![localdebug_package_all_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_package_all_profile.png) - -#### 单版本 Profile - ![locadenug_single_package_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/locadenug_single_package_profile.png) -### 非全版本 Profile 多选 - -![localdebug_not_all_profile_package](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_not_all_profile_package.png) - ## Dinky 本地开发环境搭建 ### 分支选择 开发不同的代码需要不同的分支 -- 如果要基于二进制包进行开发，需要切换到对应的分支代码，如 `0.7` 分支； +- 如果要基于二进制包进行开发，需要切换到对应的分支代码，如 `realease-1.0.0` 分支； - 如果想要开发新代码，切换到dev分支即可； 下面说明在启动前如何修改相应的代码，为本地启动做准备。修改 ### 修改配置文件 -> 以 MySQL 为例, 如果使用 PostgreSQL/H2 请自行修改,注意: 使用 H2 数据库时无需修改如下配置,直接进行 [启动后端服务](#启动后端服务) +> 以 MySQL 为例, 如果使用 PostgreSQL/H2 请自行修改,注意: 使用 H2 +> 数据库时无需修改如下配置,直接进行 [启动后端服务](#启动后端服务) - 修改 dinky-admin/src/main/resources/application-mysql.yml 文件,配置相应的数据库连接信息 @@ -214,7 +207,6 @@ spring: 注意: 默认用户名/密码为 admin/admin ::: - :::tip 说明 以上内容是 Dinky 在 IDEA 本地环境搭建步骤，并简单介绍了如何在本地配置/启动 Dinky。在了解上述步骤后，可以动手改造 Dinky。