Help of XCE

This is the entrypoint of xce tool. Currently, we have following sub-commands available:

controller — start xce controller daemon
worker — start xcecd worker daemon
scheduler — start xce scheduler daemon
apiserver — start xce REST API server
shell — interactive bash shell for troubleshooting

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 section below.

controller

Start the xce controller daemon with the given parameters after the controller sub-command.

Example:

xce controller --workdir /var/lib/xce/controller --myname ctrl01 --peers ctrl01:9990,ctrl02:9990

scheduler

Start the xce scheduler daemon with the given parameters after the scheduler sub-command.

worker

Start xcecd with the given parameters after the worker sub-command.

apiserver

Start the xce REST API server with the given parameters after the apiserver sub-command. The API server provides HTTP endpoints for job submission, queue management, and cluster queries, backed by JWT authentication and RBAC authorization.

xcecli

The xce CLI (src/frontend/xcecli/) provides command-line access to the cluster. Common operations:

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.

shell

An interactive bash shell used for troubleshooting and inspection. Not intended for normal cluster operation.

1.7 KiB Raw Blame History