Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .licenserc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Licensed to Apache Software Foundation (ASF) under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Apache Software Foundation (ASF) licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

header:
license:
spdx-id: Apache-2.0
copyright-owner: Apache Software Foundation

paths-ignore:
- NOTICE
- LICENSE
- DISCLAIMER
- mvnw.cmd
- .mvn
- .gitmodules
- .gitattributes
- .github/actions
- '**/*.md'
- '**/*.mdx'
- '**/*.json'
- '**/*.iml'
- '**/*.ini'
- '**/*.svg'
- '**/*.txt'
- '**/*.csv'
- '**/.gitignore'
- '**/LICENSE'
- '**/NOTICE'
- '**/.gitkeep'

comment: on-failure
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Apache SeaTunnel Tools

The repository contains tools for Apache SeaTunnel.
This repository hosts auxiliary tools for Apache SeaTunnel. It focuses on developer/operator productivity around configuration, conversion, packaging and diagnostics. Current modules:

- x2seatunnel: Convert configurations (e.g., DataX) into SeaTunnel configuration files.

More tools may be added in the future. For the main data integration engine, see the
[Apache SeaTunnel](https://github.com/apache/seatunnel) project.

## Tool 1 - SeaTunnel MCP Server

Expand All @@ -18,4 +23,16 @@ SeaTunnel MCP Server

For screenshots, demo video, features, installation and usage instructions, please refer to the README in the seatunnel-mcp directory.

Get the main project from [Apache SeaTunnel](https://github.com/apache/seatunnel)
## Tool 2 - x2seatunnel

What is x2seatunnel?
- x2seatunnel is a configuration conversion tool that helps users migrate from other data integration tools (e.g., DataX) to SeaTunnel by converting existing configurations into SeaTunnel-compatible formats.
- x2seatunnel
- English: [x2seatunnel/README.md](x2seatunnel/README.md)
- Chinese: [x2seatunnel/README_zh.md](x2seatunnel/README_zh.md)

## Contributing

Issues and PRs are welcome.

Get the main project from [Apache SeaTunnel](https://github.com/apache/seatunnel)
39 changes: 39 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
```markdown
# Apache SeaTunnel 工具

本仓库托管 Apache SeaTunnel 的辅助工具,专注于配置、转换、打包和诊断等提升开发/运维效率的工具集。当前包含的模块:

- x2seatunnel:将其它工具(例如 DataX)的配置转换为 SeaTunnel 配置文件。

未来可能会添加更多工具。如需主数据集成引擎,请参见
[Apache SeaTunnel](https://github.com/apache/seatunnel) 项目。

## 工具 1 - SeaTunnel MCP Server

什么是 MCP?
- MCP(Model Context Protocol)是一种将 LLM 与工具、数据和系统连接的开放协议。通过 SeaTunnel MCP,你可以从基于 LLM 的界面直接操作 SeaTunnel,同时保持服务端逻辑安全且可审计。
- 了解更多:https://github.com/modelcontextprotocol

SeaTunnel MCP Server
- 源码目录: [seatunnel-mcp/](seatunnel-mcp/)
- 英文 README: [seatunnel-mcp/README.md](seatunnel-mcp/README.md)
- 中文 README: [seatunnel-mcp/README_CN.md](seatunnel-mcp/README_CN.md)
- 快速开始: [seatunnel-mcp/docs/QUICK_START.md](seatunnel-mcp/docs/QUICK_START.md)
- 用户指南: [seatunnel-mcp/docs/USER_GUIDE.md](seatunnel-mcp/docs/USER_GUIDE.md)
- 开发者指南: [seatunnel-mcp/docs/DEVELOPER_GUIDE.md](seatunnel-mcp/docs/DEVELOPER_GUIDE.md)

有关截图、演示视频、功能、安装与使用说明,请参阅 `seatunnel-mcp` 目录下的 README。

## 工具 2 - x2seatunnel

x2seatunnel 是什么?
- x2seatunnel 是一个配置转换工具,帮助用户将来自其他数据集成工具(例如 DataX)的配置迁移到 SeaTunnel,通过自动转换现有配置生成 SeaTunnel 可识别的格式。
- x2seatunnel 文档:
- 英文: [x2seatunnel/README.md](x2seatunnel/README.md)
- 中文: [x2seatunnel/README_zh.md](x2seatunnel/README_zh.md)

## 参与贡献

欢迎提交 Issue 与 PR。

可从 [Apache SeaTunnel](https://github.com/apache/seatunnel) 获取主项目源码。
37 changes: 20 additions & 17 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,30 @@
<description>Production ready big data processing product based on Apache Spark and Apache Flink.</description>

<modules>
<!--
We retrieve the config module from maven repository. If you want to change the config module,
you need to open this annotation and change the dependency of config-shade to project.
<module>seatunnel-config</module>
-->
<module>seatunnel</module>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this. We should use sub module seatunnel as dependency, not release version.

<module>x2seatunnel</module>
</modules>

<properties>
<!--todo The classification is too confusing, reclassify by type-->
<!-- Project coordinates -->
<revision>0.0.1-SNAPSHOT</revision>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<scala.version>2.12.15</scala.version>
<scala.binary.version>2.12</scala.binary.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>

<!-- External dependency versions for submodules (x2seatunnel) -->
<!-- SeaTunnel released artifacts used by tools (adjust as needed or override with -Dseatunnel.version=...) -->
<seatunnel.version>2.3.12-SNAPSHOT</seatunnel.version>
<slf4j.version>1.7.36</slf4j.version>
<log4j2.version>2.17.1</log4j2.version>
<junit4.version>4.13.2</junit4.version>
<junit5.version>5.9.0</junit5.version>
<mockito.version>4.11.0</mockito.version>
<snakeyaml.version>1.33</snakeyaml.version>
<commons.cli.version>1.4</commons.cli.version>
<jackson.version>2.16.1</jackson.version>

<maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
<maven-failsafe-plugin.version>2.22.2</maven-failsafe-plugin.version>
<nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
Expand All @@ -67,21 +73,19 @@
<maven-license-maven-plugin>1.20</maven-license-maven-plugin>
<maven-dependency-plugin.version>3.1.1</maven-dependency-plugin.version>
<maven-scm-provider-jgit.version>2.0.0</maven-scm-provider-jgit.version>
<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
<spotless.version>2.29.0</spotless.version>
<!-- Option args -->
<skipUT>false</skipUT>
<skipIT>true</skipIT>
<skip.spotless>false</skip.spotless>
</properties>

<build>

<finalName>${project.artifactId}-${project.version}-${scala.version}</finalName>
<finalName>${project.artifactId}-${project.version}</finalName>

<pluginManagement>
<plugins>

<!-- java/scala compiler (Start) -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down Expand Up @@ -154,8 +158,7 @@
<excludes>
<exclude>org.slf4j:*</exclude>
<exclude>ch.qos.logback:*</exclude>
<exclude>log4j:*</exclude>
<exclude>org.apache.logging.log4j:*</exclude>
<exclude>log4j:log4j</exclude>
<exclude>commons-logging:*</exclude>
</excludes>
</artifactSet>
Expand Down Expand Up @@ -463,9 +466,9 @@
</mailingLists>

<scm>
<connection>scm:git:https://github.com/apache/seatunnel.git</connection>
<developerConnection>scm:git:https://github.com/apache/seatunnel.git</developerConnection>
<url>https://github.com/apache/seatunnel</url>
<connection>scm:git:https://github.com/apache/seatunnel-tools.git</connection>
<developerConnection>scm:git:https://github.com/apache/seatunnel-tools.git</developerConnection>
<url>https://github.com/apache/seatunnel-tools</url>
<tag>HEAD</tag>
</scm>

Expand Down
17 changes: 17 additions & 0 deletions x2seatunnel/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Files generated by X2SeaTunnel tests
src/main/resources/examples/target*/*.conf
src/main/resources/examples/report*/*.md

# Keep the example files
!src/main/resources/examples/report*/summary-example.md

target/

# IDE
.idea/
*.iml
.vscode/

# log
logs/
*.log
Loading
Loading