Browse Source

[docs] Correct custom docker image in faq (#9939)

* [docs] Correct custom docker image in faq

* Correct the build command
* Correct English version of document

* remove Chinese document in En version
Jiajie Zhong 3 years ago
parent
commit
bb78ccb08e
2 changed files with 18 additions and 9 deletions
  1. 13 6
      docs/docs/en/faq.md
  2. 5 3
      docs/docs/zh/faq.md

+ 13 - 6
docs/docs/en/faq.md

@@ -706,20 +706,22 @@ 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 镜像
+## How to Build Custom Docker Image
 
-DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 docker hub 中找到这些镜像,如果你因为个性化需求想要自己打包 docker 镜像,最佳实践是基于 DolphinScheduler 对应镜像编写 Dockerfile 文件
+DolphinScheduler will release new Docker images after it released, you could find them in DockerHub. You could create
+custom Docker images base on those images if you want to change image like add some dependencies or upgrade package.
 
 ```Dockerfile
-FROM dolphinscheduler-standalone-server
+FROM apache/dolphinscheduler-standalone-server
 RUN apt update ; \
     apt install -y <YOUR-CUSTOM-DEPENDENCE> ; \
 ```
 
-如果你想基于源码进行改造,打包并分发你的镜像,可以在代码改造完成后运行
+If you want to modify DolphinScheduler source code, then build and distribute your own images, you can run below command
+to build Docker images and install them locally, which you could find them by command `docker imaegs`.
 
 ```shell
-./mvnw -B clean deploy \
+./mvnw -B clean install \
   -Dmaven.test.skip \
   -Dmaven.javadoc.skip \
   -Dmaven.checkstyle.skip \
@@ -728,12 +730,17 @@ RUN apt update ; \
   -Pdocker,release
 ```
 
-如果你不仅需要改造源码,还想要自定义 Docker 镜像打包的依赖,可以在修改源码的同时修改 Dockerfile 的定义,你可以在源码项目根目录中运行以下命令找到所有的 Dockerfile 文件
+If you want to modify DolphinScheduler source code, but also want to add customize dependencies of Docker image, you can
+modify the definition of Dockerfile after modifying the source code. You can run the following command in root source code
+directory to find all Dockerfile files.
 
 ```shell
 find . -iname 'Dockerfile'
 ```
 
+Then run the command above start with `./mvnw -B clean install`. You can see all docker images you just created with
+command `docker images` after finish commnand `mvnw`.
+
 ---
 
 ## We will collect more FAQ later

+ 5 - 3
docs/docs/zh/faq.md

@@ -688,7 +688,7 @@ update t_ds_version set version='2.0.1';
 如果您不想在 api server 启动的时候启动 Python gateway server,您可以修改 api server 中的配置文件 `api-server/conf/application.yaml`
 并更改可选项 `python-gateway.enabled` 中的值设置为 `false`。
 
-## 如构建自定义的 Docker 镜像
+## 如构建自定义的 Docker 镜像
 
 DolphinScheduler 每次发版都会同时发布 Docker 镜像,你可以在 docker hub 中找到这些镜像,如果你因为个性化需求想要自己打包 docker 镜像,最佳实践是基于 DolphinScheduler 对应镜像编写 Dockerfile 文件
 
@@ -698,10 +698,10 @@ RUN apt update ; \
     apt install -y <YOUR-CUSTOM-DEPENDENCE> ; \
 ```
 
-如果你想基于源码进行改造,打包并分发你的镜像,可以在代码改造完成后运行
+如果你想基于源码进行改造,打包并分发你的镜像,可以在代码改造完成后运行。当命令运行完了后你可以通过 `docker images` 命令查看刚刚创建的镜像
 
 ```shell
-./mvnw -B clean deploy \
+./mvnw -B clean install \
   -Dmaven.test.skip \
   -Dmaven.javadoc.skip \
   -Dmaven.checkstyle.skip \
@@ -716,4 +716,6 @@ RUN apt update ; \
 find . -iname 'Dockerfile'
 ```
 
+之后再运行上面的 `./mvnw -B clean install` 命令,当命令运行完成后,你可以通过命令 `docker images` 查看刚刚创建的 docker 镜像
+
 我们会持续收集更多的 FAQ。