kuberc (v1alpha1)

资源类型

偏好设置

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

字段描述
apiVersion
string
kubectl.config.k8s.io/v1alpha1
kind
string
偏好设置
overrides [必需]
[]CommandOverride

overrides 允许更改命令的默认标志值。当用户不想每次都显式设置标志时,这特别有用。

aliases [必需]
[]AliasOverride

aliases 允许为现有的 kubectl 命令定义命令别名,并带有可选的默认标志值。如果别名与内置命令冲突,内置命令将始终优先。在 overrides 部分定义的标志覆盖不会应用于同一命令的别名。kubectl [别名] [用户标志] [用户显式参数] 将展开为 kubectl [命令] # 内置命令别名指向 [KUBERC_PREPEND_ARGS] [用户标志] [KUBERC_FLAGS] # 用户在 [用户标志] 中未传递的其余标志 [用户显式参数] [KUBERC_APPEND_ARGS] 例如:

  • name: runx command: run flags
    • name: image default: nginx appendArgs

    • custom-arg1 例如,如果用户调用 "kubectl runx test-pod" 命令,这将展开为 "kubectl run --image=nginx test-pod -- custom-arg1"
  • name: getn command: get flags
    • name: output default: wide prependArgs
    • "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

出现在

AliasOverride 存储别名定义。

字段描述
name [必填]
string

Name 是别名的名称,只能包含字母字符。如果别名与内置命令冲突,则使用内置命令。

command [必需]
string

Command 是要执行的一个或一组命令,例如 "set env" 或 "create"

prependArgs [必需]
[]string

PrependArgs 存储参数,例如资源名称等。这些参数插入到别名名称之后。

appendArgs [必需]
[]string

AppendArgs 存储参数,例如资源名称等。这些参数将附加到 USER_ARGS。

flags [必需]
[]CommandOverrideFlag

Flag 用于存储别名的标志定义。Flag 仅修改标志的默认值,如果用户显式传递值,则使用显式值。

CommandOverride

出现在

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

字段描述
command [必需]
string

Command 指的是其标志默认值被更改的命令。

flags [必需]
[]CommandOverrideFlag

Flags 是存储不同默认值的标志列表。

CommandOverrideFlag

出现在

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

字段描述
name [必填]
string

标志名称(长格式,不带破折号)。

default [必需]
string

以字符串格式表示的默认值。它将由 kubectl 解析为标志的兼容值。

本页面是自动生成的。

如果你打算报告此页面存在的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

最后修改于 2025 年 5 月 19 日上午 7:35 PST: 添加 kuberc v1alpha1 的配置 API (f92c08c0d2)