vcctl Command Line Enhancement
@jiangkaihua; Dec. 16, 2019
@googs1025; Jul. 14, 2024
Catalog
Functions of vcctl
vcctl is the command line of volcano. The main functions are listed below:
Command vcctl job
| Command Format |
Usage |
vcctl job delete -N <job_name> -n <namespace> |
delete a job |
vcctl job list -S <scheduler> -n <namespace> -q <queue_name> |
list job info |
vcctl job resume -N <job_name> -n <namespace> |
resume a job |
vcctl job run -f <yaml_file> -i <image> -L <resource_limit> -m <min_available> -N <job_name> -n <namespace> -r <replicas> -R <resource_requeset> -S <scheduler> |
run job by parameters from the command line |
vcctl job suspend -N <job_name> -n <namespace> |
suspend a job |
vcctl job view -N <job_name> -n <namespace> |
show a job info |
Command vcctl queue
| Command Format |
Usage |
vcctl queue create -n <queue_name> -w <weight> |
create a queue |
vcctl queue delete -n <queue_name> |
delete a queue |
vcctl queue get -n <queue_name> |
get a queue |
vcctl queue list |
list all the queue |
vcctl queue operate -a <open/close/update> -n <queue_name> -w <weight> |
operate a queue |
Command vcctl jobflow
| Command Format |
Usage |
vcctl jobflow create -f <jobflow yaml file> |
create a jobflow from yaml file |
vcctl jobflow delete -f <jobflow yaml file> |
delete a jobflow from yaml file |
vcctl jobflow get -N <jobflow_name> -n <namespace> |
get a jobflow |
vcctl jobflow list |
list all the jobflow |
vcctl jobflow describe -N <jobflow_name> -n <namespace> |
describe a jobflow |
Command vcctl jobtemplate
| Command Format |
Usage |
vcctl jobtemplate create -f <jobtemplate yaml file> |
create a jobtemplate from yaml file |
vcctl jobtemplate delete -f <jobtemplate yaml file> |
delete a jobtemplate from yaml file |
vcctl jobtemplate get -N <jobtemplate_name> -n <namespace> |
get a jobtemplate |
vcctl jobtemplate list |
list all the jobtemplate |
vcctl jobtemplate describe -N <jobtemplate_name> -n <namespace> |
describe a jobtemplate |
Command vcctl pod
| Command Format |
Usage |
vcctl pod list -q=<queue_name> -j=<vcjob_name> |
list all the pod list with specified queue name and specified job name |
vcctl vs. Slurm Command Line
The similar Slurm command lines are listed below:
vcctl Function |
Similar Slurm Command Line |
vcctl job run -f <yaml_file> |
sbatch <job_file> |
vcctl job run -N <job_name> |
srun -J <job_name> |
vcctl job delete -N <job_name> -n <namespace> |
scancel <job_id> / -n <job_name> -u <user> |
vcctl job suspend -N <job_name> -n <namespace> |
scontrol suspend <job_id> |
vcctl job resume -N <job_name> -n <namespace> |
scontrol resume <job_id> |
vcctl job view -N <job_name> -n <namespace> |
scontrol show job <job_id> |
vcctl job list --all-namespaces |
scontrol show job |
vcctl job list -n <namespace> |
squeue -u <user> |
vcctl queue create -n <queue_name> -w <weight> |
scontrol create PartitionName=<partition_name> |
vcctl queue delete -n <queue_name> |
scontrol delete PartitionName=<partition_name> |
vcctl queue get -n <queue_name> |
squeue -p <partition_name> & scontrol show partition <partition_name> |
vcctl queue list |
squeue -a & scontrol show partition |
vcctl queue operate -a <open/close/update> -n <queue_name> -w <weight> |
no similar commands |
For Common User
| Old Format |
New Format |
vcctl job run -N <job_name> |
vsub -j/--job-name <job_file> |
vcctl job delete -N <job_name> -n <namespace> |
vcancel -n <job_name> -N <namespace> |
vcctl job suspend -N <job_name> -n <namespace> |
vsuspend -n <job_name> -N <namespace> |
vcctl job resume -N <job_name> -n <namespace> |
vresume -n <job_name> -N <namespace> |
vcctl job view -N <job_name> -n <namespace> |
vjobs -n <job_name> -N <namespace> |
vcctl job list -S <scheduler> -n <namespace> |
vjobs -S <scheduler> -N <namespace> |
vcctl queue get -n <queue_name> |
vqueues -n <queue_name> |
vcctl queue list |
vqueues |
vsub submit via file
Command vsub can also submit a batch job via .sh file, like:
[user@host]$ vsub test.sh
Submitted batch job test
The job file <test.sh> owns a format like:
#!/bin/bash`
#VSUB jobName test
#VSUB namespace volcano-system
#VSUB queue default
#VSUB schedulerName volcano
#VSUB image busybox
#VSUB replicas 10
#VSUB minAvailable 4
...
echo test.sh start on $(date)
sleep 100
echo test.sh end on $(date)
For Administrator
| Old Format |
New Format |
vcctl queue create -n <queue_name> -w <weight> |
vadmin qcreate -n <queue_name> -w <weight> |
vcctl queue delete -n <queue_name> |
vadmin qcancel -n <queue_name> |
vcctl queue operate -a open -n <queue_name> |
vadmin qopen -n <queue_name> |
vcctl queue operate -a close -n <queue_name> |
vadmin qclose -n <queue_name> |
vcctl queue operate -a update -n <queue_name> -w <weight> |
vadmin qupdate -n <queue_name> -w <weight> |
operate -a <open/close/update> -n <queue_name> -w
Reference