1"use strict";(globalThis.webpackChunkdocs_site=globalThis.webpackChunkdocs_site||[]).push([[12525],{80214(e,n,o){o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"CLI/cli","title":"CLI","description":"Introduction","source":"@site/versioned_docs/version-v1.8.2/CLI/Commandline.md","sourceDirName":"CLI","slug":"/CLI/cli","permalink":"/docs/v1.8.2/CLI/cli","draft":false,"unlisted":false,"editUrl":"https://github.com/volcano-sh/website/tree/master/versioned_docs/version-v1.8.2/CLI/Commandline.md","tags":[],"version":"v1.8.2","lastUpdatedAt":1779789566000,"frontMatter":{"id":"cli","title":"CLI"},"sidebar":"docsSidebar","previous":{"title":"Recommended Configurations for Common Scenarios","permalink":"/docs/v1.8.2/Scheduler/Scenario"},"next":{"title":"Contribution","permalink":"/docs/v1.8.2/Contribution/VolcanoContribution"}}');var c=o(74848),l=o(28453);const s={id:"cli",title:"CLI"},t="CLI",a={},d=[{value:"Introduction",id:"introduction",level:2},{value:"Configuration",id:"configuration",level:2},{value:"Command Line List",id:"command-line-list",level:2},{value:"Listing all jobs",id:"listing-all-jobs",level:3},{value:"Deleting a specific job",id:"deleting-a-specific-job",level:3},{value:"Suspending a job",id:"suspending-a-job",level:3},{value:"Resuming a job (opposite to "vcctl job suspend")",id:"resuming-a-job-opposite-to-vcctl-job-suspend",level:3},{value:"Running a job",id:"running-a-job",level:3},{value:"Additional Help",id:"additional-help",level:2}];function r(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{children:(0,c.jsx)(n.h1,{id:"cli",children:"CLI"})}),"\n",(0,c.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,c.jsx)(n.p,{children:"A Command Line Interface (CLI) is provided for you to manage resources."}),"\n",(0,c.jsx)(n.h2,{id:"configuration",children:"Configuration"}),"\n",(0,c.jsxs)(n.ol,{children:["\n",(0,c.jsx)(n.li,{children:"You can obtain the latest executable file by cloning the code from GitHub and running the following command in the root directory of the project:"}),"\n"]}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-bash",children:"make vcctl\n"})}),"\n",(0,c.jsxs)(n.ol,{start:"2",children:["\n",(0,c.jsxs)(n.li,{children:["Copy the executable file to ",(0,c.jsx)(n.code,{children:"$PATH"}),". You then can execute it anywhere."]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"command-line-list",children:"Command Line List"}),"\n",(0,c.jsx)(n.h3,{id:"listing-all-jobs",children:"Listing all jobs"}),"\n",(0,c.jsx)(n.p,{children:"vcctl job list"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{children:"vcctl job list\nName Creation Phase JobType Replicas Min Pending Running Succeeded Failed Unknown RetryCount\njob-1 2020-09-01 Running Batch 1 1 0 1 0 0 0 0 \n"})}),"\n",(0,c.jsx)(n.h3,{id:"deleting-a-specific-job",children:"Deleting a specific job"}),"\n",(0,c.jsx)(n.p,{children:"vcctl job delete --name job-name [--namespace job-namespace]"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-bash",children:"vcctl delete job --name job-1 --namespace default\n# Output: delete job job-1 successfully\n"})}),"\n",(0,c.jsx)(n.h3,{id:"suspending-a-job",children:"Suspending a job"}),"\n",(0,c.jsx)(n.p,{children:"vcctl job suspend --name job-name [--namespace job-namespace]"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-bash",children:"vcctl job suspend --name job-1 --namespace default\n"})}),"\n",(0,c.jsx)(n.h3,{id:"resuming-a-job-opposite-to-vcctl-job-suspend",children:'Resuming a job (opposite to "vcctl job suspend")'}),"\n",(0,c.jsx)(n.p,{children:"vcctl job resume --name job-name [--namespace job-namespace]"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-bash",children:"vcctl job resume --name job-1 --namespace default\n"})}),"\n",(0,c.jsx)(n.h3,{id:"running-a-job",children:"Running a job"}),"\n",(0,c.jsx)(n.p,{children:"vcctl job run --name job-name [--namespace job-namespace]"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-html",children:"vcctl job run --name job-1 --namespace default\n"})}),"\n",(0,c.jsx)(n.h2,{id:"additional-help",children:"Additional Help"}),"\n",(0,c.jsx)(n.p,{children:"For more information about Volcano command lines, run the following commands:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-bash",children:"vcctl -h\nvcctl [command] -h\n"})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(r,{...e})}):r(e)}},28453(e,n,o){o.d(n,{R:()=>s,x:()=>t});var i=o(96540);const c={},l=i.createContext(c);function s(e){const n=i.useContext(l);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.