zhongjiajie commented on a change in pull request #749: URL: https://github.com/apache/dolphinscheduler-website/pull/749#discussion_r840583562
########## File path: docs/en-us/dev/user_doc/guide/start/docker.md ########## @@ -0,0 +1,1024 @@ +# Quick Trial Docker Deployment + +## Pre-conditions + + - [Docker](https://docs.docker.com/engine/install/) 1.13.1+ + - [Docker Compose](https://docs.docker.com/compose/) 1.11.0+ + +## How to use docker image? + +There are 3 ways to quickly try DolphinScheduler. + +### I. Start DolphinScheduler as docker-compose (recommended) + +This method requires the installation of [docker-compose](https://docs.docker.com/compose/). The installation of docker-compose is widely available online, so please install it yourself. + +For Windows 7-10 versions, you can install [Docker Toolbox](https://github.com/docker/toolbox/releases). For Windows 10 64-bit, you can install [Docker Desktop](https://docs.docker.com/docker-for-windows/install/) and note the [system requirements](https://docs.docker.com/ docker-for-windows/install/#system-requirements). + +#### 0. Please allocate at least 4GB of memory + +For Mac users, click on `Docker Desktop -> Preferences -> Resources -> Memory`. + +For Windows Docker Toolbox users, there are two items that need to be configured. + +- **Memory**: Open Oracle VirtualBox Manager and if you double click on Docker Quickstart Terminal and run Docker Toolbox successfully, you will see a virtual machine named `default`. Click on `Settings -> System -> Motherboard -> Memory Size`. +- **Port Forwarding**: Click `Settings -> Network -> Advanced -> Port Forwarding -> Add`. `Name`, fill in `12345` for both `Host Port` and `Subsystem Port`, leave out the `Host IP` and `Subsystem IP`. + +For Windows Docker Desktop users. +- **Hyper-V Mode**: Click `Docker Desktop -> Settings -> Resources -> Memory` +- **WSL 2 Mode**: Reference [WSL 2 utility VM](https://docs.microsoft.com/zh-cn/windows/wsl/wsl-config#configure-global-options-with-wslconfig) + +#### 1.Download the source code package + +Please download the source package apache-dolphinscheduler-x.x.x-src.tar.gz from: [download](/en-us/download/download.html) + +#### 2.Pull the image and start the service + +> For Mac and Linux user, open **Terminal** +> For Windows Docker Toolbox user, open **Docker Quickstart Terminal** +> For Windows Docker Desktop user, open **Windows PowerShell** + +``` +$ tar -zxvf apache-dolphinscheduler-1.3.8-src.tar.gz +$ cd apache-dolphinscheduler-1.3.8-src/docker/docker-swarm +$ docker pull dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler:1.3.8 +$ docker tag apache/dolphinscheduler:1.3.8 apache/dolphinscheduler:latest +$ docker-compose up -d +``` +> PowerShell should use `cd apache-dolphinscheduler-1.3.8-src\docker\docker-swarm` + +**PostgreSQL** (user `root`, password `root`, database `dolphinscheduler`) and **ZooKeeper** services will be started by default + +#### 3.Login system + +To access the front-end page: http://localhost:12345/dolphinscheduler, please change to the corresponding IP address if necessary + +The default user is `admin` and the default password is `dolphinscheduler123`. + + + +Please refer to the user manual chapter [Quick Start] (... /start/quick-start.md) to see how to use DolphinScheduler. + +### II. By specifying the existing PostgreSQL and ZooKeeper services + +This method requires the installation of [docker](https://docs.docker.com/engine/install/). The installation of docker is well documented on the web, so please install it yourself. + +#### 1.Basic software installation (please install it yourself) + + - [PostgreSQL](https://www.postgresql.org/download/) (8.2.15+) + - [ZooKeeper](https://zookeeper.apache.org/releases.html) (3.4.6+) + - [Docker](https://docs.docker.com/engine/install/) (1.13.1+) + +#### 2. Please login to the PostgreSQL database and create a database named `dolphinscheduler`. + +#### 3. Initialize the database and import `sql/dolphinscheduler_postgre.sql` to create tables and import the base data + +#### 4. Download the DolphinScheduler image + +We have uploaded the DolphinScheduler images for users to the docker repository. Instead of building the image locally, users can pull the image from the docker repository by running the following command. + +``` +docker pull dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler:1.3.8 +``` + +#### 5. Run a DolphinScheduler instance + +``` +$ docker run -d --name dolphinscheduler \ +-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \ +-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \ +-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \ +-p 12345:12345 \ +apache/dolphinscheduler:1.3.8 all +``` + +Note: The database user test and password test need to be replaced with the actual PostgreSQL user and password. 192.168.x.x needs to be replaced with the host IP of PostgreSQL and ZooKeeper. + +#### 6. Login system + +As above. + +### III. Running a standalone service in DolphinScheduler + +When the container is started, the following services are automatically started. + +``` + MasterServer ----- master service + WorkerServer ----- worker service + ApiApplicationServer ----- api service + AlertServer ----- alert service +``` + +If you just want to run some of the services in dolphinscheduler. You can run some of the services in dolphinscheduler by executing the following command. + +* Start a **master server**, as follows: + +``` +$ docker run -d --name dolphinscheduler-master \ +-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \ +-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \ +-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \ +apache/dolphinscheduler:1.3.8 master-server +``` + +* Start a **worker server**, as follows: + +``` +$ docker run -d --name dolphinscheduler-worker \ +-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \ +-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \ +-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \ +apache/dolphinscheduler:1.3.8 worker-server +``` + +* Start a **api server**, as follows: + +``` +$ docker run -d --name dolphinscheduler-api \ +-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \ +-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \ +-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \ +-p 12345:12345 \ +apache/dolphinscheduler:1.3.8 api-server +``` + +* Start a **alter server**, as follows: + +``` +$ docker run -d --name dolphinscheduler-alert \ +-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \ +-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \ +apache/dolphinscheduler:1.3.8 alert-server +``` + +**NOTE**: When you run some of the services in dolphinscheduler, you must specify these environment variables `DATABASE_HOST`, `DATABASE_PORT`, `DATABASE_DATABASE`, `DATABASE_USERNAME`, `DATABASE_ PASSWORD`, `ZOOKEEPER_QUORUM`. + +## Environment variables + +Docker containers are configured via environment variables, [appendix-environment-variables](#appendix-environment-variables) lists the configurable environment variables for DolphinScheduler and their default values <! -- markdown-link-check-disable-line --> Review comment: ```suggestion Docker containers are configured via environment variables, appendix-environment-variables lists the configurable environment variables for DolphinScheduler and their default values <! -- markdown-link-check-disable-line --> ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
