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 7b73f5917 [CELEBORN-1678][FOLLOWUP] Update master and worker commands
in celeborn_cli.md
7b73f5917 is described below
commit 7b73f5917332a97bc0e359e368e8e65007daf575
Author: SteNicholas <[email protected]>
AuthorDate: Fri Mar 21 15:50:55 2025 +0800
[CELEBORN-1678][FOLLOWUP] Update master and worker commands in
celeborn_cli.md
### What changes were proposed in this pull request?
Update master and worker commands in `celeborn_cli.md` including:
- Remove `--show-top-disk-used-apps` command of master and worker.
- Add `--show-workers-topology` command of master.
### Why are the changes needed?
- #2949 removes `--show-top-disk-used-apps` command of master and worker.
- #3119 adds `--show-workers-topology` command of master.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
No.
Closes #3165 from SteNicholas/CELEBORN-1678.
Authored-by: SteNicholas <[email protected]>
Signed-off-by: SteNicholas <[email protected]>
---
docs/celeborn_cli.md | 19 ++++++++-----------
1 file changed, 8 insertions(+), 11 deletions(-)
diff --git a/docs/celeborn_cli.md b/docs/celeborn_cli.md
index e41d3bc98..83e5e430e 100644
--- a/docs/celeborn_cli.md
+++ b/docs/celeborn_cli.md
@@ -34,7 +34,7 @@ Celeborn CLI is the command line interface of Celeborn
including the management
## Setup
To get the binary package `apache-celeborn-<VERSION>-bin.tgz`, download the
pre-built binary tarball from [Download](https://celeborn.apache.org/download)
or
-the source tarball from [Download](https://celeborn.apache.org/download) for
building Celeborn according to
[Build](https://celeborn.apache.org/community/contributor_guide/build_and_test/).
+the source tarball from [Download](https://celeborn.apache.org/download) for
building Celeborn according to
[Build](https://github.com/apache/celeborn?tab=readme-ov-file#build).
After getting the binary package `apache-celeborn-<VERSION>-bin.tgz`:
@@ -83,8 +83,8 @@ Usage: celeborn-cli master [-hV] [--apps=appId]
[--cluster=cluster_alias]
[--config-tenant=tenant_id] [--host-list=h1,h2,
h3...] [--hostport=host:port] [--worker-ids=w1,w2,
w3...] (--show-masters-info | --show-cluster-apps |
- --show-cluster-shuffles | --show-top-disk-used-apps
- | --exclude-worker | --remove-excluded-worker |
+ --show-cluster-shuffles | --exclude-worker |
+ --remove-excluded-worker |
--send-worker-event=IMMEDIATELY | DECOMMISSION |
DECOMMISSION_THEN_IDLE | GRACEFUL | RECOMMISSION |
NONE | --show-worker-event-info |
@@ -93,9 +93,9 @@ Usage: celeborn-cli master [-hV] [--apps=appId]
[--cluster=cluster_alias]
--show-shutdown-workers |
--show-decommissioning-workers |
--show-lifecycle-managers | --show-workers |
- --show-conf | --show-dynamic-conf |
- --show-thread-dump | --show-container-info |
- --add-cluster-alias=alias |
+ --show-workers-topology | --show-conf |
+ --show-dynamic-conf | --show-thread-dump |
+ --show-container-info | --add-cluster-alias=alias |
--remove-cluster-alias=alias |
--remove-workers-unavailable-info |
--revise-lost-shuffles | --delete-apps)
@@ -148,11 +148,11 @@ Usage: celeborn-cli master [-hV] [--apps=appId]
[--cluster=cluster_alias]
--show-shutdown-workers
Show shutdown workers
--show-thread-dump Show master thread dump
- --show-top-disk-used-apps
- Show top disk used apps
--show-worker-event-info
Show worker event information
--show-workers Show registered workers
+ --show-workers-topology
+ Show registered workers topology
--shuffleIds=<shuffleIds>
The shuffle ids to manipulate.
-V, --version Print version information and exit.
@@ -172,7 +172,6 @@ Usage: celeborn-cli worker [-hV] [--apps=appId]
[--cluster=cluster_alias]
h3...] [--hostport=host:port] [--worker-ids=w1,w2,
w3...] (--show-worker-info | --show-apps-on-worker |
--show-shuffles-on-worker |
- --show-top-disk-used-apps |
--show-partition-location-info |
--show-unavailable-peers | --is-shutdown |
--is-decommissioning | --is-registered |
@@ -203,8 +202,6 @@ Usage: celeborn-cli worker [-hV] [--apps=appId]
[--cluster=cluster_alias]
--show-shuffles-on-worker
Show shuffles running on the worker
--show-thread-dump Show worker thread dump
- --show-top-disk-used-apps
- Show top disk used applications
--show-unavailable-peers
Show unavailable peers
--show-worker-info Show worker info
