Skip to content

[Tech Debt] Installation doc: wrong Maven version, Python 3.12 mismatch, macOS ARM64 pip failure undocumented #801

Closed

Description

@Ryan-Nightwish

linked issues: #766

Search before asking

  • I searched in the issues and found nothing similar.

Description

Found during get-started doc verification.

Collection of issues for docs/content/docs/get-started/installation.md:

  1. Maven pom.xml example uses flink.version 2.2, which does not exist on Maven Central (line 263) — the example sets <flink.version>2.2</flink.version>, but Maven Central only publishes 2.2.0 (flink-streaming-java:2.2 returns HTTP 404, confirmed by querying repo1.maven.org). Users who copy the example verbatim will get a dependency-resolution failure. Should be <flink.version>2.2.0</flink.version>.

  2. install.sh rejects Python 3.12, but Prerequisites lists it as supported (line 39 vs tools/install.sh line 1579) — the documentation states "Python 3.10, 3.11, or 3.12", but install.sh's validate_python_bin function uses py_minor -ge 12 which rejects Python 3.12+. Users with Python 3.12 following the Quick Install path will be told no compatible Python was found.

  3. macOS ARM64: pip install apache-flink fails on all installation paths, undocumented (line 62-68 Quick Install, line 137 Manual Install) — apache-beam (a transitive dependency of apache-flink) publishes no macOS ARM64 wheels for any Python version (3.9-3.12; all macOS wheels are x86_64-only). On Apple Silicon, pip falls back to building from source, but pip's PEP 517 build-isolation environment downloads the latest setuptools>=82 which removed pkg_resources, causing the build to fail. The project's own setuptools<82 constraint in pyproject.toml (PR #526, issue #529) only governs flink-agents' runtime dependencies and does not affect the isolated build environment for apache-beam. I tried the commandpip install "setuptools<71" && pip install --no-build-isolation apache-flink==2.2.0 to fix it.

Where to fix

docs/content/docs/get-started/installation.md.

Version and environment

Flink Agents 0.3.0 (main), macOS ARM64 (Apple Silicon), Python 3.11.15 / 3.12.13.

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Activity

  1. added
    tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.
    priority/majorDefault priority of the PR or issue.
    on Jun 8, 2026
  2. self-assigned this
    on Jun 8, 2026
  3. added
    priority/blockerIndicates the PR or issue that should block the release until it gets resolved.
    fixVersion/0.3.0The feature or bug should be implemented/fixed in the 0.3.0 version.
    and removed
    priority/majorDefault priority of the PR or issue.
    on Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

fixVersion/0.3.0The feature or bug should be implemented/fixed in the 0.3.0 version.priority/blockerIndicates the PR or issue that should block the release until it gets resolved.tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions