Skip to content

Commit

Permalink
[Docs] Update quick start v2 related docs info (#7161)
Browse files Browse the repository at this point in the history
  • Loading branch information
tcodehuber authored Jul 11, 2024
1 parent aeb42ba commit 562712c
Show file tree
Hide file tree
Showing 10 changed files with 90 additions and 106 deletions.
2 changes: 1 addition & 1 deletion docs/en/start-v2/docker/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
sidebar_position: 3
-------------------

# Set Up with Docker
# Set Up With Docker

<!-- TODO -->
-->
24 changes: 12 additions & 12 deletions docs/en/start-v2/kubernetes/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,27 @@ import TabItem from '@theme/TabItem';

# Set Up with Kubernetes

This section provides a quick guide to using SeaTunnel with Kubernetes.
This section provides a quick guide to use SeaTunnel with Kubernetes.

## Prerequisites

We assume that you have a local installations of the following:
We assume that you have one local installation as follow:

- [docker](https://docs.docker.com/)
- [kubernetes](https://kubernetes.io/)
- [helm](https://helm.sh/docs/intro/quickstart/)

So that the `kubectl` and `helm` commands are available on your local system.

For kubernetes [minikube](https://minikube.sigs.k8s.io/docs/start/) is our choice, at the time of writing this we are using version v1.23.3. You can start a cluster with the following command:
Take kubernetes [minikube](https://minikube.sigs.k8s.io/docs/start/) as an example, you can start a cluster with the following command:

```bash
minikube start --kubernetes-version=v1.23.3
```

## Installation

### SeaTunnel docker image
### SeaTunnel Docker Image

To run the image with SeaTunnel, first create a `Dockerfile`:

Expand Down Expand Up @@ -58,7 +58,7 @@ Then run the following commands to build the image:
```bash
docker build -t seatunnel:2.3.6-flink-1.13 -f Dockerfile .
```
Image `seatunnel:2.3.6-flink-1.13` need to be present in the host (minikube) so that the deployment can take place.
Image `seatunnel:2.3.6-flink-1.13` needs to be present in the host (minikube) so that the deployment can take place.

Load image to minikube via:
```bash
Expand Down Expand Up @@ -114,7 +114,7 @@ Then run the following commands to build the image:
```bash
docker build -t seatunnel:2.3.6 -f Dockerfile .
```
Image `seatunnel:2.3.6` need to be present in the host (minikube) so that the deployment can take place.
Image `seatunnel:2.3.6` needs to be present in the host (minikube) so that the deployment can take place.

Load image to minikube via:
```bash
Expand All @@ -125,7 +125,7 @@ minikube image load seatunnel:2.3.6
</Tabs>


### Deploying the operator
### Deploying The Operator

<Tabs
groupId="engine-type"
Expand Down Expand Up @@ -191,7 +191,7 @@ none
]}>
<TabItem value="flink">

In this guide we are going to use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):
In this guide we will use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):

```conf
env {
Expand Down Expand Up @@ -291,7 +291,7 @@ kubectl apply -f seatunnel-flink.yaml

<TabItem value="Zeta (local-mode)">

In this guide we are going to use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):
In this guide we will use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):

```conf
env {
Expand Down Expand Up @@ -366,7 +366,7 @@ kubectl apply -f seatunnel.yaml

<TabItem value="Zeta (cluster-mode)">

In this guide we are going to use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):
In this guide we will use [seatunnel.streaming.conf](https://github.com/apache/seatunnel/blob/2.3.6-release/config/v2.streaming.conf.template):

```conf
env {
Expand Down Expand Up @@ -572,7 +572,7 @@ spec:
```bash
kubectl apply -f seatunnel-cluster.yml
```
Then modify the seatunnel configuration in pod using the following command
Then modify the seatunnel configuration in pod using the following command:

```bash
kubectl edit cm hazelcast
Expand Down Expand Up @@ -768,5 +768,5 @@ Happy SeaTunneling!
## What's More
For now, you are already taking a quick look at SeaTunnel, you could see [connector](/category/connector) to find all source and sink SeaTunnel supported.
For now, you have taken a quick look at SeaTunnel, and you can see [connector](/category/connector) to find all sources and sinks SeaTunnel supported.
Or see [deployment](../deployment.mdx) if you want to submit your application in another kind of your engine cluster.
24 changes: 12 additions & 12 deletions docs/en/start-v2/locally/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,31 @@ Before starting to download SeaTunnel, you need to ensure that you have installe

## Step 2: Download SeaTunnel

Go to the [seatunnel download page](https://seatunnel.apache.org/download) to download the latest version of the release version installation package `seatunnel-<version>-bin.tar.gz`.
Visit the [SeaTunnel Download Page](https://seatunnel.apache.org/download) to download the latest binary package `seatunnel-<version>-bin.tar.gz`.

Or you can also download it through the terminal.
Or you can also download it through the terminal:

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

## Step 3: Download the connector plug-in
## Step 3: Download The Connector Plugins

Starting from the 2.2.0-beta version, the binary package no longer provides the connector dependency by default. Therefore, 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 the [Apache Maven Repository](https://repo.maven.apache.org/maven2/org/apache/seatunnel/), and then move it to the `connectors/seatunnel` directory).
Starting from the 2.2.0-beta version, the binary package no longer provides the connector dependencies by default. Therefore, when using it for the first time, you need to execute the following command to install the connectors (Of course, you can also manually download the connector from the [Apache Maven Repository](https://repo.maven.apache.org/maven2/org/apache/seatunnel/), and then move it to the `connectors/seatunnel` directory) :

```bash
sh bin/install-plugin.sh 2.3.6
sh bin/install-plugin.sh
```

If you need a specific connector version, taking 2.3.6 as an example, you need to execute the following command.
If you need a specific connector version, taking 2.3.6 as an example, you need to execute the following command:

```bash
sh bin/install-plugin.sh 2.3.6
```

Usually you don't need all the connector plugins, so you can specify the plugins you need through configuring `config/plugin_config`, for example, if you only need the `connector-console` plugin, then you can modify the plugin.properties configuration file as follows.
Usually you don't need all connector plugins, so you can specify the plugins you need through configuring `config/plugin_config`. For example, if you only need the `connector-console` plugin, you can modify the plugin.properties configuration file as follows:

```plugin_config
--seatunnel-connectors--
Expand All @@ -61,14 +61,14 @@ You can find all supported connectors and the corresponding plugin_config config

:::tip Tip

If you want to install connector plugins by manually downloading connectors, you only need to download the connector plugins you need and place them in the `${SEATUNNEL_HOME}/connectors/` directory
If you want to install connector plugins by manually downloading connectors, you only need to download the related connector plugins and place them in the `${SEATUNNEL_HOME}/connectors/` directory.

:::

Now you have completed the download of the SeaTunnel installation package and the download of the connector plug-in. Next, you can choose different running modes according to your needs to run or deploy SeaTunnel.
Now you have downloaded the SeaTunnel binary package and the connector plugins. Next, you can choose different engine option to run synchronization tasks.

If you use Flink to run the synchronization task, in this mode, there is no need to deploy the SeaTunnel Engine service cluster. You can refer to [Quick Start of SeaTunnel Flink Engine](quick-start-flink.md) to run your synchronization task.
If you use Flink to run the synchronization task, there is no need to deploy the SeaTunnel Engine service cluster. You can refer to [Quick Start of SeaTunnel Flink Engine](quick-start-flink.md) to run your synchronization task.

If you use Spark to run the synchronization task, in this mode, there is no need to deploy the SeaTunnel Engine service cluster. You can refer to [Quick Start of SeaTunnel Spark Engine](quick-start-spark.md) to run your synchronization task.
If you use Spark to run the synchronization task, there is no need to deploy the SeaTunnel Engine service cluster. You can refer to [Quick Start of SeaTunnel Spark Engine](quick-start-spark.md) to run your synchronization task.

If you use the SeaTunnel Engine (Zeta) that comes with SeaTunnel to run tasks, you need to deploy the SeaTunnel Engine service first. Refer to [Deployment of SeaTunnel Engine (Zeta) Service](quick-start-seatunnel-engine.md).
If you use the builtin SeaTunnel Engine (Zeta) to run tasks, you need to deploy the SeaTunnel Engine service first. Refer to [Deployment of SeaTunnel Engine (Zeta) Service](quick-start-seatunnel-engine.md).
31 changes: 15 additions & 16 deletions docs/en/start-v2/locally/quick-start-flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@ sidebar_position: 3

# Quick Start With Flink

## Step 1: Deployment SeaTunnel And Connectors
## Step 1: Deploy SeaTunnel And Connectors

Before starting, make sure you have downloaded and deployed SeaTunnel as described in [deployment](deployment.md)
Before starting, make sure you have downloaded and deployed SeaTunnel as described in [Deployment](deployment.md)

## Step 2: Deployment And Config Flink

Please [download Flink](https://flink.apache.org/downloads.html) first(**required version >= 1.12.0**). For more information you could see [Getting Started: standalone](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/deployment/resource-providers/standalone/overview/)
Please [Download Flink](https://flink.apache.org/downloads.html) first(**required version >= 1.12.0**). For more information you can see [Getting Started: Standalone](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/deployment/resource-providers/standalone/overview/)

**Configure SeaTunnel**: Change the setting in `config/seatunnel-env.sh`, it is base on the path your engine install at [deployment](deployment.md).
Change `FLINK_HOME` to the Flink deployment dir.
**Configure SeaTunnel**: Change the setting in `${SEATUNNEL_HOME}/config/seatunnel-env.sh` and set `FLINK_HOME` to the Flink deployment dir.

## Step 3: Add Job Config File to define a job
## Step 3: Add Job Config File To Define A Job

Edit `config/v2.streaming.conf.template`, which determines the way and logic of data input, processing, and output after seatunnel is started.
The following is an example of the configuration file, which is the same as the example application mentioned above.
Expand Down Expand Up @@ -59,30 +58,30 @@ sink {
```

More information about config please check [config concept](../../concept/config.md)
More information about config please check [Config Concept](../../concept/config.md)

## Step 4: Run SeaTunnel Application

You could start the application by the following commands
You can start the application by the following commands:

flink version between `1.12.x` and `1.14.x`
Flink version between `1.12.x` and `1.14.x`

```shell
cd "apache-seatunnel-${version}"
./bin/start-seatunnel-flink-13-connector-v2.sh --config ./config/v2.streaming.conf.template
```

flink version between `1.15.x` and `1.16.x`
Flink version between `1.15.x` and `1.16.x`

```shell
cd "apache-seatunnel-${version}"
./bin/start-seatunnel-flink-15-connector-v2.sh --config ./config/v2.streaming.conf.template
```

**See The Output**: When you run the command, you could see its output in your console. You can think this
is a sign that the command ran successfully or not.
**See The Output**: When you run the command, you can see its output in your console. This
is a sign to determine whether the command ran successfully or not.

The SeaTunnel console will prints some logs as below:
The SeaTunnel console will print some logs as below:

```shell
fields : name, age
Expand All @@ -107,7 +106,7 @@ row=16 : SGZCr, 94186144

## What's More

For now, you are already take a quick look about SeaTunnel with Flink, you could see [connector](/docs/category/connector-v2) to find all
source and sink SeaTunnel supported. Or see [SeaTunnel With Flink](../../other-engine/flink.md) if you want to know more about SeaTunnel Run With Flink.
For now, you have taken a quick look about SeaTunnel with Flink, and you can see [Connector](/docs/category/connector-v2) to find all
sources and sinks SeaTunnel supported. Or see [SeaTunnel With Flink](../../other-engine/flink.md) if you want to know more about SeaTunnel With Flink.

SeaTunnel have an own engine named `Zeta` and `Zeta` is the default engine of SeaTunnel. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.
SeaTunnel have a builtin engine named `Zeta`, and it's the default engine of SeaTunnel. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.
20 changes: 10 additions & 10 deletions docs/en/start-v2/locally/quick-start-seatunnel-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_position: 2

# Quick Start With SeaTunnel Engine

## Step 1: Deployment SeaTunnel And Connectors
## Step 1: Deploy SeaTunnel And Connectors

Before starting, make sure you have downloaded and deployed SeaTunnel as described in [deployment](deployment.md)
Before starting, make sure you have downloaded and deployed SeaTunnel as described in [Deployment](deployment.md)

## Step 2: Add Job Config File to define a job
## Step 2: Add Job Config File To Define A Job

Edit `config/v2.batch.config.template`, which determines the way and logic of data input, processing, and output after seatunnel is started.
The following is an example of the configuration file, which is the same as the example application mentioned above.
Expand Down Expand Up @@ -52,11 +52,11 @@ sink {
```

More information about config please check [config concept](../../concept/config.md)
More information can be found in [Config Concept](../../concept/config.md)

## Step 3: Run SeaTunnel Application

You could start the application by the following commands
You could start the application by the following commands:

:::tip

Expand All @@ -70,10 +70,10 @@ cd "apache-seatunnel-${version}"
```

**See The Output**: When you run the command, you could see its output in your console. You can think this
is a sign that the command ran successfully or not.
**See The Output**: When you run the command, you can see its output in your console. This
is a sign to determine whether the command ran successfully or not.

The SeaTunnel console will prints some logs as below:
The SeaTunnel console will print some logs as below:

```shell
2022-12-19 11:01:45,417 INFO org.apache.seatunnel.connectors.seatunnel.console.sink.ConsoleSinkWriter - output rowType: name<STRING>, age<INT>
Expand All @@ -97,5 +97,5 @@ The SeaTunnel console will prints some logs as below:

## What's More

For now, you are already take a quick look about SeaTunnel, you could see [connector](../../connector-v2/source/FakeSource.md) to find all
source and sink SeaTunnel supported. Or see [SeaTunnel Engine(Zeta)](../../seatunnel-engine/about.md) if you want to know more about SeaTunnel Engine. Here you will learn how to deploy SeaTunnel Engine in cluster mode and how to use it in cluster mode.
For now, you have taken a quick look about SeaTunnel, and you can see [connector](../../connector-v2/source/FakeSource.md) to find all
sources and sinks SeaTunnel supported. Or see [SeaTunnel Engine(Zeta)](../../seatunnel-engine/about.md) if you want to know more about SeaTunnel Engine. Here you will learn how to deploy SeaTunnel Engine and how to use it in cluster mode.
33 changes: 16 additions & 17 deletions docs/en/start-v2/locally/quick-start-spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,16 @@ sidebar_position: 4

## Step 1: Deployment SeaTunnel And Connectors

Before starting, make sure you have downloaded and deployed SeaTunnel as described in [deployment](deployment.md)
Before starting, make sure you have downloaded and deployed SeaTunnel as described in [Deployment](deployment.md)

## Step 2: Deployment And Config Spark
## Step 2: Deploy And Config Spark

Please [download Spark](https://spark.apache.org/downloads.html) first(**required version >= 2.4.0**). For more information you could
see [Getting Started: standalone](https://spark.apache.org/docs/latest/spark-standalone.html#installing-spark-standalone-to-a-cluster)
Please [Download Spark](https://spark.apache.org/downloads.html) first(**required version >= 2.4.0**). For more information you can
see [Getting Started: Standalone](https://spark.apache.org/docs/latest/spark-standalone.html#installing-spark-standalone-to-a-cluster)

**Configure SeaTunnel**: Change the setting in `config/seatunnel-env.sh`, it is base on the path your engine install at [deployment](deployment.md).
Change `SPARK_HOME` to the Spark deployment dir.
**Configure SeaTunnel**: Change the setting in `${SEATUNNEL_HOME}/config/seatunnel-env.sh` and set `SPARK_HOME` to the Spark deployment dir.

## Step 3: Add Job Config File to define a job
## Step 3: Add Job Config File To Define A Job

Edit `config/seatunnel.streaming.conf.template`, which determines the way and logic of data input, processing, and output after seatunnel is started.
The following is an example of the configuration file, which is the same as the example application mentioned above.
Expand Down Expand Up @@ -60,13 +59,13 @@ sink {
```

More information about config please check [config concept](../../concept/config.md)
More information about config please check [Config Concept](../../concept/config.md)

## Step 4: Run SeaTunnel Application

You could start the application by the following commands
You could start the application by the following commands:

spark 2.4.x
Spark 2.4.x

```bash
cd "apache-seatunnel-${version}"
Expand All @@ -76,7 +75,7 @@ cd "apache-seatunnel-${version}"
--config ./config/v2.streaming.conf.template
```

spark3.x.x
Spark3.x.x

```shell
cd "apache-seatunnel-${version}"
Expand All @@ -86,10 +85,10 @@ cd "apache-seatunnel-${version}"
--config ./config/v2.streaming.conf.template
```

**See The Output**: When you run the command, you could see its output in your console. You can think this
is a sign that the command ran successfully or not.
**See The Output**: When you run the command, you can see its output in your console. This
is a sign to determine whether the command ran successfully or not.

The SeaTunnel console will prints some logs as below:
The SeaTunnel console will print some logs as below:

```shell
fields : name, age
Expand All @@ -114,7 +113,7 @@ row=16 : SGZCr, 94186144

## What's More

For now, you are already take a quick look about SeaTunnel with Spark, you could see [connector](/docs/category/connector-v2) to find all
source and sink SeaTunnel supported. Or see [SeaTunnel With Spark](../../other-engine/spark.md) if you want to know more about SeaTunnel Run With Spark.
For now, you have taken a quick look about SeaTunnel with Spark, and you can see [Connector](/docs/category/connector-v2) to find all
sources and sinks SeaTunnel supported. Or see [SeaTunnel With Spark](../../other-engine/spark.md) if you want to know more about SeaTunnel With Spark.

SeaTunnel have an own engine named `Zeta` and `Zeta` is the default engine of SeaTunnel. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.
SeaTunnel have a builtin engine named `Zeta`, and it's the default engine of SeaTunnel. You can follow [Quick Start](quick-start-seatunnel-engine.md) to configure and run a data synchronization job.
Loading

0 comments on commit 562712c

Please sign in to comment.