This is an automated email from the ASF dual-hosted git repository.
nicholasjiang pushed a commit to branch branch-0.6
in repository https://gitbox.apache.org/repos/asf/celeborn.git
The following commit(s) were added to refs/heads/branch-0.6 by this push:
new 041b5c359 [CELEBORN-2020][FOLLOWUP] Add --auth-header option to usage
of CLI commands
041b5c359 is described below
commit 041b5c3595fc51a7901c6b83dd8c52c681c0b8b9
Author: SteNicholas <[email protected]>
AuthorDate: Wed Jun 4 19:27:07 2025 +0800
[CELEBORN-2020][FOLLOWUP] Add --auth-header option to usage of CLI commands
### What changes were proposed in this pull request?
Add `--auth-header` option to usage of CLI commands.
Follow up #3300.
### Why are the changes needed?
#3300 is lack of `--auth-header` option in usage of CLI commands.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
```
./build/make-distribution.sh
./dist/sbin/celeborn-cli master -h
./dist/sbin/celeborn-cli worker -h
```
Closes #3311 from SteNicholas/CELEBORN-2020.
Authored-by: SteNicholas <[email protected]>
Signed-off-by: SteNicholas <[email protected]>
(cherry picked from commit 73bf154d80c3648423be6d2a81f76902cca6b747)
Signed-off-by: SteNicholas <[email protected]>
---
docs/celeborn_cli.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/docs/celeborn_cli.md b/docs/celeborn_cli.md
index 91c4c3077..c73f4bf58 100644
--- a/docs/celeborn_cli.md
+++ b/docs/celeborn_cli.md
@@ -78,13 +78,13 @@ The basic usage of commands for master and worker service
can also get with the
```shell
$ celeborn-cli master -h
-Usage: celeborn-cli master [-hV] [--apps=appId] [--cluster=cluster_alias]
- [--config-level=level] [--config-name=username]
- [--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 | --exclude-worker |
- --remove-excluded-worker |
+Usage: celeborn-cli master [-hV] [--apps=appId] [--auth-header=authHeader]
+ [--cluster=cluster_alias] [--config-level=level]
+ [--config-name=username] [--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 |
+ --exclude-worker | --remove-excluded-worker |
--send-worker-event=IMMEDIATELY | DECOMMISSION |
DECOMMISSION_THEN_IDLE | GRACEFUL | RECOMMISSION |
NONE | --show-worker-event-info |
@@ -103,12 +103,12 @@ Usage: celeborn-cli master [-hV] [--apps=appId]
[--cluster=cluster_alias]
--add-cluster-alias=alias
Add alias to use in the cli for the given set of
masters
+ --apps=appId The application Id list seperated by comma.
--auth-header=authHeader
The http `Authorization` header for
authentication. It should be in the format of
`Bearer <token>` or `Basic
<base64-encoded-credentials>`.
- --apps=appId The application Id list seperated by comma.
--cluster=cluster_alias
The alias of the cluster to use to query masters
--config-level=level The config level of the dynamic configs
@@ -171,12 +171,12 @@ Usage: celeborn-cli master [-hV] [--apps=appId]
[--cluster=cluster_alias]
```shell
$ celeborn-cli worker -h
-Usage: celeborn-cli worker [-hV] [--apps=appId] [--cluster=cluster_alias]
- [--config-level=level] [--config-name=username]
- [--config-tenant=tenant_id] [--host-list=h1,h2,
- h3...] [--hostport=host:port] [--worker-ids=w1,w2,
- w3...] (--show-worker-info | --show-apps-on-worker |
- --show-shuffles-on-worker |
+Usage: celeborn-cli worker [-hV] [--apps=appId] [--auth-header=authHeader]
+ [--cluster=cluster_alias] [--config-level=level]
+ [--config-name=username] [--config-tenant=tenant_id]
+ [--host-list=h1,h2,h3...] [--hostport=host:port]
+ [--worker-ids=w1,w2,w3...] (--show-worker-info |
+ --show-apps-on-worker | --show-shuffles-on-worker |
--show-partition-location-info |
--show-unavailable-peers | --is-shutdown |
--is-decommissioning | --is-registered |
