kuberc (v1beta1)

资源类型

偏好设置

偏好设置存储 KubeRC 配置文件中的元素

字段描述
apiVersion
字符串
kubectl.config.k8s.io/v1beta1
kind
字符串
偏好设置
defaults [必需]
[]CommandDefaults

defaults 允许更改命令的默认选项值。当用户不想每次都显式设置选项时,这非常有用。

aliases [必需]
[]AliasOverride

aliases 允许为现有的 kubectl 命令定义命令别名,并带有可选的默认选项值。如果别名名称与内置命令冲突,则始终使用内置命令。defaults 部分中定义的选项覆盖不适用于相同命令的别名。kubectl [ALIAS NAME] [USER_OPTIONS] [USER_EXPLICIT_ARGS] 将扩展为 kubectl [COMMAND] # 内置命令别名指向 [KUBERC_PREPEND_ARGS] [USER_OPTIONS] [KUBERC_OPTIONS] # 未由用户在 [USER_OPTIONS] [USER_EXPLICIT_ARGS] 中传递的其余选项 [KUBERC_APPEND_ARGS] 例如:

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

    • custom-arg1 例如,如果用户调用 "kubectl runx test-pod" 命令,这将扩展为 "kubectl run --image=nginx test-pod -- custom-arg1"
  • name: getn command: get options
    • 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"
credentialPluginPolicy
CredentialPluginPolicy

credentialPluginPolicy 指定管理哪些(如果有的话)client-go 凭据插件可以执行的策略。它必须是 { "", "AllowAll", "DenyAll", "Allowlist" } 中的一个。如果策略为空字符串 "",则它将回退到 "AllowAll"(这是为了保持向后兼容性所必需的)。如果策略是 DenyAll,则不允许任何凭据插件运行。如果策略是 Allowlist,则只有满足 credentialPluginAllowlist 字段中指定标准的插件才能运行。

credentialPluginAllowlist
[]AllowlistEntry

Allowlist 是一个允许列表条目的切片。如果其中任何一个是匹配项,那么有问题的可执行文件就可以执行。也就是说,结果是允许列表中所有条目的逻辑或。如果策略不是 "Allowlist",则不得提供此列表。

例如 credentialPluginAllowlist

  • name: cloud-provider-plugin
  • name: /usr/local/bin/my-plugin 在上面的示例中,用户允许凭据插件 cloud-provider-plugin(在 PATH 中的某个位置找到),以及在显式路径 /usr/local/bin/my-plugin 处找到的插件。

AliasOverride

出现于

AliasOverride 存储别名定义。

字段描述
name [必需]
字符串

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

command [必需]
字符串

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

prependArgs [必需]
[]string

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

appendArgs [必需]
[]string

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

options [必需]
[]CommandOptionDefault

options 分配用于存储别名的选项定义。options 仅修改选项的默认值,如果用户显式传递了值,则使用显式值。

AllowlistEntry

出现于

AllowlistEntry 是允许列表中的一个条目。对于每个允许列表项,至少必须有一个字段非空。所有字段都为空的结构体被视为配置错误。每个字段都是执行的标准。如果指定了多个字段,则必须满足所有指定字段的标准。也就是说,单个条目的结果是条目内指定字段中所有检查的逻辑与。

字段描述
name [必需]
字符串

通过使用 exec.LookPath 首先解析插件和允许列表条目中的名称的绝对路径来进行名称匹配。它将在两者上调用,并且结果字符串必须相等。如果 exec.LookPath 的任何一个调用导致错误,则 Name 检查将被视为失败。

CommandDefaults

出现于

CommandDefaults 存储命令及其关联选项的默认值。

字段描述
command [必需]
字符串

command 指的是其选项的默认值已更改的命令。

options [必需]
[]CommandOptionDefault

options 是一个列表,用于存储不同的默认值。

CommandOptionDefault

出现于

CommandOptionDefault 存储选项的名称和指定的默认值。

字段描述
name [必需]
字符串

选项名称(长格式,不带破折号)。

default [必需]
字符串

默认值的字符串格式。kubectl 将其解析为与选项兼容的值。

CredentialPluginPolicy

(string 的别名)

出现于

CredentialPluginPolicy 指定管理哪些(如果有的话)client-go 凭据插件可以执行的策略。它必须是 { "", "AllowAll", "DenyAll", "Allowlist" } 中的一个。如果策略为空字符串 "",则它将回退到 "AllowAll"(这是为了保持向后兼容性所必需的)。如果策略是 DenyAll,则不允许任何凭据插件运行。如果策略是 Allowlist,则只有满足 credentialPluginAllowlist 字段中指定标准的插件才能运行。如果策略不是 Allowlist 但提供了,则被视为配置错误。

本页面是自动生成的。

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

上次修改时间:2025 年 12 月 21 日下午 8:51 PST:更新 v1.35 版本的配置 API 参考 (efb02468c4)