资源类型 {#resource-types}
Preference {#kubectl-config-k8s-io-v1beta1-Preference}
<p>
<code>Preference</code> 存储 KubeRC 配置文件的元素。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubectl.config.k8s.io/v1beta1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>Preference</code></td></tr>
<tr><td><code>defaults</code> <B>[必需]</B><br/> <a href="#kubectl-config-k8s-io-v1beta1-CommandDefaults"><code>[]CommandDefaults</code></a> </td> <td> <p>
<code>defaults</code> 允许更改命令的默认选项值。 这对于用户不想每次明确设置选项时特别有用。 </p> </td> </tr> <tr><td><code>aliases</code> <B>[必需]</B><br/> <a href="#kubectl-config-k8s-io-v1beta1-AliasOverride"><code>[]AliasOverride</code></a> </td> <td> <p>
<code>aliases</code> 允许为现有的 kubectl 命令定义命令别名,并可选择设置默认选项值。 如果别名与内置命令冲突,内置命令始终优先。 在 <code>defaults</code> 部分定义的选项 <code>overrides</code> 不适用于同一命令的别名。 <code>kubectl [ALIAS NAME] [USER_OPTIONS] [USER_EXPLICIT_ARGS]</code> 展开为:
kubectl [COMMAND] # 别名指向的内置命令
[KUBERC_PREPEND_ARGS]
[USER_OPTIONS]
[KUBERC_OPTIONS] # 其余未由用户在 [用户选项] 中传递的选项
[USER_EXPLICIT_ARGS]
[KUBERC_APPEND_ARGS]
例如:
- name: runx
command: run
options:
- name: image
default: nginx
appendArgs:
- --
- custom-arg1
例如,如果用户调用 <code>"kubectl runx test-pod"</code> 命令, 这将被展开为 <code>"kubectl run --image=nginx test-pod -- custom-arg1"</code>
- name: getn
command: get
options:
- name: output
default: wide
prependArgs:
- node
<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>
<tr><td><code>credentialPluginPolicy</code><br/> <a href="#kubectl-config-k8s-io-v1beta1-CredentialPluginPolicy"><code>CredentialPluginPolicy</code></a> </td> <td> <p>
<code>credentialPluginPolicy</code> 设置的是一种策略,控制可以执行 client-go 中的哪个凭证插件(如果有的话)。 它必须是 { "","AllowAll","DenyAll","Allowlist" } 中的一个。 如果策略是 "",那么它会回退到 "AllowAll"(这是为了保持向后兼容性所必需的)。 如果策略是 DenyAll,不允许任何凭证插件运行。如果策略是 Allowlist, 只有符合 <code>credentialPluginAllowlist</code> 字段中指定标准的插件才能运行。 </p> </td> </tr> <tr><td><code>credentialPluginAllowlist</code><br/> <a href="#kubectl-config-k8s-io-v1beta1-AllowlistEntry"><code>[]AllowlistEntry</code></a> </td> <td> <p>
<code>credentialPluginAllowlist</code> 是 AllowList 条目的列表。 如果其中任何一个条目匹配,则相关的可执行文件可以执行。 也就是说,结果是对 <code>credentialPluginAllowList</code> 列表中所有条目的逻辑“或”操作。 如果策略不是 "Allowlist",则此列表不得提供。 </p> <p>
例如 credentialPluginAllowlist: </p> <ul> <li>name: cloud-provider-plugin</li> <li>name: /usr/local/bin/my-plugin
在上面的例子中,用户允许凭证插件 <code>cloud-provider-plugin</code> (在 PATH 中的某个位置找到), 以及在确定路径 <code>/usr/local/bin/my-plugin</code> 下找到的插件。 </li> </ul> </td> </tr>
</tbody> </table>
AliasOverride {#kubectl-config-k8s-io-v1beta1-AliasOverride}
出现在:
<p>
<code>AliasOverride</code> 存储别名定义。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 是别名的名称,只能包含字母字符。如果别名与内置命令冲突, 将使用内置命令。 </p> </td> </tr> <tr><td><code>command</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>command</code> 是要执行的单个或一组命令,例如 "set env" 或 "create"。 </p> </td> </tr> <tr><td><code>prependArgs</code> <B>[必需]</B><br/> <code>[]string</code> </td> <td> <p>
<code>prependArgs</code> 存储如资源名称等参数。 这些参数插入到别名名称之后。 </p> </td> </tr> <tr><td><code>appendArgs</code> <B>[必需]</B><br/> <code>[]string</code> </td> <td> <p>
<code>appendArgs</code> 存储如资源名称等参数。 这些参数附加到 USER_ARGS 中。 </p> </td> </tr> <tr><td><code>options</code> <B>[必需]</B><br/> <a href="#kubectl-config-k8s-io-v1beta1-CommandOptionDefault"><code>[]CommandOptionDefault</code></a> </td> <td> <p>
<code>options</code> 用于存储别名的选项定义。 <code>options</code> 只修改选项的默认值,如果用户显式传递一个值,则使用显式值。 </p> </td> </tr> </tbody> </table>
AllowlistEntry {#kubectl-config-k8s-io-v1beta1-AllowlistEntry}
出现在:
<p>
AllowlistEntry 是 allowlist 中的一个条目。 对于每个 allowlist 项,至少需要一个非空字段。 所有字段均为空的结构体被视为配置错误。 每个字段都是一个执行条件。 如果指定了多个字段,则必须满足所有指定字段的条件。 也就是说,单个条目的结果是该条目中所有指定字段对应的检查结果的逻辑与运算结果。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 匹配首先使用 <code>exec.LookPath</code> 解析插件和允许列表条目中名称的绝对路径。 它会对两者分别调用,并且解析结果字符串必须相等。 如果其中任何一个 <code>exec.LookPath</code> 调用导致错误, 则 <code>name</code> 检查将被视为失败。 </p> <p>
已弃用:请改用 <code>command</code>。 </p> </td> </tr> <tr><td><code>command</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>command</code> 匹配首先使用 <code>exec.LookPath</code> 解析插件和允许列表条目中名称的绝对路径。 它会对两者分别调用,并且解析结果字符串必须相等。 如果其中任何一个 <code>exec.LookPath</code> 调用导致错误, 则 <code>command</code> 检查将被视为失败。 </p> </td> </tr> </tbody> </table>
CommandDefaults {#kubectl-config-k8s-io-v1beta1-CommandDefaults}
出现在:
<p>
<code>CommandDefaults</code> 存储命令及其关联参数的默认值。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>command</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>command</code> 指向一个命令,其选项的默认值已更改。 </p> </td> </tr> <tr><td><code>options</code> <B>[必需]</B><br/> <a href="#kubectl-config-k8s-io-v1beta1-CommandDefaults"><code>[]CommandDefaults</code></a> </td> <td> <p>
<code>options</code> 是一个选项的列表,存储不同的默认值。 </p> </td> </tr> </tbody> </table>
CommandOptionDefault {#kubectl-config-k8s-io-v1beta1-CommandOptionDefault}
出现在:
<p>
<code>CommandOptionDefault</code> 存储参数的名称和指定的默认值。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>option</code> 名称(长形式,不带破折号)。 </p> </td> </tr> <tr><td><code>default</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
在默认值的字符串格式中。它将被 kubectl 解析为选项的兼容值。 </p> </td> </tr> </tbody> </table>
CredentialPluginPolicy {#kubectl-config-k8s-io-v1beta1-CredentialPluginPolicy}
(string 的别名)
出现在:
<p>
<code>credentialPluginPolicy</code> 指定的是一种策略,控制执行哪些 client-go 凭证插件(如果有的话)。 取值必须是 { "", "AllowAll", "DenyAll", "Allowlist" } 中的一个。 如果策略是 "",那么它会回退到 "AllowAll"(这是为了保持向后兼容性所必需的)。 如果策略是 DenyAll,不允许任何凭证插件运行。 如果策略是 Allowlist,只有那些满足 <code>credentialPluginAllowlist</code> 字段中指定条件的插件才能运行。 如果策略不是 <code>Allowlist</code> 但是提供了 <code>credentialPluginAllowList</code>,将被视为配置错误。 </p>
来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。
