Skip to content

[docs] Update installation section.#226

Merged
xintongsong merged 4 commits intoapache:mainfrom
wenjin272:update-doc-installation
Sep 30, 2025
Merged

[docs] Update installation section.#226
xintongsong merged 4 commits intoapache:mainfrom
wenjin272:update-doc-installation

Conversation

@wenjin272
Copy link
Copy Markdown
Collaborator

Linked issue: #198

Purpose of change

Update the installation section.

Tests

No

API

No

Documentation

Yes

### Install Flink Agents to Flink


To install the Java dependencies to Flink, run:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why only installing the java dependencies? What happen to the python?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

The python package will be installed to the python interpreter. By export PYTHONPATH before run python job.
export PYTHONPATH=$(python -c 'import sysconfig; print(sysconfig.get_paths()["purelib"])')
The standalone cluster can find the python package.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does it also work for submitting to a remote cluster? If this is the right step, why not include it in the installation doc?

Copy link
Copy Markdown
Collaborator Author

@wenjin272 wenjin272 Sep 30, 2025

Choose a reason for hiding this comment

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

It works when submitting the job to standalone cluster, I haven't test in yarn or k8s cluster.

I think this is not a installation step, but a submit job step. For user must export the PYTHONPATH each time they start cluster and submit the job.

But just install java package to flink, not install python package may confuse the user, I think maybe we can mention this behavior here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should offer both options: export PYTHONPATH in .bashrc for once, or export it everytime before starting a cluster or submitting the job. This should be mentioned in both the installation and deployment documents.

Copy link
Copy Markdown
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

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

LGTM

@xintongsong xintongsong merged commit b48b9a9 into apache:main Sep 30, 2025
11 checks passed
@Sxnan Sxnan added priority/major Default priority of the PR or issue. fixVersion/0.1.0 The feature or bug should be implemented/fixed in the 0.1.0 version. doc-not-needed Your PR changes do not impact docs labels Nov 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-not-needed Your PR changes do not impact docs fixVersion/0.1.0 The feature or bug should be implemented/fixed in the 0.1.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants