Skip to content

Commit 16e7eea

Browse files
authored
[Fix] Update the Readme (apache#4968)
Use the better description for the SeaTunnel Project
1 parent d952cea commit 16e7eea

File tree

1 file changed

+16
-42
lines changed

1 file changed

+16
-42
lines changed

README.md

+16-42
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img src="https://seatunnel.apache.org/image/logo.png" alt="seatunnel logo" height="200px" align="right" />
44

55
[![Backend Workflow](https://github.com/apache/seatunnel/actions/workflows/backend.yml/badge.svg?branch=dev)](https://github.com/apache/seatunnel/actions/workflows/backend.yml)
6-
[![Slack](https://img.shields.io/badge/slack-%23seatunnel-4f8eba?logo=slack)](https://the-asf.slack.com/archives/C053HND1D6X)
6+
[![Slack](https://img.shields.io/badge/slack-%23seatunnel-4f8eba?logo=slack)](https://s.apache.org/seatunnel-slack)
77
[![Twitter Follow](https://img.shields.io/twitter/follow/ASFSeaTunnel.svg?label=Follow&logo=twitter)](https://twitter.com/ASFSeaTunnel)
88

99
---
@@ -13,9 +13,7 @@ SeaTunnel was formerly named Waterdrop , and renamed SeaTunnel since October 12,
1313

1414
---
1515

16-
SeaTunnel is a very easy-to-use ultra-high-performance distributed data integration platform that supports real-time
17-
synchronization of massive data. It can synchronize tens of billions of data stably and efficiently every day, and has
18-
been used in the production of nearly 100 companies.
16+
SeaTunnel is a next-generation super high-performance, distributed, massive data integration tool. It can synchronize tens of billions of data stably and efficiently every day, and has been used in the production of many companies.
1917

2018
## Why do we need SeaTunnel
2119

@@ -25,21 +23,20 @@ SeaTunnel focuses on data integration and data synchronization, and is mainly de
2523
- Complex synchronization scenarios: Data synchronization needs to support various synchronization scenarios such as offline-full synchronization, offline-incremental synchronization, CDC, real-time synchronization, and full database synchronization.
2624
- High demand in resource: Existing data integration and data synchronization tools often require vast computing resources or JDBC connection resources to complete real-time synchronization of massive small tables. This has increased the burden on enterprises to a certain extent.
2725
- Lack of quality and monitoring: Data integration and synchronization processes often experience loss or duplication of data. The synchronization process lacks monitoring, and it is impossible to intuitively understand the real-situation of the data during the task process.
28-
- Complex technology stack: The technology components used by enterprises are different, and users need to develop corresponding synchronization programs for different components to complete data integration.
29-
- Difficulty in management and maintenance: Limited to different underlying technology components (Flink/Spark) , offline synchronization and real-time synchronization often have be developed and managed separately, which increases the difficulty of the management and maintainance.
3026

3127
## Features of SeaTunnel
3228

33-
- Rich and extensible Connector: SeaTunnel provides a Connector API that does not depend on a specific execution engine. Connectors (Source, Transform, Sink) developed based on this API can run on many different engines, such as SeaTunnel Engine, Flink, Spark that are currently supported.
34-
- Connector plugin: The plugin design allows users to easily develop their own Connector and integrate it into the SeaTunnel project. Currently, SeaTunnel has supported more than 70 Connectors, and the number is surging. There is the list of connectors we [supported and plan to support](https://github.com/apache/seatunnel/issues/3018).
29+
- Diverse Connectors: SeaTunnel has supported more than 100 Connectors, and the number is surging. Here is the list of connectors we [supported and plan to support](https://github.com/apache/seatunnel/issues/3018).
3530
- Batch-stream integration: Connectors developed based on SeaTunnel Connector API are perfectly compatible with offline synchronization, real-time synchronization, full- synchronization, incremental synchronization and other scenarios. It greatly reduces the difficulty of managing data integration tasks.
3631
- Support distributed snapshot algorithm to ensure data consistency.
37-
- Multi-engine support: SeaTunnel uses SeaTunnel Engine for data synchronization by default. At the same time, SeaTunnel also supports the use of Flink or Spark as the execution engine of the Connector to adapt to the existing technical components of the enterprise. In addition, SeaTunnel supports multiple versions of Spark and Flink.
32+
- Multi-engine support: SeaTunnel uses SeaTunnel Zeta Engine for data synchronization by default. At the same time, SeaTunnel also supports the use of Flink or Spark as the execution engine of the Connector to adapt to the existing technical components of the enterprise. In addition, SeaTunnel supports multiple versions of Spark and Flink.
3833
- JDBC multiplexing, database log multi-table parsing: SeaTunnel supports multi-table or whole database synchronization, which solves the problem of over-JDBC connections; supports multi-table or whole database log reading and parsing, which solves the need for CDC multi-table synchronization scenarios problems with repeated reading and parsing of logs.
3934
- High throughput and low latency: SeaTunnel supports parallel reading and writing, providing stable and reliable data synchronization capabilities with high throughput and low latency.
4035
- Perfect real-time monitoring: SeaTunnel supports detailed monitoring information of each step in the data synchronization process, allowing users to easily understand the number of data, data size, QPS and other information read and written by the synchronization task.
4136
- Two job development methods are supported: coding and canvas design. The SeaTunnel web project https://github.com/apache/seatunnel-web provides visual management of jobs, scheduling, running and monitoring capabilities.
4237

38+
Besides, SeaTunnel provides a Connector API that does not depend on a specific execution engine. Connectors (Source, Transform, Sink) developed based on this API can run on many different engines, such as SeaTunnel Zeta Engine, Flink, Spark that are currently supported.
39+
4340
## SeaTunnel work flowchart
4441

4542
![SeaTunnel work flowchart](docs/en/images/architecture_diagram.png)
@@ -63,29 +60,15 @@ The default engine use by SeaTunnel is [SeaTunnel Engine](seatunnel-engine/READM
6360

6461
### Here's a list of our connectors with their health status.[connector status](docs/en/Connector-v2-release-state.md)
6562

66-
## Environmental dependency
67-
68-
1. java runtime environment, java >= 8
69-
70-
2. If you want to run SeaTunnel in a cluster environment, any of the following Spark cluster environments is usable:
71-
72-
- Spark on Yarn
73-
- Spark Standalone
74-
75-
If the data volume is small, or the goal is merely for functional verification, you can also start in local mode without
76-
a cluster environment, because SeaTunnel supports standalone operation. Note: SeaTunnel 2.0 supports running on Spark
77-
and Flink.
78-
79-
## Compiling project
80-
Follow this [document](docs/en/contribution/setup.md).
8163

8264
## Downloads
8365

8466
Download address for run-directly software package : https://seatunnel.apache.org/download
8567

8668
## Quick start
69+
SeaTunnel uses SeaTunnel Zeta Engine as the runtime execution engine for data synchronization by default. We highly recommend utilizing Zeta engine as the runtime engine, as it offers superior functionality and performance. By the way, SeaTunnel also supports the use of Flink or Spark as the execution engine.
8770

88-
**SeaTunnel Engine**
71+
**SeaTunnel Zeta Engine**
8972
https://seatunnel.apache.org/docs/start-v2/locally/quick-start-seatunnel-engine/
9073

9174
**Spark**
@@ -101,6 +84,10 @@ https://seatunnel.apache.org/docs/start-v2/locally/quick-start-flink
10184
Weibo business uses an internal customized version of SeaTunnel and its sub-project Guardian for SeaTunnel On Yarn task
10285
monitoring for hundreds of real-time streaming computing tasks.
10386

87+
- Tencent Cloud
88+
89+
Collecting various logs from business services into Apache Kafka, some of the data in Apache Kafka is consumed and extracted through SeaTunnel, and then store into Clickhouse.
90+
10491
- Sina, Big Data Operation Analysis Platform
10592

10693
Sina Data Operation Analysis Platform uses SeaTunnel to perform real-time and offline analysis of data operation and
@@ -110,27 +97,11 @@ maintenance for Sina News, CDN and other services, and write it into Clickhouse.
11097

11198
Sogou Qiqian System takes SeaTunnel as an ETL tool to help establish a real-time data warehouse system.
11299

113-
- Qutoutiao, Qutoutiao Data Center
114-
115-
Qutoutiao Data Center uses SeaTunnel to support mysql to hive offline ETL tasks, real-time hive to clickhouse backfill
116-
technical support, and well covers most offline and real-time tasks needs.
117-
118-
- Yixia Technology, Yizhibo Data Platform
119-
120100
- Yonghui Superstores Founders' Alliance-Yonghui Yunchuang Technology, Member E-commerce Data Analysis Platform
121101

122102
SeaTunnel provides real-time streaming and offline SQL computing of e-commerce user behavior data for Yonghui Life, a
123103
new retail brand of Yonghui Yunchuang Technology.
124104

125-
- Shuidichou, Data Platform
126-
127-
Shuidichou adopts SeaTunnel to do real-time streaming and regular offline batch processing on Yarn, processing 3~4T data
128-
volume average daily, and later writing the data to Clickhouse.
129-
130-
- Tencent Cloud
131-
132-
Collecting various logs from business services into Apache Kafka, some of the data in Apache Kafka is consumed and extracted through SeaTunnel, and then store into Clickhouse.
133-
134105
For more use cases, please refer to: https://seatunnel.apache.org/blog
135106

136107
## Code of conduct
@@ -140,14 +111,17 @@ By participating, you are expected to uphold this code. Please follow
140111
the [REPORTING GUIDELINES](https://www.apache.org/foundation/policies/conduct#reporting-guidelines) to report
141112
unacceptable behavior.
142113

143-
## Developer
114+
## Contributors
144115

145116
Thanks to [all developers](https://github.com/apache/seatunnel/graphs/contributors)!
146117

147118
<a href="https://github.com/apache/seatunnel/graphs/contributors">
148119
<img src="https://contrib.rocks/image?repo=apache/seatunnel" />
149120
</a>
150121

122+
## How to compile
123+
Please follow this [document](docs/en/contribution/setup.md).
124+
151125
## Contact Us
152126

153127
* Mail list: **[email protected]**. Mail to `[email protected]`, follow the reply to subscribe

0 commit comments

Comments
 (0)