diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js index d8d03806d1..d195e15fd1 100644 --- a/docs/configs/docsdev.js +++ b/docs/configs/docsdev.js @@ -386,6 +386,15 @@ export default { title: 'Kubernetes Deployment', link: '/en-us/docs/dev/user_doc/guide/installation/kubernetes.html', }, + { + title: 'integration', + children: [ + { + title: 'Rainbond Deployment', + link: '/en-us/docs/dev/user_doc/guide/integration/rainbond.html', + }, + ], + }, ], }, { @@ -965,6 +974,15 @@ export default { title: 'Kubernetes部署(Kubernetes)', link: '/zh-cn/docs/dev/user_doc/guide/installation/kubernetes.html', }, + { + title: '集成', + children: [ + { + title: '基于Rainbond部署(Cluster)', + link: '/zh-cn/docs/dev/user_doc/guide/integration/rainbond.html', + }, + ], + }, ], }, { diff --git a/docs/docs/en/guide/integration/rainbond.md b/docs/docs/en/guide/integration/rainbond.md new file mode 100644 index 0000000000..32b71f217d --- /dev/null +++ b/docs/docs/en/guide/integration/rainbond.md @@ -0,0 +1,64 @@ +# Use Rainbond Deployment + +This section describes the one-click deployment of high availability DolphinScheduler clusters through the [Rainbond](https://www.rainbond.com/) cloud native application management platform. This method is suitable for users who don't know much about complex technologies such as `Kubernetes`, lowering the threshold for deploying DolphinScheduler in `Kubernetes` mode. + +## Prerequisites + +* Available Rainbond cloud native application management platform is a prerequisite，please refer to the official `Rainbond` documentation [Rainbond Quick install](https://www.rainbond.com/docs/quick-start/quick-install) + +## DolphinScheduler Cluster One-click Deployment + +* Logging in and accessing the built-in open source app store, search the keyword `dolphinscheduler` to find the DolphinScheduler App. + +![](../../../../img/rainbond/appstore-dolphinscheduler.png) + +* Click `install` on the right side of DolphinScheduler to go to the installation page. Fill in the corresponding information and click `OK` to start the installation. You will get automatically redirected to the application view. + +| Select item | Description | +| ------------ | ------------------------------------ | +| Team name | user workspace，Isolate by namespace | +| Cluster name | select kubernetes cluster | +| Select app | select application | +| app version | select DolphinScheduler version | + +![](../../../../img/rainbond/install-dolphinscheduler.png) + +* Wait a few minutes, the installation completes and `DolphinScheduler` will be running. + +![](../../../../img/rainbond/topology-dolphinscheduler.png) + +* Access DolphinScheduler-API components and the default user credentials are `admin` / `dolphinscheduler123`. + +![](../../../../img/rainbond/homepage-dolphinscheduler.png) + +## API Master Worker Node Telescopic + +DolphinScheduler API、Master、Worker all support scaling multiple instances, ensuring the high availability of the entire service. + +Take `worker` as an example: enter the `component -> Telescopic` page, and set the number of instances. + +![](../../../../img/rainbond/dolpscheduler-worker.png) + +To verify `worker` node, enter `DolphinScheduler UI -> Monitoring -> Worker` page to view detailed node information. + +![](../../../../img/rainbond/monitor-dolphinscheduler.png) +## Configuration file + +API and Worker Services share the configuration file `/opt/dolphinscheduler/conf/common.properties`. To modify the configurations, you only need to modify that of the API service. + +## How to support Python 3？ + +Worker service is installed with default `Python3`，you can add environment variables `PYTHON_HOME=/usr/bin/python3` + +## How to support Hadoop, Spark, DataX ？ + +Take `DataX` as an example: + +1. Install the plugin。Rainbond Team View -> Plugin -> Install plugin from the App Store -> search `initialization plugin` Install. +2. Open plugin.enter Worker component -> plugin -> open `initialization plugin` and modify the configuration. + * FILE_URL：http://datax-opensource.oss-cn-hangzhou.aliyuncs.com/datax.tar.gz + * FILE_PATH：/opt/soft + * LOCK_PATH：/opt/soft +3. Update component, the plug-in `Datax` will be downloaded automatically and decompress to `/opt/soft` +![](../../../../img/rainbond/plugin.png) +--- diff --git a/docs/docs/zh/guide/integration/rainbond.md b/docs/docs/zh/guide/integration/rainbond.md new file mode 100644 index 0000000000..6c39638590 --- /dev/null +++ b/docs/docs/zh/guide/integration/rainbond.md @@ -0,0 +1,65 @@ +# 基于 Rainbond 部署 DolphinScheduler 高可用集群 + +本文描述通过 [Rainbond](https://www.rainbond.com/) 云原生应用管理平台 一键部署高可用的 DolphinScheduler 集群，这种方式适合给不太了解 Kubernetes、容器化等复杂技术的用户使用，降低了在 Kubernetes 中部署 DolphinScheduler 的门槛。 + +## 前提条件 + +* 可用的 Rainbond 云原生应用管理平台，请参阅文档 [Rainbond 快速安装](https://www.rainbond.com/docs/quick-start/quick-install) + +## DolphinScheduler 集群一键部署 + +* 对接并访问内置的开源应用商店，搜索关键词 `dolphinscheduler` 即可找到 DolphinScheduler 应用。 + +![](../../../../img/rainbond/appstore-dolphinscheduler.png) + +* 点击 DolphinScheduler 右侧的 `安装` 进入安装页面，填写对应的信息，点击确定即可开始安装，自动跳转至应用视图。 + +| 选择项 | 说明 | +| -------- | ------------------------------------------------------------ | +| 团队名称 | 用户自建的工作空间，以命名空间隔离 | +| 集群名称 | 选择 DolphinScheduler 被部署到哪一个 K8s 集群 | +| 选择应用 | 选择 DolphinScheduler 被部署到哪一个应用，应用中包含有若干有关联的组件 | +| 应用版本 | 选择 DolphinScheduler 的版本，目前可选版本为 3.0.0-beta2 | + +![](../../../../img/rainbond/install-dolphinscheduler.png) + +* 等待几分钟后，DolphinScheduler 集群就会安装完成，并运行起来。 + +![](../../../../img/rainbond/topology-dolphinscheduler.png) + +* 点击访问，将访问 DolphinScheduler-API 组件，默认的用户密码是`admin` / `dolphinscheduler123` + +![](../../../../img/rainbond/homepage-dolphinscheduler.png) + +## API Master Worker 节点伸缩 + +DolphinScheduler API、Master、Worker 都支持伸缩多个实例，多个实例可以保证整个集群的高可用性。 + +以 Worker 为例，进入组件内 -> 伸缩，设置实例数量。 + +![](../../../../img/rainbond/dolpscheduler-worker.png) + +验证 Worker 节点，进入 DolphinScheduler UI -> 监控中心 -> Worker 查看节点信息。 + +![](../../../../img/rainbond/monitor-dolphinscheduler.png) + +## 配置文件 + +API 和 Worker 服务共用 `/opt/dolphinscheduler/conf/common.properties` ，修改配置时只需修改 API 服务的配置文件。 + +## 如何支持 Python 3？ + +Worker 服务默认安装了 Python3，使用时可以添加环境变量 `PYTHON_HOME=/usr/bin/python3` + +## 如何支持 Hadoop, Spark, DataX 等？ + +以 Datax 为例： + +1. 安装插件。Rainbond 团队视图 -> 插件 -> 从应用商店安装插件 -> 搜索 `通用数据初始化插件` 并安装。 +2. 开通插件。进入 Worker 组件内 -> 插件 -> 开通 `通用数据初始化插件` ，并修改配置 + * FILE_URL：http://datax-opensource.oss-cn-hangzhou.aliyuncs.com/datax.tar.gz + * FILE_PATH：/opt/soft + * LOCK_PATH：/opt/soft +3. 更新组件，初始化插件会自动下载 `Datax` 并解压到 `/opt/soft`目录下。 +![](../../../../img/rainbond/plugin.png) +--- diff --git a/docs/img/rainbond/appstore-dolphinscheduler.png b/docs/img/rainbond/appstore-dolphinscheduler.png new file mode 100644 index 0000000000..aa360f1f04 Binary files /dev/null and b/docs/img/rainbond/appstore-dolphinscheduler.png differ diff --git a/docs/img/rainbond/dolpscheduler-worker.png b/docs/img/rainbond/dolpscheduler-worker.png new file mode 100644 index 0000000000..c39b7bb8ce Binary files /dev/null and b/docs/img/rainbond/dolpscheduler-worker.png differ diff --git a/docs/img/rainbond/homepage-dolphinscheduler.png b/docs/img/rainbond/homepage-dolphinscheduler.png new file mode 100644 index 0000000000..8e97055d75 Binary files /dev/null and b/docs/img/rainbond/homepage-dolphinscheduler.png differ diff --git a/docs/img/rainbond/install-dolphinscheduler.png b/docs/img/rainbond/install-dolphinscheduler.png new file mode 100644 index 0000000000..4b530d3328 Binary files /dev/null and b/docs/img/rainbond/install-dolphinscheduler.png differ diff --git a/docs/img/rainbond/monitor-dolphinscheduler.png b/docs/img/rainbond/monitor-dolphinscheduler.png new file mode 100644 index 0000000000..333fc251e4 Binary files /dev/null and b/docs/img/rainbond/monitor-dolphinscheduler.png differ diff --git a/docs/img/rainbond/plugin.png b/docs/img/rainbond/plugin.png new file mode 100644 index 0000000000..3a391b11e9 Binary files /dev/null and b/docs/img/rainbond/plugin.png differ diff --git a/docs/img/rainbond/topology-dolphinscheduler.png b/docs/img/rainbond/topology-dolphinscheduler.png new file mode 100644 index 0000000000..f2970fe872 Binary files /dev/null and b/docs/img/rainbond/topology-dolphinscheduler.png differ