-
Notifications
You must be signed in to change notification settings - Fork 125
docs: update CLI docs to note vcctl is not in release packages #526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
atul-upadhyay-7
wants to merge
1
commit into
volcano-sh:master
Choose a base branch
from
atul-upadhyay-7:docs/fix-vcctl-cli-documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 92 additions & 27 deletions
119
i18n/zh-Hans/docusaurus-plugin-content-docs/current/CLI/Commandline.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,119 @@ | ||
| --- | ||
| id: cli | ||
| title: CLI | ||
| --- | ||
| ### 简介 | ||
| Volcano提供了命令行工具用于管理资源。 | ||
| ## 配置 | ||
|
|
||
| 1. 您可以自己从 github 上克隆代码并在项目的根目录下执行以下命令制作最新的可执行文件: | ||
| ```shell | ||
| # make vcctl | ||
| # CLI | ||
|
|
||
| ## 简介 | ||
|
|
||
| Volcano提供了一个名为 `vcctl` 的命令行工具用于管理资源,如作业(jobs)和队列(queues)。 | ||
|
|
||
| ## 安装 | ||
|
|
||
| ### 先决条件 | ||
|
|
||
| - [Go](https://golang.org/doc/install) (版本需与项目的 `go.mod` 匹配) | ||
| - [Git](https://git-scm.com/) | ||
|
|
||
| ### 从源码构建 | ||
|
|
||
| 1. 克隆 Volcano 代码库: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/volcano-sh/volcano.git | ||
| cd volcano | ||
| ``` | ||
|
|
||
| 2. 构建 `vcctl` 二进制文件: | ||
|
|
||
| ```bash | ||
| make vcctl | ||
| ``` | ||
|
|
||
| 3. 二进制文件将生成在 `_output/bin/` 目录下。将其复制到您的 `$PATH` 目录中: | ||
|
|
||
| ```bash | ||
| sudo cp _output/bin/vcctl /usr/local/bin/ | ||
| ``` | ||
|
|
||
| 4. 验证安装: | ||
|
|
||
| ```bash | ||
| vcctl --help | ||
| ``` | ||
|
|
||
| ## 命令行参考 | ||
|
|
||
| ### 列举所有的 Job | ||
|
|
||
| ```bash | ||
| vcctl job list | ||
| ``` | ||
| 2. 将可执行文件拷贝到$PATH下以便您能在任何地方执行它。 | ||
|
|
||
| ## 命令行列表 | ||
| ### 列举所有的Job | ||
| 输出示例: | ||
|
|
||
| ```shell | ||
| # vcctl job list | ||
| ``` | ||
| Name Creation Phase JobType Replicas Min Pending Running Succeeded Failed Unknown RetryCount | ||
| job-1 2020-09-01 Running Batch 1 1 0 1 0 0 0 0 | ||
| ``` | ||
|
|
||
| ### 删除指定的Job | ||
| ### 删除指定的 Job | ||
|
|
||
| ```bash | ||
| vcctl job delete --name job-name [--namespace job-namespace] | ||
| ``` | ||
|
|
||
| 示例: | ||
|
|
||
| ```bash | ||
| vcctl job delete --name job-1 --namespace default | ||
| # Output: delete job job-1 successfully | ||
| ``` | ||
|
|
||
| ### 挂起(中止)一个 Job | ||
|
|
||
| ```shell | ||
| # vcctl delete job --name job-1 --namespaces default | ||
| delete job job-1 successfully | ||
| ```bash | ||
| vcctl job suspend --name job-name [--namespace job-namespace] | ||
| ``` | ||
|
|
||
| ### 中止一个Job | ||
| 示例: | ||
|
|
||
| ```shell | ||
| # vcctl job suspend --name job-1 --namespace default | ||
| ```bash | ||
| vcctl job suspend --name job-1 --namespace default | ||
| ``` | ||
|
|
||
| ### 消费一个Job (与"vcctl job suspend"相反) | ||
| ### 恢复一个 Job | ||
|
|
||
| ``` shell | ||
| # vcctl job resume --name job-1 --namespace default | ||
| 恢复一个被挂起的 Job (与 `vcctl job suspend` 相反): | ||
|
|
||
| ```bash | ||
| vcctl job resume --name job-name [--namespace job-namespace] | ||
| ``` | ||
|
|
||
| 示例: | ||
|
|
||
| ```bash | ||
| vcctl job resume --name job-1 --namespace default | ||
| ``` | ||
|
|
||
| ### 运行一个Job | ||
| ### 运行一个 Job | ||
|
|
||
| ```shell | ||
| # vcctl job run --name job-1 --namespace default | ||
| ```bash | ||
| vcctl job run --name job-name [--namespace job-namespace] | ||
| ``` | ||
|
|
||
| 示例: | ||
|
|
||
| ```bash | ||
| vcctl job run --name job-1 --namespace default | ||
| ``` | ||
|
|
||
| ## 说明事项 | ||
|
|
||
| 如需获取更多命令行详情请按如下操作: | ||
|
|
||
| ```shell | ||
| # vcctl -h | ||
| # vcctl [command] -h | ||
| ```bash | ||
| vcctl -h | ||
| vcctl [command] -h | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.