ic4y commented on code in PR #3244: URL: https://github.com/apache/incubator-seatunnel/pull/3244#discussion_r1010168609
########## docs/en/start-v2/local.mdx: ########## @@ -0,0 +1,203 @@ +--- +sidebar_position: 2 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Set Up with Locally + +> Let's take an application that randomly generates data in memory, processes it through SQL, and finally outputs it to the console as an example. + +## 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: + +* [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. +* Download the engine, you can choose and download one of them from below as your favour, you could see more information about [why we need engine in SeaTunnel](../faq.md#why-i-should-install-computing-engine-like-spark-or-flink) +* Spark: Please [download Spark](https://spark.apache.org/downloads.html) first(**required version >= 2 and version < 3.x **). For more information you could +see [Getting Started: standalone](https://spark.apache.org/docs/latest/spark-standalone.html#installing-spark-standalone-to-a-cluster) +* Flink: Please [download Flink](https://flink.apache.org/downloads.html) first(**required version >= 1.12.0 and version < 1.14.x **). 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/) + +## 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` + +Or you can download it by terminal + +```shell +export version="2.3.0-beta" +wget "https://archive.apache.org/dist/incubator/seatunnel/${version}/apache-seatunnel-incubating-${version}-bin.tar.gz"; +tar -xzvf "apache-seatunnel-incubating-${version}-bin.tar.gz" +``` +<!-- TODO: We should add example module as quick start which is no need for install Spark or Flink --> + +## Step 3: Install connectors plugin +Since 2.3.0-beta, the binary package does not provide connector dependencies by default, so when using it for the first time, we 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 seatunnel subdirectory under the connectors directory). +```bash +sh bin/install_plugin.sh 2.3.0-beta +``` +If you need to specify the version of the connector, take 2.3.0-beta as an example, we need to execute +```bash +sh bin/install_plugin.sh 2.3.0-beta Review Comment: These two commands are the same? ########## docs/en/start-v2/local.mdx: ########## @@ -0,0 +1,203 @@ +--- +sidebar_position: 2 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Set Up with Locally + +> Let's take an application that randomly generates data in memory, processes it through SQL, and finally outputs it to the console as an example. + +## 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: + +* [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. +* Download the engine, you can choose and download one of them from below as your favour, you could see more information about [why we need engine in SeaTunnel](../faq.md#why-i-should-install-computing-engine-like-spark-or-flink) +* Spark: Please [download Spark](https://spark.apache.org/downloads.html) first(**required version >= 2 and version < 3.x **). For more information you could +see [Getting Started: standalone](https://spark.apache.org/docs/latest/spark-standalone.html#installing-spark-standalone-to-a-cluster) +* Flink: Please [download Flink](https://flink.apache.org/downloads.html) first(**required version >= 1.12.0 and version < 1.14.x **). 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/) + +## 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` + +Or you can download it by terminal + +```shell +export version="2.3.0-beta" +wget "https://archive.apache.org/dist/incubator/seatunnel/${version}/apache-seatunnel-incubating-${version}-bin.tar.gz"; +tar -xzvf "apache-seatunnel-incubating-${version}-bin.tar.gz" +``` +<!-- TODO: We should add example module as quick start which is no need for install Spark or Flink --> + +## Step 3: Install connectors plugin +Since 2.3.0-beta, the binary package does not provide connector dependencies by default, so when using it for the first time, we 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 seatunnel subdirectory under the connectors directory). +```bash +sh bin/install_plugin.sh 2.3.0-beta +``` +If you need to specify the version of the connector, take 2.3.0-beta as an example, we need to execute +```bash +sh bin/install_plugin.sh 2.3.0-beta +``` +Usually we 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 +--seatunnel-connectors-- +connector-console +--end-- +``` +If we want our sample application to work properly, we need to add the following plugins + +```plugin_config +--seatunnel-connectors-- +connector-fake +connector-console +--end-- +``` + +You can find all supported connectors and corresponding plugin_config configuration names under `${SEATUNNEL_HOME}/connectors/plugins-mapping.properties`. + +:::tip + +If you want to install the connector plugin by manually downloading the connector, you need to pay special attention to the following Review Comment: following what？ -- 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]
