Skip to content

Add gateway namespace to gateway resources#19347

Merged
TomeHirata merged 3 commits intomlflow:masterfrom
TomeHirata:gateway/rename/gateway-methods
Dec 12, 2025
Merged

Add gateway namespace to gateway resources#19347
TomeHirata merged 3 commits intomlflow:masterfrom
TomeHirata:gateway/rename/gateway-methods

Conversation

@TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Dec 12, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19347/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19347/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19347/merge

Related Issues/PRs

n/a

What changes are proposed in this pull request?

Add gateway namespace to gateway resources to avoid future namespace conflicts.

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@TomeHirata
Add gateway namespace to gateway CRUD
66d2c22 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata
lint
5fea169 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Copilot AI review requested due to automatic review settings December 12, 2025 02:26
@github-actions github-actions bot added v3.7.1 rn/none List under Small Changes in Changelogs. labels Dec 12, 2025
Copilot AI reviewed Dec 12, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a gateway namespace to all MLflow AI Gateway resources to prevent future namespace conflicts. The changes systematically rename methods, RPC endpoints, and API paths to include "gateway" in their names.

Key changes:

  • Renamed all gateway-related methods to include gateway prefix (e.g., create_secret → create_gateway_secret)
  • Updated all API endpoint paths to include /gateway/ namespace (e.g., /mlflow/secrets/create → /mlflow/gateway/secrets/create)
  • Updated RPC method names and documentation titles to reflect the gateway namespace

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/tracking/test_rest_tracking.py Updated integration test function calls to use new create_gateway_*, update_gateway_*, delete_gateway_*, get_gateway_*, and list_gateway_* method names
tests/store/tracking/test_rest_store.py Updated unit test function names and method calls to use gateway-prefixed naming; updated expected API endpoint paths to include /gateway/ namespace
tests/store/tracking/test_gateway_sql_store.py Renamed all test functions and updated method calls to use gateway-prefixed naming convention
mlflow/store/tracking/gateway/sqlalchemy_mixin.py Renamed all public methods in the SQL store implementation to include gateway prefix
mlflow/store/tracking/gateway/rest_mixin.py Renamed all public methods in the REST store mixin to include gateway prefix
mlflow/store/tracking/gateway/abstract_mixin.py Updated abstract method signatures to include gateway prefix for consistency
mlflow/server/handlers.py Updated handler functions to call the newly renamed gateway-prefixed store methods
mlflow/protos/service.proto Updated RPC method names to include Gateway suffix, changed API paths to include /gateway/ namespace, updated RPC doc titles, and removed unused getSecretsConfig RPC
mlflow/java/client/src/main/java/org/mlflow/api/proto/Service.java Auto-generated Java code reflecting the protobuf changes with updated method names and endpoint paths

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TomeHirata
Merge branch 'master' into gateway/rename/gateway-methods
afdbe2d 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

Documentation preview for afdbe2d is available at:

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

BenWilson2
BenWilson2 approved these changes Dec 12, 2025
View reviewed changes
Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

renames look great! If you merge tonight, I'll do the sync to get the UI updated to these routes :D Thanks @TomeHirata !!

@TomeHirata TomeHirata added this pull request to the merge queue Dec 12, 2025
Merged via the queue into mlflow:master with commit e3076b8 Dec 12, 2025
60 of 62 checks passed
@TomeHirata TomeHirata deleted the gateway/rename/gateway-methods branch December 12, 2025 03:41
debu-sinha pushed a commit to debu-sinha/mlflow that referenced this pull request Dec 12, 2025
@TomeHirata
Add gateway namespace to gateway resources (mlflow#19347)
6bf2764 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
TomeHirata
TomeHirata commented Dec 15, 2025
View reviewed changes
mlflow/protos/service.proto
// ========== Secrets Configuration API ==========

// Get secrets storage configuration status
rpc getSecretsConfig(GetSecretsConfig) returns (GetSecretsConfig.Response) {
Copy link
Collaborator Author

@TomeHirata TomeHirata Dec 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@BenWilson2 sorry, this rpc was removed since there's no usage for this rpc... Can you add it back in this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@BenWilson2 BenWilson2 BenWilson2 approved these changes

@B-Step62 B-Step62 Awaiting requested review from B-Step62

Assignees

No one assigned

Labels

rn/none List under Small Changes in Changelogs. v3.7.1 v3.8.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TomeHirata @BenWilson2