You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celeborn.apache.org by ni...@apache.org on 2024/11/28 08:17:15 UTC

(celeborn) branch main updated: [CELEBORN-1752] Migration guide for unexpected shuffle RESTful api change since 0.5.0

This is an automated email from the ASF dual-hosted git repository.

nicholasjiang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/celeborn.git


The following commit(s) were added to refs/heads/main by this push:
     new aea680d1c [CELEBORN-1752] Migration guide for unexpected shuffle RESTful api change since 0.5.0
aea680d1c is described below

commit aea680d1cc451820c9990db24d0043229df29e62
Author: Wang, Fei <fw...@ebay.com>
AuthorDate: Thu Nov 28 16:16:47 2024 +0800

    [CELEBORN-1752] Migration guide for unexpected shuffle RESTful api change since 0.5.0
    
    ### What changes were proposed in this pull request?
    
    Add migration doc for RESTful api change for celeborn 0.5.0.
    
    ### Why are the changes needed?
    
    There was a typo in https://github.com/apache/celeborn/pull/2371, the `/shuffles` api was renamed to `/shuffle`.
    
    ### Does this PR introduce _any_ user-facing change?
    No.
    
    ### How was this patch tested?
    
    GA.
    
    Closes #2960 from turboFei/shuffles_api.
    
    Authored-by: Wang, Fei <fw...@ebay.com>
    Signed-off-by: SteNicholas <pr...@163.com>
---
 docs/migration.md | 2 ++
 docs/restapi.md   | 4 ++--
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/migration.md b/docs/migration.md
index 286b90948..b7f36b041 100644
--- a/docs/migration.md
+++ b/docs/migration.md
@@ -108,6 +108,8 @@ license: |
 
 - Since 0.5.0, Celeborn worker REST API `/exit` uses POST method and the parameter `type` uses form parameter instead.
 
+- Since 0.5.0, Celeborn master and worker REST API `/shuffles` is renamed as `/shuffle`, and will be deprecated since 0.6.0.
+
 ## Upgrading from 0.4.0 to 0.4.1
 
 - Since 0.4.1, Celeborn master adds a limit to the estimated partition size used for computing worker slots. 
diff --git a/docs/restapi.md b/docs/restapi.md
index da75338b1..47f29295c 100644
--- a/docs/restapi.md
+++ b/docs/restapi.md
@@ -53,7 +53,7 @@ See the [migration guide](migration.md) for API mappings.
 | /lostWorkers         | GET    |                                              | List all lost workers of the master.                                                                                                                                                                                                                                                                                                                         |
 | /masterGroupInfo     | GET    |                                              | List master group information of the service. It will list all master's LEADER, FOLLOWER information.                                                                                                                                                                                                                                                        |
 | /metrics/prometheus  | GET    |                                              | List the metrics data in prometheus format of the master. The url path is defined by configure `celeborn.metrics.prometheus.path`.                                                                                                                                                                                                                           |
-| /shuffles            | GET    |                                              | List all running shuffle keys of the service. It will return all running shuffle's key of the cluster.                                                                                                                                                                                                                                                       |
+| /shuffle             | GET    |                                              | List all running shuffle keys of the service. It will return all running shuffle's key of the cluster.                                                                                                                                                                                                                                                       |
 | /shutdownWorkers     | GET    |                                              | List all shutdown workers of the master.                                                                                                                                                                                                                                                                                                                     |
 | /decommissionWorkers | GET    |                                              | List all decommission workers of the master.                                                                                                                                                                                                                                                                                                                 |
 | /threadDump          | GET    |                                              | List the current thread dump of the master.                                                                                                                                                                                                                                                                                                                  |
@@ -75,7 +75,7 @@ See the [migration guide](migration.md) for API mappings.
 | /listDynamicConfigs        | GET    | level=${LEVEL} tenant=${TENANT} name=${NAME} | List the dynamic configs of the worker. The parameter level specifies the config level of dynamic configs. The parameter tenant specifies the tenant id of TENANT or TENANT_USER level. The parameter name specifies the user name of TENANT_USER level. Meanwhile, either none or all of the parameter tenant and name are specified for TENANT_USER level. |
 | /listPartitionLocationInfo | GET    |                                              | List all the living PartitionLocation information in that worker.                                                                                                                                                                                                                                                                                            |
 | /metrics/prometheus        | GET    |                                              | List the metrics data in prometheus format of the worker. The url path is defined by configure `celeborn.metrics.prometheus.path`.                                                                                                                                                                                                                           |
-| /shuffles                  | GET    |                                              | List all the running shuffle keys of the worker. It only return keys of shuffles running in that worker.                                                                                                                                                                                                                                                     |
+| /shuffle                   | GET    |                                              | List all the running shuffle keys of the worker. It only return keys of shuffles running in that worker.                                                                                                                                                                                                                                                     |
 | /threadDump                | GET    |                                              | List the current thread dump of the worker.                                                                                                                                                                                                                                                                                                                  |
 | /unavailablePeers          | GET    |                                              | List the unavailable peers of the worker, this always means the worker connect to the peer failed.                                                                                                                                                                                                                                                           |
 | /workerInfo                | GET    |                                              | List the worker information of the worker.                                                                                                                                                                                                                                                                                                                   |