Apache SeaTunnel (Incubating)

---

SeaTunnel was formerly named Waterdrop , and renamed SeaTunnel since October 12, 2021.

---

So, What we are?

An open-source web console to manage your seatunnel-script, and would push them to any scheduling-system easily. Click it if your want to know more about our design. 👉🏻Design

How to start

1 Preparing the Apache DolphinScheduler environment

1.1 Install Apache DolphinScheduler

If you already have Apache DolphinScheduler environment, you can skip this step and go to [Create Tenant and User for SeaTunnel Web](#1.2 Create Tenant and User for SeaTunnel Web)

Because running SeaTunnel Web must rely on the DolphinScheduler, if you do not have a DS environment, you need to first install and deploy a DolphinScheduler (hereinafter referred to as DS). Taking DS version 3.1.5 as an example.

Reference https://dolphinscheduler.apache.org/zh-cn/docs/3.1.5/guide/installation/standalone to install a standalone DS.

1.2 Create Tenant and User for SeaTunnel Web

If you already have a DS environment and decide to use existing users and tenants for SeaTunnel Web, you can skip this step and go to [Create Project for SeaTunnel Web](#1.3 Create Project for SeaTunnel Web).

Because SeaTunnel Web needs to call the interface of DS to create workflows and tasks, it is necessary to submit the projects, users, and tenants created in DS for SeaTunnel to use.

1. Create Tenant

"Security" -> "Tenant Manage" -> "Create Tenant"

2. For simplicity, use the default user admin of DS directly here

1.3 Create Project for SeaTunnel Web

1.4 Create Token for SeaTunnel Web

2 Run SeaTunnel Web in IDEA

If you want to deploy and run SeaTunnel Web, Please turn to [3 Run SeaTunnel Web In Server](#3 Run SeaTunnel Web In Server)

2.1 Init database

1. Edit whaletunnel-server/whaletunnel-app/src/main/resources/script/seatunnel_server_env.sh file, Complete the installed database address, port, username, and password. Here is an example:

   export HOSTNAME="localhost"
   export PORT="3306"
   export USERNAME="root"
   export PASSWORD="123456"
   

2. Run init shell sh seatunnel-server/seatunnel-app/src/main/resources/script/init_sql.sh If there are no errors during operation, it indicates successful initialization.

2.2 Config application and Run SeaTunnel Web Backend Server

1. Edit seatunnel-server/seatunnel-app/src/main/resources/application.yml Fill in the database connection information and DS interface related information in the file.

2. Run seatunnel-server/seatunnel-app/src/main/java/org/apache/seatunnel/app/SeatunnelApplication.java If there are no errors reported, the seatunnel web backend service is successfully started.

2.3 Run SeaTunnel Web Front End

cd seatunnel-ui
npm install
npm run dev

If there are no issues with the operation, the following information will be displayed:

  ➜  Local:   http://127.0.0.1:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help

Accessing in a browser http://127.0.0.1:5173/login Okay, the default username and password are admin/admin.

3 Run SeaTunnel Web In Server

3.1 Build Install Package From Code

cd incubator-seatunnel-web
sh build.sh code

Then you can find the installer package in dir incubator-seatunnel-web/seatunnel-server/seatunnel-app/target/apache-seatunnel-web-incubating-${project.version}.tar.gz.

3.2 Install

Copy the apache-seatunnel-web-incubating-${project.version}.tar.gz to your server node and unzip it.

tar -zxvf apache-seatunnel-web-incubating-${project.version}.tar.gz

3.3 Init database

1. Edit apache-seatunnel-web-incubating-${project.version}/script/seatunnel_server_env.sh file, Complete the installed database address, port, username, and password. Here is an example:

   export HOSTNAME="localhost"
   export PORT="3306"
   export USERNAME="root"
   export PASSWORD="123456"
   

2. Run init shell sh apache-seatunnel-web-incubating-${project.version}/script/init_sql.sh If there are no errors during operation, it indicates successful initialization.

3.4 Config application and Run SeaTunnel Web Backend Server

Edit apache-seatunnel-web-incubating-${project.version}/config/application.yml Fill in the database connection information and DS interface related information in the file.

3.5 Start SeaTunnel Web

cd apache-seatunnel-web-incubating-${project.version}
sh bin/seatunnel-backend-daemon.sh start

Accessing in a browser http://127.0.0.1:8801/ui/ Okay, the default username and password are admin/admin.

How to use it

After all the pre-work is done, we can open the following URL: 127.0.0.1:7890(please replace it according to your configuration) to use it.

Now ,let me show you how to use it.

User manage

Datapipeline manage

Job manage

Task manage