Repository navigation
[Feature] Import Wizard for Installation Setup #586
Description
Motivation
Enhance the quickstart experience. - Currently, there are too many manual steps, thus chances for users to make mistakes and run into problems.
Installation Flow
1) Ask user whether to install Flink
If user selects Yes:
- Download the Flink binary archive to a temporary directory.
- Extract Flink into the target installation directory and remove the downloaded archive.
- Set and export
FLINK_HOME.
If user selects No:
- Validate that
FLINK_HOMEis already set and points to a valid Flink directory .
2) Ask user whether to enable PyFlink
If user selects Yes:
- Copy
flink-pythonJAR from$FLINK_HOME/opt/to$FLINK_HOME/lib/. - Create and activate a Python virtual environment.
- Install
flink-agentsand pinnedapache-flinkvia pip. - Copy Flink Agents Java artifacts into
$FLINK_HOME/lib/.
If user selects No:
- Skip all Python/PyFlink-related steps.
Are you willing to submit a PR?
- I'm willing to submit a PR!
Activity
wenjin272 commentedon May 22, 2026
Hi, @JinkunLiu, Ty for contributing the install script.
The code pr has been merged, but before we close this issue, I think we need refactor the installation documentation for flink-agents. I have created sub-issue #699 for this. Are you interested in taking this issue?
JinkunLiu commentedon May 22, 2026
Hi @wenjin272, Thanks for your help in getting this issue done together, and thanks for setting up the follow-up sub-issue!
I'd be glad to take on #699. Please feel free to assign it to me. I'll provide a refactored documentation outline as soon as possible so we can align on the structure first.