[FLINK-35654][docs] Add CDC release verification & Installation guide #3430
Conversation
yuxiqian
changed the title
|
|
||
| * Flink CDC tar could be downloaded from [Apache Flink Website](https://flink.apache.org/downloads/#apache-flink-cdc) or [GitHub Release Page](https://github.com/apache/flink-cdc/releases). | ||
| * Pipeline and source connectors could be downloaded from [Maven Central Repository](https://mvnrepository.com/artifact/org.apache.flink) or [GitHub Release Page](https://github.com/apache/flink-cdc/releases). | ||
| * If you're using Linux or macOS, you may install Flink CDC and connectors with Homebrew: |
There was a problem hiding this comment.
Did you mean here only macOs? Or if there is apt install for Linux also?
There was a problem hiding this comment.
Homebrew is also available on Linux (rarely used though). Currently, Flink CDC isn't provided in any other package managers. I could remove Linux here if it's confusing.
|
|
||
| 1. Verify if source code could be compiled successfully. | ||
|
|
||
| Currently, Flink CDC uses [Maven](https://maven.apache.org/) 3 as the build tool and compiles on the JDK 8 platform. |
There was a problem hiding this comment.
Do you know if we have minimum requirement for the maven version?
The pom file enforcer plugin doesn't mention anything, so maybe all mvn 3+ versions fine.
There was a problem hiding this comment.
Seems Maven version isn't always consistent. I noticed that CI uses Maven 3.8.6 but latest 3.1.1 release was compiled with 3.9.1. Not sure if all Maven 3+ works.
| You can run CDC migration verification locally with [Flink CDC Migration Test Utils](https://github.com/yuxiqian/migration-test) script. | ||
|
|
||
| * [Pipeline Job Migration Test Guide](https://github.com/yuxiqian/migration-test/blob/main/README.md) | ||
| * [DataStream Job Migration Test Guide](https://github.com/yuxiqian/migration-test/blob/main/datastream/README.md) |
There was a problem hiding this comment.
Really nice! Thanks a lot 🙏
I'd suggest at some point in future move these to cdc itself or apache organization (similar flink-benchmarks)
There was a problem hiding this comment.
I would prefer putting it in CDC repository along with existing CI workflows since it seems isn't significant enough to be an independent repo. I will try to clean up testing scripts before it could be accepted by any upstream repositories.
|
Thanks for @morazow's comments! Addressed most of them, and left some that requires further discussion. |
This closes FLINK-35654.
Currently, ASF voting process requires vast quality verification before releasing any new versions, including:
Adding verification SOP in "Contribution guide" of Flink CDC docs should help developers verify future releases more easily.