[zh-cn] Add config-api/kuberc.v1alpha1
Signed-off-by: xin.li <xin.li@daocloud.io>pull/51075/head
xin.li
parent
7f7fdfacb8
commit
284df1f621
|
|
@ -0,0 +1,319 @@
|
|||
---
|
||||
title: kuberc (v1alpha1)
|
||||
content_type: tool-reference
|
||||
package: kubectl.config.k8s.io/v1alpha1
|
||||
---
|
||||
<!--
|
||||
title: kuberc (v1alpha1)
|
||||
content_type: tool-reference
|
||||
package: kubectl.config.k8s.io/v1alpha1
|
||||
auto_generated: true
|
||||
-->
|
||||
|
||||
<!--
|
||||
## Resource Types
|
||||
-->
|
||||
## 资源类型 {#resource-types}
|
||||
|
||||
- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference)
|
||||
|
||||
## `Preference` {#kubectl-config-k8s-io-v1alpha1-Preference}
|
||||
|
||||
<p>
|
||||
<!--
|
||||
Preference stores elements of KubeRC configuration file
|
||||
-->
|
||||
Preference 存储 KubeRC 配置文件的元素
|
||||
</p>
|
||||
|
||||
<table class="table">
|
||||
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
|
||||
<tbody>
|
||||
|
||||
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubectl.config.k8s.io/v1alpha1</code></td></tr>
|
||||
<tr><td><code>kind</code><br/>string</td><td><code>Preference</code></td></tr>
|
||||
|
||||
|
||||
<tr><td><code>overrides</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<a href="#kubectl-config-k8s-io-v1alpha1-CommandOverride"><code>[]CommandOverride</code></a>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
overrides allows changing default flag values of commands.
|
||||
This is especially useful, when user doesn't want to explicitly
|
||||
set flags each time.
|
||||
-->
|
||||
overrides 允许更改命令的默认标志值。
|
||||
这对于用户不想每次明确设置标志时特别有用。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>aliases</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<a href="#kubectl-config-k8s-io-v1alpha1-AliasOverride"><code>[]AliasOverride</code></a>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
aliases allows defining command aliases for existing kubectl commands, with optional default flag values.
|
||||
If the alias name collides with a built-in command, built-in command always takes precedence.
|
||||
Flag overrides defined in the overrides section do NOT apply to aliases for the same command.
|
||||
kubectl [ALIAS NAME] [USER_FLAGS] [USER_EXPLICIT_ARGS] expands to
|
||||
kubectl [COMMAND] # built-in command alias points to
|
||||
[KUBERC_PREPEND_ARGS]
|
||||
[USER_FLAGS]
|
||||
[KUBERC_FLAGS] # rest of the flags that are not passed by user in [USER_FLAGS]
|
||||
[USER_EXPLICIT_ARGS]
|
||||
[KUBERC_APPEND_ARGS]
|
||||
e.g.
|
||||
-->
|
||||
aliases 允许为现有的 kubectl 命令定义命令别名，并可选择设置默认标志值。
|
||||
如果别名与内置命令冲突，内置命令始终优先。
|
||||
在 overrides 部分定义的标志覆盖不适用于同一命令的别名。
|
||||
<code>kubectl [ALIAS NAME] [USER_FLAGS] [USER_EXPLICIT_ARGS]</code> 展开为
|
||||
|
||||
```bash
|
||||
kubectl [COMMAND] # 别名指向的内置命令
|
||||
[KUBERC_PREPEND_ARGS]
|
||||
[USER_FLAGS]
|
||||
[KUBERC_FLAGS] # 其余未由用户在 [用户标志] 中传递的标志
|
||||
[USER_EXPLICIT_ARGS]
|
||||
[KUBERC_APPEND_ARGS]
|
||||
|
||||
```
|
||||
|
||||
例如：
|
||||
|
||||
```yaml
|
||||
- name: runx
|
||||
command: run
|
||||
flags:
|
||||
- name: image
|
||||
default: nginx
|
||||
appendArgs:
|
||||
- --
|
||||
- custom-arg1
|
||||
```
|
||||
<!--
|
||||
For example, if user invokes "kubectl runx test-pod" command,
|
||||
this will be expanded to "kubectl run --image=nginx test-pod -- custom-arg1"
|
||||
-->
|
||||
例如，如果用户调用 <code>"kubectl runx test-pod"</code> 命令，
|
||||
这将被展开为 <code>"kubectl run --image=nginx test-pod -- custom-arg1"</code>
|
||||
```yaml
|
||||
- name: getn
|
||||
command: get
|
||||
flags:
|
||||
- name: output
|
||||
default: wide
|
||||
prependArgs:
|
||||
- node
|
||||
```
|
||||
<!--
|
||||
"kubectl getn control-plane-1" expands to "kubectl get node control-plane-1 --output=wide"
|
||||
"kubectl getn control-plane-1 --output=json" expands to "kubectl get node --output=json control-plane-1"
|
||||
-->
|
||||
<li><code>"kubectl getn control-plane-1" 扩展为 "kubectl get node control-plane-1 --output=wide"</code></li>
|
||||
<li><code>"kubectl getn control-plane-1 --output=json" 扩展为 "kubectl get node --output=json control-plane-1"</code></li>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
## `AliasOverride` {#kubectl-config-k8s-io-v1alpha1-AliasOverride}
|
||||
|
||||
<!--
|
||||
**Appears in:**
|
||||
-->
|
||||
**出现在：**
|
||||
|
||||
- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference)
|
||||
|
||||
<p>
|
||||
<!--
|
||||
AliasOverride stores the alias definitions.
|
||||
-->
|
||||
AliasOverride 存储别名定义。
|
||||
</p>
|
||||
|
||||
|
||||
<table class="table">
|
||||
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr><td><code>name</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Name is the name of alias that can only include alphabetical characters
|
||||
If the alias name conflicts with the built-in command,
|
||||
built-in command will be used.
|
||||
-->
|
||||
name 是别名的名称，只能包含字母字符。如果别名与内置命令冲突，
|
||||
将使用内置命令。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>command</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Command is the single or set of commands to execute, such as "set env" or "create"
|
||||
-->
|
||||
command 是要执行的单个或一组命令，例如 "set env" 或 "create"
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>prependArgs</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>[]string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
PrependArgs stores the arguments such as resource names, etc.
|
||||
These arguments are inserted after the alias name.
|
||||
-->
|
||||
prependArgs 存储如资源名称等参数。
|
||||
这些参数插入到别名名称之后。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>appendArgs</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>[]string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
AppendArgs stores the arguments such as resource names, etc.
|
||||
These arguments are appended to the USER_ARGS.
|
||||
-->
|
||||
appendArgs 存储如资源名称等参数。
|
||||
这些参数附加到 USER_ARGS 中。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>flags</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<a href="#kubectl-config-k8s-io-v1alpha1-CommandOverrideFlag"><code>[]CommandOverrideFlag</code></a>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Flag is allocated to store the flag definitions of alias.
|
||||
Flag only modifies the default value of the flag and if
|
||||
user explicitly passes a value, explicit one is used.
|
||||
-->
|
||||
flags 用于存储别名的标志定义。
|
||||
flags 只修改标志的默认值，如果用户显式传递一个值，则使用显式值。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## `CommandOverride` {#kubectl-config-k8s-io-v1alpha1-CommandOverride}
|
||||
|
||||
<!--
|
||||
**Appears in:**
|
||||
-->
|
||||
**出现在：**
|
||||
|
||||
- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference)
|
||||
|
||||
<p>
|
||||
<!--
|
||||
CommandOverride stores the commands and their associated flag's
|
||||
default values.
|
||||
-->
|
||||
CommandOverride 存储命令及其关联标志的默认值。
|
||||
</p>
|
||||
|
||||
|
||||
<table class="table">
|
||||
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr><td><code>command</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Command refers to a command whose flag's default value is changed.
|
||||
-->
|
||||
command 指向一个命令，其标志的默认值已更改。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>flags</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<a href="#kubectl-config-k8s-io-v1alpha1-CommandOverrideFlag"><code>[]CommandOverrideFlag</code></a>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Flags is a list of flags storing different default values.
|
||||
-->
|
||||
flags 是一个列表，存储不同的默认值。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## `CommandOverrideFlag` {#kubectl-config-k8s-io-v1alpha1-CommandOverrideFlag}
|
||||
|
||||
<!--
|
||||
**Appears in:**
|
||||
-->
|
||||
**出现在：**
|
||||
|
||||
- [AliasOverride](#kubectl-config-k8s-io-v1alpha1-AliasOverride)
|
||||
|
||||
- [CommandOverride](#kubectl-config-k8s-io-v1alpha1-CommandOverride)
|
||||
|
||||
|
||||
<p>
|
||||
<!--
|
||||
CommandOverrideFlag stores the name and the specified default
|
||||
value of the flag.
|
||||
-->
|
||||
CommandOverrideFlag 存储标志的名称和指定的默认值。
|
||||
</p>
|
||||
|
||||
|
||||
<table class="table">
|
||||
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr><td><code>name</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
Flag name (long form, without dashes).
|
||||
-->
|
||||
Flag 名称（长形式，不带破折号）。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><code>default</code> <B><!--[Required]-->[必需]</B><br/>
|
||||
<code>string</code>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
<!--
|
||||
In a string format of a default value. It will be parsed
|
||||
by kubectl to the compatible value of the flag.
|
||||
-->
|
||||
在默认值的字符串格式中。它将被 kubectl 解析为标志的兼容值。
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
Loading…
Reference in New Issue