From 284df1f621cfe20e88921c94e7ee6aa169b56f7b Mon Sep 17 00:00:00 2001 From: "xin.li" Date: Mon, 26 May 2025 22:24:18 +0800 Subject: [PATCH] [zh-cn] Add config-api/kuberc.v1alpha1 Signed-off-by: xin.li --- .../reference/config-api/kuberc.v1alpha1.md | 319 ++++++++++++++++++ 1 file changed, 319 insertions(+) create mode 100644 content/zh-cn/docs/reference/config-api/kuberc.v1alpha1.md diff --git a/content/zh-cn/docs/reference/config-api/kuberc.v1alpha1.md b/content/zh-cn/docs/reference/config-api/kuberc.v1alpha1.md new file mode 100644 index 0000000000..4563f0aee0 --- /dev/null +++ b/content/zh-cn/docs/reference/config-api/kuberc.v1alpha1.md @@ -0,0 +1,319 @@ +--- +title: kuberc (v1alpha1) +content_type: tool-reference +package: kubectl.config.k8s.io/v1alpha1 +--- + + + +## 资源类型 {#resource-types} + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + +## `Preference` {#kubectl-config-k8s-io-v1alpha1-Preference} + +

+ +Preference 存储 KubeRC 配置文件的元素 +

+ + + + + + + + + + + + + + + + +
字段描述
apiVersion
string		kubectl.config.k8s.io/v1alpha1
kind
string		Preference
overrides [必需]
+[]CommandOverride +		 +

+ +overrides 允许更改命令的默认标志值。 +这对于用户不想每次明确设置标志时特别有用。 +

+
aliases [必需]
+[]AliasOverride +		 +

+ +aliases 允许为现有的 kubectl 命令定义命令别名，并可选择设置默认标志值。 +如果别名与内置命令冲突，内置命令始终优先。 +在 overrides 部分定义的标志覆盖不适用于同一命令的别名。 +kubectl [ALIAS NAME] [USER_FLAGS] [USER_EXPLICIT_ARGS] 展开为 + +```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 + ``` + +例如，如果用户调用 "kubectl runx test-pod" 命令， +这将被展开为 "kubectl run --image=nginx test-pod -- custom-arg1" + ```yaml + - name: getn + command: get + flags: + - name: output + default: wide + prependArgs: + - node + ``` + +

  • "kubectl getn control-plane-1" 扩展为 "kubectl get node control-plane-1 --output=wide"
    • +
  • "kubectl getn control-plane-1 --output=json" 扩展为 "kubectl get node --output=json control-plane-1"
    • +
    +## `AliasOverride` {#kubectl-config-k8s-io-v1alpha1-AliasOverride} + + +**出现在：** + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + +

    + +AliasOverride 存储别名定义。 +

    + + + + + + + + + + + + + + + + + + + + + + + +
    字段描述
    name [必需]
    +string +    		 +

    + +name 是别名的名称，只能包含字母字符。如果别名与内置命令冲突， +将使用内置命令。 +

    +
    command [必需]
    +string +    		 +

    + +command 是要执行的单个或一组命令，例如 "set env" 或 "create" +

    +
    prependArgs [必需]
    +[]string +    		 +

    + +prependArgs 存储如资源名称等参数。 +这些参数插入到别名名称之后。 +

    +
    appendArgs [必需]
    +[]string +    		 +

    + +appendArgs 存储如资源名称等参数。 +这些参数附加到 USER_ARGS 中。 +

    +
    flags [必需]
    +[]CommandOverrideFlag +    		 +

    + +flags 用于存储别名的标志定义。 +flags 只修改标志的默认值，如果用户显式传递一个值，则使用显式值。 +

    +
    + +## `CommandOverride` {#kubectl-config-k8s-io-v1alpha1-CommandOverride} + + +**出现在：** + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + +

    + +CommandOverride 存储命令及其关联标志的默认值。 +

    + + + + + + + + + + + + + + +
    字段描述
    command [必需]
    +string +    		 +

    + +command 指向一个命令，其标志的默认值已更改。 +

    +
    flags [必需]
    +[]CommandOverrideFlag +    		 +

    + +flags 是一个列表，存储不同的默认值。 +

    +
    + +## `CommandOverrideFlag` {#kubectl-config-k8s-io-v1alpha1-CommandOverrideFlag} + + +**出现在：** + +- [AliasOverride](#kubectl-config-k8s-io-v1alpha1-AliasOverride) + +- [CommandOverride](#kubectl-config-k8s-io-v1alpha1-CommandOverride) + + +

    + +CommandOverrideFlag 存储标志的名称和指定的默认值。 +

    + + + + + + + + + + + + + + +
    字段描述
    name [必需]
    +string +    		 +

    + +Flag 名称（长形式，不带破折号）。 +

    +
    default [必需]
    +string +    		 +

    + +在默认值的字符串格式中。它将被 kubectl 解析为标志的兼容值。 +

    +