Skip to main content
Version: 2.3.3

deployment


Deployment

Step 1: Prepare the environment

Before you would like to start to run Seatunnel locally, you need to install the following softwares which SeaTunnel requires:

  • Java (Java 8 or 11, other versions greater than Java 8 can theoretically work as well) installed and JAVA_HOME set.

Step 2: Download SeaTunnel

Download the latest version of seatunnel distributive package seatunnel-<version>-bin.tar.gzfrom seatunnel download page

Or you can download it by using terminal

export version="2.3.3"
wget "https://archive.apache.org/dist/seatunnel/${version}/apache-seatunnel-${version}-bin.tar.gz"
tar -xzvf "apache-seatunnel-${version}-bin.tar.gz"

Step 3: Install connectors plugin

Since 2.2.0-beta, the binary package does not provide connector dependencies by default, so when using it for the first time, you need to execute the following command to install the connector:

sh bin/install-plugin.sh 2.3.3

If you need to specify the version of the connector, take 2.3.3 as an example, you need to execute

sh bin/install-plugin.sh 2.3.3

Usually you don't need all the connector plugins, so you can specify the plugins you need by configuring config/plugin_config, for example, you only need the connector-console plugin, then you can modify plugin.properties as

--seatunnel-connectors--
connector-console
--end--

If you'd like to make a sample application to work properly, you need to add the following plugins

--seatunnel-connectors--
connector-fake
connector-console
--end--

You can find out all supported connectors and corresponding plugin_config configuration names under ${SEATUNNEL_HOME}/connectors/plugins-mapping.properties.

tip

Alternatively, you can also manually download the connector from Apache Maven Repository to download, then manually move to the connectors/seatunnel directory).

If you'd like to install the connector plugin by manually downloading the connector, you need to pay special attention to the following

The connectors directory contains the following subdirectories, if they do not exist, you need to create them manually

flink
flink-sql
seatunnel
spark

You can download only the V2 connector plugins you need and put them in the seatunnel directory

What's More

For now, hope you had managed to successfully deploy your SeaTunnel locally. You can follow Quick Start to configure and run a data synchronization job.