update documents

This commit is contained in:
Rongsong Shen 2026-08-10 17:51:51 +08:00
parent c705cadadc
commit d70bf6a402
51 changed files with 995 additions and 1997 deletions

View file

@ -9,11 +9,13 @@ available:
- **scheduler** — start xce scheduler daemon
- **apiserver** — start xce REST API server
- **shell** — interactive bash shell for troubleshooting
- **xcecli** — CLI tool for cluster interaction (job submit, query, admin)
If you run xce without any parameter or with a parameter not listed above, it
will show this help screen.
Note: `xcecli` is not a sub-command of `xce` — it is a separate standalone
Go binary invoked directly. See the [xcecli](#xcecli) section below.
## controller
Start the xce controller daemon with the given parameters after the
@ -21,7 +23,7 @@ Start the xce controller daemon with the given parameters after the
Example:
```
xce controller --config /etc/xce/controller.yaml
xce controller --workdir /var/lib/xce/controller --myname ctrl01 --peers ctrl01:9990,ctrl02:9990
```
## scheduler
@ -45,9 +47,9 @@ authentication and RBAC authorization.
The xce CLI (`src/frontend/xcecli/`) provides command-line access to the
cluster. Common operations:
- `xcecli job submit <jobspec>` — submit a job
- `xcecli job list` — list jobs
- `xcecli queue status` — show queue state
- `xcecli jobs submit <jobspec>` — submit a job
- `xcecli jobs list` — list jobs
- `xcecli queues list` — show queue state
Built as a standalone Go binary; communicates with the API server over
its REST interface.