未验证 提交 136a1830 编写于 作者: J Jiajie Zhong 提交者: GitHub

[doc] Separate and correct getting start by docker (#9862)

* [doc] Separate and correct getting start by docker

* Correct content of starting docker
* Remove all FAQ in docker.md and only keep
  build image by users themself in faq.md
* Separate how to use incompatible incompatible
  datasource from docker.md to directory datasource

* correct disable flag

* fix download link

* fix wrong anchor

* remove not support anchor for zh docs
上级 b1bb69c9
......@@ -706,6 +706,34 @@ After version 3.0.0-alpha, Python gateway server integrate into API server, and
start API server. If you want disabled when Python gateway service you could change API server configuration in path
`api-server/conf/application.yaml` and change attribute `python-gateway.enabled : false`.
## 如果构建自定义的 Docker 镜像
DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 docker hub 中找到这些镜像,如果你因为个性化需求想要自己打包 docker 镜像,最佳实践是基于 DolphinScheduler 对应镜像编写 Dockerfile 文件
```Dockerfile
FROM dolphinscheduler-standalone-server
RUN apt update ; \
apt install -y <YOUR-CUSTOM-DEPENDENCE> ; \
```
如果你想基于源码进行改造,打包并分发你的镜像,可以在代码改造完成后运行
```shell
./mvnw -B clean deploy \
-Dmaven.test.skip \
-Dmaven.javadoc.skip \
-Dmaven.checkstyle.skip \
-Dmaven.deploy.skip \
-Ddocker.tag=latest \
-Pdocker,release
```
如果你不仅需要改造源码,还想要自定义 Docker 镜像打包的依赖,可以在修改源码的同时修改 Dockerfile 的定义,你可以在源码项目根目录中运行以下命令找到所有的 Dockerfile 文件
```shell
find . -iname 'Dockerfile'
```
---
## We will collect more FAQ later
\ No newline at end of file
......@@ -37,3 +37,7 @@ login.user.keytab.username=hdfs-mycluster@ESZ.COM
# login user from keytab path
login.user.keytab.path=/opt/hdfs.headless.keytab
```
## Native Supported
Yes, could use this datasource by default.
......@@ -2,5 +2,23 @@
DataSource supports MySQL, PostgreSQL, Hive/Impala, Spark, ClickHouse, Oracle, SQL Server and other DataSources.
- Click "Data Source Center -> Create Data Source" to create different types of DataSources according to requirements.
- Click "Test Connection" to test whether the DataSource can connect successfully.
\ No newline at end of file
- Click bottom "Data Source Center -> Create Data Source" to create a new datasource.
- Click "Test Connection" to test whether the DataSource can connect successfully(datasource can be saved only if passed the
connection test).
## Using datasource incompatible to Apache LICENSE V2 LICENSE
Some of datasource are native supported to DolphinScheduler while others need users download JDBC driver package manually,
because those JDBC driver incompatible to Apache LICENSE V2 LICENSE. For this reason we have to release DolphinScheduler's
distribute package without those packages, even if this will make more complicated for users. Datasource such as MySQL,
Oracle, SQL Server as the examples, but we have the solution to solve this
### Example
For example, if you want to use MySQL datasource, you need to download the correct JDBC driver from [mysql maven repository](https://repo1.maven.org/maven2/mysql/mysql-connector-java),
and move it into directory `api-server/libs` and `worker-server/libs`. After that, you could activate MySQL datasource by
restarting `api-server` and `worker-server`. Mount to container volume in the same path and restart it if you use container
like Docker.
> Note: If you only want to use MySQL in the datasource center, there is no requirement for the version of MySQL JDBC driver.
> But if you want to use MySQL as the metabase of DolphinScheduler, it only supports [8.0.16 and above](https:/ /repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.16/mysql-connector-java-8.0.16.jar) version.
......@@ -12,3 +12,7 @@
- Database name: enter the database name of the MYSQL connection
- Jdbc connection parameters: parameter settings for MYSQL connection, in JSON format
## Native Supported
No, read section example in [introduction](introduction.md) to activate this datasource.
......@@ -11,3 +11,7 @@
- Password: set the password for PostgreSQL connection
- Database name: enter the database name of the PostgreSQL connection
- Jdbc connection parameters: parameter settings for PostgreSQL connection, in JSON format
## Native Supported
Yes, could use this datasource by default.
......@@ -11,3 +11,7 @@
- Password: set the password for Spark connection
- Database name: enter the database name of the Spark connection
- Jdbc connection parameters: parameter settings for Spark connection, in JSON format
## Native Supported
Yes, could use this datasource by default.
此差异已折叠。
......@@ -682,4 +682,38 @@ update t_ds_version set version='2.0.1';
---
## 在二进制分发包中找不到 python-gateway-server 文件夹
在 3.0.0-alpha 版本之后,Python gateway server 集成到 api server 中,当您启动 api server 后,Python gateway server 将启动。
如果您不想在 api server 启动的时候启动 Python gateway server,您可以修改 api server 中的配置文件 `api-server/conf/application.yaml`
并更改可选项 `python-gateway.enabled` 中的值设置为 `false`
## 如果构建自定义的 Docker 镜像
DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 docker hub 中找到这些镜像,如果你因为个性化需求想要自己打包 docker 镜像,最佳实践是基于 DolphinScheduler 对应镜像编写 Dockerfile 文件
```Dockerfile
FROM dolphinscheduler-standalone-server
RUN apt update ; \
apt install -y <YOUR-CUSTOM-DEPENDENCE> ; \
```
如果你想基于源码进行改造,打包并分发你的镜像,可以在代码改造完成后运行
```shell
./mvnw -B clean deploy \
-Dmaven.test.skip \
-Dmaven.javadoc.skip \
-Dmaven.checkstyle.skip \
-Dmaven.deploy.skip \
-Ddocker.tag=latest \
-Pdocker,release
```
如果你不仅需要改造源码,还想要自定义 Docker 镜像打包的依赖,可以在修改源码的同时修改 Dockerfile 的定义,你可以在源码项目根目录中运行以下命令找到所有的 Dockerfile 文件
```shell
find . -iname 'Dockerfile'
```
我们会持续收集更多的 FAQ。
\ No newline at end of file
......@@ -38,3 +38,6 @@ login.user.keytab.username=hdfs-mycluster@ESZ.COM
login.user.keytab.path=/opt/hdfs.headless.keytab
```
## 是否原生支持
是,数据源不需要任务附加操作即可使用。
......@@ -2,5 +2,20 @@
数据源中心支持MySQL、POSTGRESQL、HIVE/IMPALA、SPARK、CLICKHOUSE、ORACLE、SQLSERVER等数据源。
- 点击“数据源中心->创建数据源”,根据需求创建不同类型的数据源。
- 点击“测试连接”,测试数据源是否可以连接成功。
\ No newline at end of file
- 点击"数据源中心->创建数据源",根据需求创建不同类型的数据源
- 点击"测试连接",测试数据源是否可以连接成功(只有当数据源通过连接性测试后才能保存数据源)。
## 使用不兼容 Apache LICENSE V2 许可的数据库
数据源中心里,DolphinScheduler 对部分数据源有原生的支持,但是部分数据源需要用户下载对应的 JDBC 驱动包并放置到正确的位置才能正常使用。
这对用户会增加用户的使用成本,但是我们不得不这么做,因为这部分数据源的 JDBC 驱动和 Apache LICENSE V2 不兼容,所以我们无法在
DolphinScheduler 分发的二进制包中包含他们。这部分数据源主要包括 MySQL,Oracle,SQL Server 等,幸运的是我们为这部分数据源的支持给出了解决方案。
### 样例
我们以 MySQL 为例,如果你想要使用 MySQL 数据源,你需要先在 [mysql maven 仓库](https://repo1.maven.org/maven2/mysql/mysql-connector-java)
中下载对应版本的 JDBC 驱动,将其移入 `api-server/libs` 以及 `worker-server/libs` 文件夹中,最后重启 `api-server``worker-server`
服务,即可使用 MySQL 数据源。如果你使用容器启动 DolphinScheduler,同样也是将 JDBC 驱动挂载放到以上两个服务的对应路径下后,重启驱动即可。
> 注意:如果你只是想要在数据源中心使用 MySQL,则对 MySQL JDBC 驱动的版本没有要求,如果你想要将 MySQL 作为 DolphinScheduler 的元数据库,
> 则仅支持 [8.0.16 及以上](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.16/mysql-connector-java-8.0.16.jar)的版本。
......@@ -11,3 +11,7 @@
- 密码:设置连接 MySQL 的密码
- 数据库名:输入连接 MySQL 的数据库名称
- Jdbc 连接参数:用于 MySQL 连接的参数设置,以 JSON 形式填写
## 是否原生支持
否,使用前需请参考[简介](introduction.md)中的 "样例" 章节激活数据源。
......@@ -11,3 +11,7 @@
- 密码:设置连接 POSTGRESQL 的密码
- 数据库名:输入连接 POSTGRESQL 的数据库名称
- Jdbc 连接参数:用于 POSTGRESQL 连接的参数设置,以 JSON 形式填写
## 是否原生支持
是,数据源不需要任务附加操作即可使用。
......@@ -17,3 +17,7 @@
<p align="center">
<img src="/img/sparksql_kerberos.png" width="80%" />
</p>
## 是否原生支持
是,数据源不需要任务附加操作即可使用。
此差异已折叠。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册