Skip to content

Commit

Permalink
Update deployment.md (#284)
Browse files Browse the repository at this point in the history
Changed the language little bit. Structured the connector's manual setup to be together
  • Loading branch information
satishjayagopal authored Dec 10, 2023
1 parent 13e9d33 commit e68163c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions versioned_docs/version-2.3.3/start-v2/locally/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@ import TabItem from '@theme/TabItem';

## Step 1: Prepare the environment

Before you getting start the local run, you need to make sure you already have installed the following software which SeaTunnel required:
Before you would like to start to run Seatunnel locally, you need to install the following softwares which SeaTunnel requires:

* [Java](https://www.java.com/en/download/) (Java 8 or 11, other versions greater than Java 8 can theoretically work as well) installed and `JAVA_HOME` set.

## Step 2: Download SeaTunnel

Enter the [seatunnel download page](https://seatunnel.apache.org/download) and download the latest version of distribute
package `seatunnel-<version>-bin.tar.gz`
Download the latest version of seatunnel distributive package `seatunnel-<version>-bin.tar.gz`from [seatunnel download page](https://seatunnel.apache.org/download)

Or you can download it by terminal
Or you can download it by using terminal

```shell
export version="2.3.3"
Expand All @@ -31,7 +30,7 @@ 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: (Of course, you can also manually download the connector from [Apache Maven Repository](https://repo.maven.apache.org/maven2/org/apache/seatunnel/) to download, then manually move to the `connectors/seatunnel` directory).
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:

```bash
sh bin/install-plugin.sh 2.3.3
Expand All @@ -42,7 +41,6 @@ If you need to specify the version of the connector, take 2.3.3 as an example, y
```bash
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

```plugin_config
Expand All @@ -64,6 +62,8 @@ You can find out all supported connectors and corresponding plugin_config config

:::tip

Alternatively, you can also manually download the connector from [Apache Maven Repository](https://repo.maven.apache.org/maven2/org/apache/seatunnel/) 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
Expand All @@ -75,10 +75,10 @@ seatunnel
spark
```

If you'd like to install the V2 connector plugin manually, you only need to download the V2 connector plugin you need and put them in the seatunnel directory
You can download only the V2 connector plugins you need and put them in the seatunnel directory

:::

## What's More

For now, you are already deployment SeaTunnel complete. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.
For now, hope you had managed to successfully deploy your SeaTunnel locally. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.

0 comments on commit e68163c

Please sign in to comment.