Skip to content

Deprecate legacy management endpoints for removal #2749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2025
Merged

Deprecate legacy management endpoints for removal #2749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae30e20
Deprecate LegacyManagementEndpoints for removal
adutra Oct 2, 2025
33fd191
move to right section
adutra Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ request adding CHANGELOG notes for breaking (!) changes and possibly other secti
### Upgrade Notes

- Amazon RDS plugin enabled, this allows polaris to connect to AWS Aurora PostgreSQL using IAM authentication.
- The EclipseLink Persistence implementation has been deprecated since 1.0.0 and will be completely removed
in 1.3.0 or in 2.0.0 (whichever happens earlier).

### Breaking Changes

Expand All @@ -53,6 +51,11 @@ request adding CHANGELOG notes for breaking (!) changes and possibly other secti
### Deprecations

* The property `polaris.active-roles-provider.type` is deprecated and has no effect anymore.
- The EclipseLink Persistence implementation has been deprecated since 1.0.0 and will be completely removed
in 1.3.0 or in 2.0.0 (whichever happens earlier).
- The legacy management endpoints at `/metrics` and `/healthcheck` have been deprecated in 1.2.0 and will be
completely removed in 1.3.0 or in 2.0.0 (whichever happens earlier). Please use the standard management
Copy link
Contributor

@singhpk234 singhpk234 Oct 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

completely removed in 1.3.0 or in 2.0.0 (whichever happens earlier)

do we wanna give it 1 or 2 more releases for complete removal, 1.5.0 or in 2.0.0 (whichever happens earlier)

I am totally fine with marking these APIs as forRemoval

Copy link
Member

@jbonofre jbonofre Oct 3, 2025

Choose a reason for hiding this comment

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

I would propose to flag to removal now, and the actual removal can happen in Polaris 2.0.0 (I don't see problem to release 2.0.0 soon 😄 ).

Copy link
Contributor

@dimas-b dimas-b Oct 3, 2025

Choose a reason for hiding this comment

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

Postponing removal should be transparent for end users (even if previously said "removing in 1.3 😅 ).

Copy link
Contributor

@dimas-b dimas-b Oct 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

As for the number of releases to "wait", I'm not sure it helps users so much. People who upgrade often will be able to deal with changes. People who do not upgrade to avoid changes, will be suffering from lack of evolution / bug fixes in EL, so it's not a sound strategy IMHO.

As for the endpoints, as I commented in some other thread, it's really a backend change. It only affects the "devops" personas and can be applied holistically without any visible client-side effects... so again I do not see a strong reason to defer this change.

... happy to discuss on dev ML too 🙂

Copy link
Contributor

@dimas-b dimas-b Oct 3, 2025

Choose a reason for hiding this comment

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

... and I'm in favour of making 2.0 soon 😉

endpoints at `/q/metrics` and `/q/health` instead.

### Fixes

Expand Down
1 change: 1 addition & 0 deletions ...me/service/src/main/java/org/apache/polaris/service/legacy/LegacyManagementEndpoints.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.eclipse.microprofile.config.inject.ConfigProperty;

@ApplicationScoped
@Deprecated(forRemoval = true)
public class LegacyManagementEndpoints {

public void registerLegacyManagementRoutes(
Expand Down