Skip to content
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.

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

[CELEBORN-1752] Migration guide for unexpected shuffle RESTful api change since 0.5.0 #2960

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/restapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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. |
Expand Down
Loading