Pod

Pod 是可以在主机上运行的容器集合。

apiVersion: v1

import "k8s.io/api/core/v1"

Pod

Pod 是可以在主机上运行的容器集合。此资源由客户端创建并调度到主机上。


PodSpec

PodSpec 是对 Pod 的描述。


容器

  • containers ([]Container), 必需

    修补策略:按键 name 合并

    属于 Pod 的容器列表。容器当前无法添加或删除。Pod 中必须至少有一个容器。不能更新。

  • initContainers ([]Container)

    修补策略:按键 name 合并

    属于 Pod 的初始化容器列表。初始化容器在容器启动之前按顺序执行。如果任何初始化容器失败,则 Pod 被视为已失败,并根据其重启策略进行处理。初始化容器或普通容器的名称在所有容器中必须唯一。初始化容器可能没有生命周期操作、就绪探测、存活探测或启动探测。初始化容器的资源需求在调度期间被考虑在内,方法是找到每个资源类型的最高请求/限制,然后使用该值或普通容器总和的最大值。限制以类似方式应用于初始化容器。初始化容器当前无法添加或删除。不能更新。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/init-containers/

  • ephemeralContainers ([]EphemeralContainer)

    修补策略:按键 name 合并

    在该 Pod 中运行的瞬态容器列表。瞬态容器可以在现有 Pod 中运行以执行用户发起的操作,例如调试。创建 Pod 时不能指定此列表,也不能通过更新 Pod 规范来修改它。为了向现有 Pod 添加瞬态容器,请使用 Pod 的 ephemeralcontainers 子资源。

  • imagePullSecrets ([]LocalObjectReference)

    修补策略:按键 name 合并

    ImagePullSecrets 是对同一命名空间中用于拉取此 PodSpec 使用的任何镜像的秘密的可选引用列表。如果指定,这些秘密将传递给各个拉取程序实现,供它们使用。更多信息:https://kubernetes.ac.cn/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

  • enableServiceLinks (布尔值)

    EnableServiceLinks 指示是否应将有关服务的信息注入 Pod 的环境变量中,匹配 Docker 链接的语法。可选:默认为 true。

  • os (PodOS)

    指定 Pod 中容器的操作系统。如果设置了此选项,一些 Pod 和容器字段将受到限制。

    如果 OS 字段设置为 linux,则以下字段必须取消设置:-securityContext.windowsOptions

    如果 OS 字段设置为 windows,则以下字段必须取消设置:- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup

    PodOS 定义了 Pod 的 OS 参数。

调度

  • nodeSelector (map[string]string)

    NodeSelector 是一个选择器,Pod 必须满足才能适合某个节点。选择器必须匹配节点的标签,Pod 才能调度到该节点上。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/assign-pod-node/

  • nodeName (字符串)

    NodeName 是将此 Pod 调度到特定节点的请求。如果它是非空的,调度程序将简单地将此 Pod 调度到该节点上,假设它适合资源需求。

  • affinity (Affinity)

    如果指定,则 Pod 的调度约束

    Affinity 是一组亲和力调度规则。

    • affinity.nodeAffinity (NodeAffinity)

      描述 Pod 的节点亲和力调度规则。

    • affinity.podAffinity (PodAffinity)

      描述 Pod 亲和力调度规则(例如,将此 Pod 与其他一些 Pod 放置在同一个节点、区域等)。

    • affinity.podAntiAffinity (PodAntiAffinity)

      描述 Pod 反亲和力调度规则(例如,避免将此 Pod 与其他一些 Pod 放置在同一个节点、区域等)。

  • tolerations ([]Toleration)

    如果指定,则 Pod 的容忍度。

    此 Toleration 附加到的 Pod 容忍任何与使用匹配运算符 的三元组 匹配的污点。

    • tolerations.key (字符串)

      Key 是容忍度适用的污点键。空表示匹配所有污点键。如果键为空,则运算符必须为 Exists;此组合表示匹配所有值和所有键。

    • tolerations.operator (字符串)

      Operator 表示键与值的关系。有效的运算符是 Exists 和 Equal。默认为 Equal。Exists 等同于值的通配符,因此 Pod 可以容忍特定类别的所有污点。

    • tolerations.value (字符串)

      Value 是容忍度匹配的污点值。如果运算符为 Exists,则该值应为空,否则只是一个普通字符串。

    • tolerations.effect (字符串)

      Effect 指示要匹配的污点效果。空表示匹配所有污点效果。指定时,允许的值为 NoSchedule、PreferNoSchedule 和 NoExecute。

    • tolerations.tolerationSeconds (int64)

      TolerationSeconds 表示容忍度(必须具有 NoExecute 效果,否则此字段将被忽略)容忍污点的持续时间。默认情况下,它未设置,这意味着永远容忍污点(不要驱逐)。系统将把零和负值视为 0(立即驱逐)。

  • schedulerName (字符串)

    如果指定,则 Pod 将由指定的调度程序调度。如果未指定,则 Pod 将由默认调度程序调度。

  • runtimeClassName (字符串)

    RuntimeClassName 指向 node.k8s.io 组中的 RuntimeClass 对象,应使用它来运行此 Pod。如果没有任何 RuntimeClass 资源匹配命名的类,则不会运行 Pod。如果未设置或为空,则将使用“legacy”RuntimeClass,它是一个隐式类,具有空的定义,使用默认运行时处理程序。更多信息:https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class

  • priorityClassName (字符串)

    如果指定,则指示 Pod 的优先级。“system-node-critical” 和 “system-cluster-critical” 是两个特殊的关键字,它们指示最高优先级,前者是最高优先级。任何其他名称都必须通过创建具有该名称的 PriorityClass 对象来定义。如果未指定,则 Pod 优先级将为默认值或零(如果不存在默认值)。

  • priority (int32)

    优先级值。各种系统组件使用此字段查找 Pod 的优先级。启用优先级准入控制器后,它将阻止用户设置此字段。准入控制器从 PriorityClassName 填充此字段。值越大,优先级越高。

  • preemptionPolicy (字符串)

    PreemptionPolicy 是抢占具有较低优先级的 Pod 的策略。Never、PreemptLowerPriority 之一。如果未设置,则默认为 PreemptLowerPriority。

  • topologySpreadConstraints ([]TopologySpreadConstraint)

    修补策略:按键 topologyKey 合并

    映射:键 topologyKey, whenUnsatisfiable 上的唯一值将在合并期间保留

    TopologySpreadConstraints 描述了一组 Pod 如何在拓扑域中分布。调度程序将以遵守约束的方式调度 Pod。所有 topologySpreadConstraints 都按 AND 连接。

    TopologySpreadConstraint 指定如何在一组给定的拓扑中分布匹配的 Pod。

    • topologySpreadConstraints.maxSkew (int32), 必需

      MaxSkew 描述了 Pod 分布不均匀的程度。当 whenUnsatisfiable=DoNotSchedule 时,它是目标拓扑中匹配 Pod 数量与全局最小值之间允许的最大差异。全局最小值是在合格域中匹配 Pod 的最小数量,如果合格域的数量小于 MinDomains 则为零。例如,在 3 个区域的集群中,MaxSkew 设置为 1,具有相同 labelSelector 的 Pod 分布为 2/2/1:在这种情况下,全局最小值为 1。| zone1 | zone2 | zone3 | | P P | P P | P | - 如果 MaxSkew 为 1,则传入 Pod 只能调度到 zone3 以变为 2/2/2;将其调度到 zone1(zone2) 将使 zone1(zone2) 上的 ActualSkew(3-1) 违反 MaxSkew(1)。 - 如果 MaxSkew 为 2,则传入 Pod 可以调度到任何区域。当 whenUnsatisfiable=ScheduleAnyway 时,它用于给予满足它的拓扑更高的优先级。这是一个必填字段。默认值为 1,不允许为 0。

    • topologySpreadConstraints.topologyKey (string), 必需

      TopologyKey 是节点标签的键。具有此键和相同值的标签的节点被认为在同一拓扑中。我们将每个 <key, value> 视为一个“桶”,并尝试将平衡数量的 Pod 放入每个桶中。我们将域定义为拓扑的特定实例。此外,我们将合格域定义为满足 nodeAffinityPolicy 和 nodeTaintsPolicy 要求的域。例如,如果 TopologyKey 为“kubernetes.io/hostname”,则每个节点都是该拓扑的域。并且,如果 TopologyKey 为“topology.kubernetes.io/zone”,则每个区域都是该拓扑的域。这是一个必填字段。

    • topologySpreadConstraints.whenUnsatisfiable (string), 必需

      WhenUnsatisfiable 指示如果 Pod 不满足扩散约束,如何处理它。 - DoNotSchedule(默认)告诉调度程序不要调度它。 - ScheduleAnyway 告诉调度程序在任何位置调度 Pod,但优先考虑有助于减少偏差的拓扑。当且仅当传入 Pod 的所有可能节点分配都会在某些拓扑上违反“MaxSkew”时,约束被认为是“不可满足的”。例如,在 3 个区域的集群中,MaxSkew 设置为 1,具有相同 labelSelector 的 Pod 分布为 3/1/1:| zone1 | zone2 | zone3 | | P P P | P | P | 如果 WhenUnsatisfiable 设置为 DoNotSchedule,则传入 Pod 只能调度到 zone2(zone3) 以变为 3/2/1(3/1/2),因为 zone2(zone3) 上的 ActualSkew(2-1) 满足 MaxSkew(1)。换句话说,集群仍然可以不平衡,但调度程序不会使其变得 *更* 不平衡。这是一个必填字段。

    • topologySpreadConstraints.labelSelector (LabelSelector)

      LabelSelector 用于查找匹配的 Pod。匹配此标签选择器的 Pod 将被计算,以确定它们在对应拓扑域中的 Pod 数量。

    • topologySpreadConstraints.matchLabelKeys ([]string)

      原子:在合并期间将被替换

      MatchLabelKeys 是一组 Pod 标签键,用于选择将对其计算扩散的 Pod。这些键用于从传入 Pod 标签中查找值,这些键值标签与 labelSelector 进行 AND 操作,以选择将针对传入 Pod 计算扩散的现有 Pod 组。禁止在 MatchLabelKeys 和 LabelSelector 中同时存在相同的键。当未设置 LabelSelector 时,不能设置 MatchLabelKeys。传入 Pod 标签中不存在的键将被忽略。空列表或空列表意味着仅与 labelSelector 匹配。

      这是一个 beta 字段,需要启用 MatchLabelKeysInPodTopologySpread 功能门(默认情况下已启用)。

    • topologySpreadConstraints.minDomains (int32)

      MinDomains 指示合格域的最小数量。当具有匹配拓扑键的合格域数量小于 minDomains 时,Pod 拓扑扩散将“全局最小值”视为 0,然后执行 Skew 的计算。当具有匹配拓扑键的合格域数量等于或大于 minDomains 时,此值对调度没有任何影响。因此,当合格域的数量小于 minDomains 时,调度程序不会调度超过 maxSkew 个 Pod 到这些域。如果值为 nil,则约束的行为就好像 MinDomains 等于 1 一样。有效值为大于 0 的整数。当值不为 nil 时,WhenUnsatisfiable 必须为 DoNotSchedule。

      例如,在 3 个区域的集群中,MaxSkew 设置为 2,MinDomains 设置为 5,具有相同 labelSelector 的 Pod 分布为 2/2/2:| zone1 | zone2 | zone3 | | P P | P P | P P | 域的数量小于 5(MinDomains),因此“全局最小值”被视为 0。在这种情况下,无法调度具有相同 labelSelector 的新 Pod,因为如果新 Pod 调度到三个区域中的任何一个,则计算出的偏差将为 3(3 - 0),这将违反 MaxSkew。

      这是一个 beta 字段,需要启用 MinDomainsInPodTopologySpread 功能门(默认情况下已启用)。

    • topologySpreadConstraints.nodeAffinityPolicy (string)

      NodeAffinityPolicy 指示我们在计算 Pod 拓扑扩散偏差时如何处理 Pod 的 nodeAffinity/nodeSelector。选项包括: - Honor:仅包含匹配 nodeAffinity/nodeSelector 的节点。 - Ignore:忽略 nodeAffinity/nodeSelector。所有节点都包含在计算中。

      如果此值为 nil,则行为等同于 Honor 策略。这是一个由 NodeInclusionPolicyInPodTopologySpread 功能标志默认启用的 beta 级功能。

    • topologySpreadConstraints.nodeTaintsPolicy (string)

      NodeTaintsPolicy 指示我们在计算 Pod 拓扑扩散偏差时如何处理节点污点。选项包括: - Honor:包含没有污点的节点以及传入 Pod 具有容忍度的污点节点。 - Ignore:忽略节点污点。所有节点都包含在内。

      如果此值为 nil,则行为等同于 Ignore 策略。这是一个由 NodeInclusionPolicyInPodTopologySpread 功能标志默认启用的 beta 级功能。

  • overhead (map[string]Quantity)

    Overhead 表示与为给定 RuntimeClass 运行 Pod 相关的资源开销。此字段将在准入时由 RuntimeClass 准入控制器自动填充。如果启用了 RuntimeClass 准入控制器,则不得在 Pod 创建请求中设置开销。RuntimeClass 准入控制器将拒绝已设置开销的 Pod 创建请求。如果在 PodSpec 中配置并选择了 RuntimeClass,则 Overhead 将设置为对应 RuntimeClass 中定义的值,否则它将保持未设置状态并被视为零。更多信息:https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

生命周期

  • restartPolicy (string)

    Pod 中所有容器的重启策略。Always、OnFailure 或 Never 之一。在某些情况下,可能只允许这些值的一部分。默认值为 Always。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

  • terminationGracePeriodSeconds (int64)

    Pod 需要优雅终止的可选持续时间(以秒为单位)。可以在删除请求中减少。值必须是非负整数。值为零表示通过 kill 信号立即停止(没有关闭的机会)。如果此值为 nil,则将使用默认的宽限期。宽限期是在向 Pod 中运行的进程发送终止信号后到强制使用 kill 信号停止进程之间的持续时间(以秒为单位)。将此值设置为比进程的预期清理时间更长。默认值为 30 秒。

  • activeDeadlineSeconds (int64)

    Pod 相对于 StartTime 在节点上可以处于活动状态的可选持续时间(以秒为单位),在此之后,系统将主动尝试将其标记为失败并杀死相关容器。值必须是正整数。

  • readinessGates ([]PodReadinessGate)

    如果指定,所有就绪门将被评估以确定 Pod 是否就绪。当 Pod 中的所有容器都就绪,并且就绪门中指定的所有条件的状态都等于“True”时,Pod 就绪。更多信息:https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

    PodReadinessGate 包含对 Pod 条件的引用

    • readinessGates.conditionType (string), 必需

      ConditionType 指的是 Pod 条件列表中与类型匹配的条件。

主机名和名称解析

  • hostname (string)

    指定 Pod 的主机名。如果未指定,Pod 的主机名将设置为系统定义的值。

  • setHostnameAsFQDN (boolean)

    如果为 true,则 Pod 的主机名将配置为 Pod 的 FQDN,而不是叶节点名称(默认值)。在 Linux 容器中,这意味着在内核的主机名字段(struct utsname 的 nodename 字段)中设置 FQDN。在 Windows 容器中,这意味着将注册表键 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters 的主机名注册表值设置为 FQDN。如果 Pod 没有 FQDN,则此设置无效。默认值为 false。

  • subdomain (string)

    如果指定,则完全限定的 Pod 主机名将为“<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>”。如果未指定,则 Pod 将根本没有域名。

  • hostAliases ([]HostAlias)

    补丁策略:按键 ip 合并

    HostAliases 是一个可选的列表,其中包含将被注入到 Pod 的 hosts 文件中的主机和 IP(如果指定)。这仅对非 hostNetwork Pod 有效。

    HostAlias 包含 IP 和主机名之间的映射,这些映射将被注入为 Pod 的 hosts 文件中的条目。

    • hostAliases.hostnames ([]string)

      上面 IP 地址的主机名。

    • hostAliases.ip (string)

      主机文件条目的 IP 地址。

  • dnsConfig (PodDNSConfig)

    指定 Pod 的 DNS 参数。此处指定的参数将根据 DNSPolicy 合并到生成的 DNS 配置中。

    PodDNSConfig 定义了 Pod 的 DNS 参数,此外还包括根据 DNSPolicy 生成的参数。

    • dnsConfig.nameservers ([]string)

      DNS 命名服务器 IP 地址列表。这将附加到根据 DNSPolicy 生成的基本命名服务器。重复的命名服务器将被删除。

    • dnsConfig.options ([]PodDNSConfigOption)

      DNS 解析器选项列表。这将与根据 DNSPolicy 生成的基本选项合并。重复的条目将被删除。Options 中给出的解析选项将覆盖出现在基本 DNSPolicy 中的选项。

      PodDNSConfigOption 定义了 Pod 的 DNS 解析器选项。

      • dnsConfig.options.name (string)

        必需。

      • dnsConfig.options.value (string)

    • dnsConfig.searches ([]string)

      主机名查找的 DNS 搜索域列表。这将附加到根据 DNSPolicy 生成的基本搜索路径。重复的搜索路径将被删除。

  • dnsPolicy (string)

    设置 Pod 的 DNS 策略。默认为“ClusterFirst”。有效值为“ClusterFirstWithHostNet”、“ClusterFirst”、“Default”或“None”。DNSConfig 中给出的 DNS 参数将与使用 DNSPolicy 选择的策略合并。要将 DNS 选项与 hostNetwork 一起设置,您必须将 DNS 策略明确指定为“ClusterFirstWithHostNet”。

主机命名空间

  • hostNetwork (boolean)

    此 Pod 请求的主机网络。使用主机的网络命名空间。如果设置了此选项,则必须指定将使用的端口。默认值为 false。

  • hostPID (布尔值)

    使用主机的 pid 命名空间。可选:默认值为 false。

  • hostIPC (布尔值)

    使用主机的 ipc 命名空间。可选:默认值为 false。

  • shareProcessNamespace (布尔值)

    在 pod 中的所有容器之间共享一个进程命名空间。当设置此选项时,容器将能够查看和发送信号到同一 pod 中其他容器的进程,并且每个容器中的第一个进程不会被分配 PID 1。HostPID 和 ShareProcessNamespace 不能同时设置。可选:默认值为 false。

服务账户

安全上下文

  • securityContext (PodSecurityContext)

    SecurityContext 包含 pod 级别的安全属性和通用容器设置。可选:默认为空。有关每个字段的默认值,请参见类型说明。

    PodSecurityContext 包含 pod 级别的安全属性和通用容器设置。某些字段也存在于 container.securityContext 中。container.securityContext 的字段值优先于 PodSecurityContext 的字段值。

    • securityContext.runAsUser (int64)

      用于运行容器进程入口点的 UID。如果未指定,则默认为映像元数据中指定的用户。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

    • securityContext.runAsNonRoot (布尔值)

      指示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证映像以确保它不以 UID 0(root)身份运行,如果运行,则会失败启动容器。如果未设置或为 false,则不会执行此类验证。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。

    • securityContext.runAsGroup (int64)

      用于运行容器进程入口点的 GID。如果未设置,则使用运行时默认值。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

    • securityContext.supplementalGroups ([]int64)

      除了容器的主要 GID、fsGroup(如果指定)以及容器映像为容器进程的 uid 定义的组成员资格之外,应用于每个容器中运行的第一个进程的组列表。如果未指定,则不会向任何容器添加额外的组。请注意,容器映像为容器进程的 uid 定义的组成员资格仍然有效,即使它们未包含在此列表中。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

    • securityContext.fsGroup (int64)

      应用于 pod 中所有容器的特殊补充组。某些卷类型允许 Kubelet 将该卷的所有权更改为 pod 所有。

      1. 拥有 GID 将是 FSGroup 2。设置了 setgid 位(在卷中创建的新文件将由 FSGroup 拥有)3。权限位将与 rw-rw---- 进行 OR 操作。

      如果未设置,Kubelet 将不会修改任何卷的所有权和权限。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

    • securityContext.fsGroupChangePolicy (字符串)

      fsGroupChangePolicy 定义在卷在 Pod 中公开之前更改所有权和权限的行为。此字段仅适用于支持基于 fsGroup 的所有权(和权限)的卷类型。它对瞬态卷类型(例如:secret、configmaps 和 emptydir)没有影响。有效值为“OnRootMismatch”和“Always”。如果未指定,则使用“Always”。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

    • securityContext.seccompProfile (SeccompProfile)

      此 pod 中容器使用的 seccomp 选项。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

      SeccompProfile 定义 pod/容器的 seccomp 配置文件设置。只能设置一个配置文件源。

      • securityContext.seccompProfile.type (字符串),必需

        type 指示将应用哪种 seccomp 配置文件。有效选项为

        Localhost - 应使用节点上文件中定义的配置文件。RuntimeDefault - 应使用容器运行时默认配置文件。Unconfined - 不应应用任何配置文件。

      • securityContext.seccompProfile.localhostProfile (字符串)

        localhostProfile 指示应使用节点上文件中定义的配置文件。该配置文件必须在节点上预先配置才能正常工作。必须是相对于 kubelet 配置的 seccomp 配置文件位置的下降路径。如果类型为“Localhost”,则必须设置。对于任何其他类型,必须不设置。

    • securityContext.seLinuxOptions (SELinuxOptions)

      要应用于所有容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配随机 SELinux 上下文。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

      SELinuxOptions 是要应用于容器的标签。

      • securityContext.seLinuxOptions.level (字符串)

        Level 是应用于容器的 SELinux 级别标签。

      • securityContext.seLinuxOptions.role (字符串)

        Role 是应用于容器的 SELinux 角色标签。

      • securityContext.seLinuxOptions.type (字符串)

        Type 是应用于容器的 SELinux 类型标签。

      • securityContext.seLinuxOptions.user (字符串)

        User 是应用于容器的 SELinux 用户标签。

    • securityContext.sysctls ([]Sysctl)

      Sysctls 持有一个用于 pod 的命名空间 sysctls 列表。具有不受支持的 sysctls(由容器运行时)的 pod 可能会启动失败。请注意,当 spec.os.name 为 windows 时,无法设置此字段。

      Sysctl 定义要设置的内核参数。

      • securityContext.sysctls.name (字符串),必需

        要设置的属性的名称。

      • securityContext.sysctls.value (字符串),必需

        要设置的属性的值。

    • securityContext.windowsOptions (WindowsSecurityContextOptions)

      应用于所有容器的 Windows 特定设置。如果未指定,则将使用容器 SecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 为 linux 时,无法设置此字段。

      WindowsSecurityContextOptions 包含 Windows 特定的选项和凭据。

      • securityContext.windowsOptions.gmsaCredentialSpec (字符串)

        GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa) 在其中内联由 GMSACredentialSpecName 字段命名的 GMSA 凭据规范内容的位置。

      • securityContext.windowsOptions.gmsaCredentialSpecName (字符串)

        GMSACredentialSpecName 是要使用的 GMSA 凭据规范的名称。

      • securityContext.windowsOptions.hostProcess (布尔值)

        HostProcess 确定容器是否应作为“主机进程”容器运行。Pod 的所有容器必须具有相同的有效 HostProcess 值(不允许混合 HostProcess 容器和非 HostProcess 容器)。此外,如果 HostProcess 为 true,则 HostNetwork 也必须设置为 true。

      • securityContext.windowsOptions.runAsUserName (字符串)

        Windows 中用于运行容器进程入口点的用户名。如果未指定,则默认为映像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。

Alpha 级别

  • hostUsers (布尔值)

    使用主机的用户命名空间。可选:默认值为 true。如果设置为 true 或不存在,则 pod 将在主机用户命名空间中运行,这对于 pod 需要主机用户命名空间中才有的功能时很有用,例如使用 CAP_SYS_MODULE 加载内核模块。当设置为 false 时,将为 pod 创建一个新的 userns。设置 false 对于减轻容器突破漏洞很有用,即使允许用户以 root 身份运行他们的容器,也不需要在主机上拥有 root 权限。此字段为 alpha 级别,仅由启用 UserNamespacesSupport 功能的服务器认可。

  • resourceClaims ([]PodResourceClaim)

    修补策略:保留键,按键 name 合并

    映射:合并期间将保留键名称上的唯一值。

    ResourceClaims 定义在允许 Pod 启动之前必须分配和保留哪些 ResourceClaims。这些资源将通过名称提供给使用它们的容器。

    这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能网关。

    此字段是不可变的。

    PodResourceClaim 通过 ClaimSource 引用 exactly one ResourceClaim。它为其添加了一个名称,该名称在 Pod 中唯一地标识 ResourceClaim。需要访问 ResourceClaim 的容器使用此名称引用它。

    • resourceClaims.name (字符串),必需

      Name 在 pod 中唯一地标识此资源声明。这必须是 DNS_LABEL。

    • resourceClaims.source (ClaimSource)

      Source 描述在何处查找 ResourceClaim。

      *ClaimSource 描述对 ResourceClaim 的引用。

      这些字段中应该正好设置一个。此类型的使用者必须将空对象视为具有未知值。*

      • resourceClaims.source.resourceClaimName (字符串)

        ResourceClaimName 是与该 pod 位于同一命名空间中的 ResourceClaim 对象的名称。

      • resourceClaims.source.resourceClaimTemplateName (字符串)

        ResourceClaimTemplateName 是与该 pod 位于同一命名空间中的 ResourceClaimTemplate 对象的名称。

        该模板将用于创建一个新的 ResourceClaim,该 ResourceClaim 将绑定到此 pod。当此 pod 被删除时,ResourceClaim 也将被删除。pod 名称和资源名称以及生成的组件将用于为 ResourceClaim 形成一个唯一的名称,该名称将记录在 pod.status.resourceClaimStatuses 中。

        此字段是不可变的,控制平面在创建 ResourceClaim 后不会对相应的 ResourceClaim 进行任何更改。

  • schedulingGates ([]PodSchedulingGate)

    修补策略:按键 name 合并

    映射:合并期间将保留键名称上的唯一值。

    SchedulingGates 是一个不透明的值列表,如果指定,则会阻止调度 pod。如果 schedulingGates 不为空,则 pod 将保持在 SchedulingGated 状态,调度器不会尝试调度 pod。

    SchedulingGates 只能在 pod 创建时设置,并且只能在之后删除。

    这是一个由 PodSchedulingReadiness 功能网关启用的 beta 功能。

    PodSchedulingGate 与 Pod 关联以保护其调度。

    • schedulingGates.name (字符串),必需

      调度网关的名称。每个调度网关必须具有唯一的名称字段。

已弃用

  • serviceAccount (字符串)

    DeprecatedServiceAccount 是 ServiceAccountName 的已弃用别名。已弃用:请改用 serviceAccountName。

容器

您要在 Pod 中运行的单个应用程序容器。


  • name (字符串), 必需

    指定为 DNS_LABEL 的容器名称。Pod 中的每个容器都必须具有唯一的名称 (DNS_LABEL)。不可更新。

镜像

入口点

  • command ([]字符串)

    入口点数组。不在 shell 中执行。如果未提供,则使用容器镜像的 ENTRYPOINT。变量引用 $(VAR_NAME) 使用容器的环境进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将简化为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如,"$$(VAR_NAME)" 将产生字符串文字 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。

  • args ([]字符串)

    入口点的参数。如果未提供,则使用容器镜像的 CMD。变量引用 $(VAR_NAME) 使用容器的环境进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将简化为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如,"$$(VAR_NAME)" 将产生字符串文字 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。

  • workingDir (字符串)

    容器的工作目录。如果未指定,则使用容器运行时的默认值,该默认值可能在容器镜像中配置。不可更新。

端口

  • ports ([]ContainerPort)

    修补策略:在键 containerPort 上合并

    映射:在键 containerPort, protocol 上的唯一值将在合并期间保留

    要从容器中公开的端口列表。此处未指定端口并不阻止该端口被公开。容器内部监听默认 "0.0.0.0" 地址的任何端口都将从网络中访问。使用策略性合并修补修改此数组可能会破坏数据。有关更多信息,请参阅 https://github.com/kubernetes/kubernetes/issues/108255。不可更新。

    ContainerPort 表示单个容器中的网络端口。

    • ports.containerPort (int32), 必需

      要在 Pod 的 IP 地址上公开的端口号。这必须是有效的端口号,0 < x < 65536。

    • ports.hostIP (字符串)

      将外部端口绑定到的主机 IP。

    • ports.hostPort (int32)

      要在主机上公开的端口号。如果指定,这必须是有效的端口号,0 < x < 65536。如果指定了 HostNetwork,则这必须与 ContainerPort 相匹配。大多数容器不需要此选项。

    • ports.name (字符串)

      如果指定,这必须是 IANA_SVC_NAME 并且在 Pod 中是唯一的。Pod 中的每个命名端口都必须具有唯一的名称。可由服务引用的端口名称。

    • ports.protocol (字符串)

      端口协议。必须为 UDP、TCP 或 SCTP。默认为 "TCP"。

环境变量

  • env ([]EnvVar)

    修补策略:按键 name 合并

    要在容器中设置的环境变量列表。不可更新。

    EnvVar 表示容器中存在的环境变量。

    • env.name (字符串), 必需

      环境变量的名称。必须为 C_IDENTIFIER。

    • env.value (字符串)

      变量引用 $(VAR_NAME) 使用容器中之前定义的环境变量和任何服务环境变量进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将简化为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如,"$$(VAR_NAME)" 将产生字符串文字 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。

    • env.valueFrom (EnvVarSource)

      环境变量值的来源。如果 value 不为空,则不可使用。

      EnvVarSource 表示 EnvVar 值的来源。

      • env.valueFrom.configMapKeyRef (ConfigMapKeySelector)

        选择 ConfigMap 的键。

        从 ConfigMap 中选择一个键。

      • env.valueFrom.fieldRef (ObjectFieldSelector)

        选择 Pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels['\<KEY>']metadata.annotations['\<KEY>']、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。

      • env.valueFrom.resourceFieldRef (ResourceFieldSelector)

        选择容器的资源:目前仅支持资源限制和请求(limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory 和 requests.ephemeral-storage)。

      • env.valueFrom.secretKeyRef (SecretKeySelector)

        选择 Pod 命名空间中密钥的秘密

        SecretKeySelector 选择一个 Secret 的键。

  • envFrom ([]EnvFromSource)

    用于填充容器中环境变量的来源列表。源中定义的键必须是 C_IDENTIFIER。所有无效键将在容器启动时作为事件报告。当多个源中存在键时,与最后一个源关联的值将优先。由具有重复键的 Env 定义的值将优先。不可更新。

    EnvFromSource 表示一组 ConfigMap 的来源

    • envFrom.configMapRef (ConfigMapEnvSource)

      要从中选择的 ConfigMap

      *ConfigMapEnvSource 选择一个 ConfigMap 来填充环境变量。

      目标 ConfigMap 的 Data 字段的内容将表示键值对作为环境变量。*

    • envFrom.prefix (字符串)

      用于在 ConfigMap 中的每个键之前添加的可选标识符。必须是 C_IDENTIFIER。

    • envFrom.secretRef (SecretEnvSource)

      要从中选择的 Secret

      *SecretEnvSource 选择一个 Secret 来填充环境变量。

      目标 Secret 的 Data 字段的内容将表示键值对作为环境变量。*

  • volumeMounts ([]VolumeMount)

    修补策略:在键 mountPath 上合并

    要挂载到容器文件系统的 Pod 卷。不可更新。

    VolumeMount 描述了容器内卷的挂载。

    • volumeMounts.mountPath (字符串), 必需

      容器内应挂载卷的路径。不得包含 ':'。

    • volumeMounts.name (字符串), 必需

      这必须与卷的名称匹配。

    • volumeMounts.mountPropagation (字符串)

      mountPropagation 确定挂载如何从主机传播到容器,反之亦然。如果未设置,则使用 MountPropagationNone。此字段在 1.10 中处于 beta 版。

    • volumeMounts.readOnly (布尔值)

      如果为 true,则以只读方式挂载,否则为读写(false 或未指定)。默认为 false。

    • volumeMounts.subPath (字符串)

      卷内应挂载容器卷的路径。默认为 ""(卷的根目录)。

    • volumeMounts.subPathExpr (字符串)

      卷内应挂载容器卷的扩展路径。其行为类似于 SubPath,但环境变量引用 $(VAR_NAME) 使用容器的环境进行扩展。默认为 ""(卷的根目录)。SubPathExpr 和 SubPath 是互斥的。

  • volumeDevices ([]VolumeDevice)

    修补策略:在键 devicePath 上合并

    volumeDevices 是容器要使用的块设备列表。

    volumeDevice 描述了容器内原始块设备的映射。

    • volumeDevices.devicePath (字符串), 必需

      devicePath 是容器内部将设备映射到的路径。

    • volumeDevices.name (字符串), 必需

      name 必须与 Pod 中的持久卷声明的名称匹配

资源

  • resources (ResourceRequirements)

    此容器所需的计算资源。不可更新。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

    ResourceRequirements 描述了计算资源要求。

    • resources.claims ([]ResourceClaim)

      映射:合并期间将保留键名称上的唯一值。

      Claims 列出了此容器使用的资源名称,这些名称在 spec.resourceClaims 中定义。

      这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能网关。

      此字段是不可变的。它只能为容器设置。

      ResourceClaim 引用 PodSpec.ResourceClaims 中的一项。

      • resources.claims.name (字符串), 必需

        名称必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一项的名称匹配。它使该资源在容器内部可用。

    • resources.limits (map[string]Quantity)

      Limits 描述了允许的计算资源的最大数量。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

    • resources.requests (map[string]Quantity)

      Requests 描述了所需的最小计算资源量。如果容器省略了 Requests,则默认为 Limits(如果显式指定),否则默认为实现定义的值。Requests 不能超过 Limits。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

  • resizePolicy ([]ContainerResizePolicy)

    原子:在合并期间将被替换

    容器的资源调整策略。

    ContainerResizePolicy 代表容器的资源调整策略。

    • resizePolicy.resourceName (string), required

      此资源调整策略应用于的资源名称。支持的值:cpu、memory。

    • resizePolicy.restartPolicy (string), required

      调整指定资源时要应用的重启策略。如果未指定,则默认为 NotRequired。

生命周期

  • lifecycle (Lifecycle)

    管理系统应针对容器生命周期事件采取的操作。无法更新。

    Lifecycle 描述了管理系统应针对容器生命周期事件采取的操作。对于 PostStart 和 PreStop 生命周期处理程序,容器的管理将阻塞,直到操作完成,除非容器进程失败,在这种情况下,处理程序将中止。

  • terminationMessagePath (string)

    可选:将容器的终止消息写入的文件将被挂载到容器的文件系统中的路径。写入的消息旨在是简短的最终状态,例如断言失败消息。如果大于 4096 字节,则将被节点截断。所有容器的总消息长度将限制为 12kb。默认为 /dev/termination-log。无法更新。

  • terminationMessagePolicy (string)

    指示如何填充终止消息。File 将使用 terminationMessagePath 的内容来填充容器状态消息,无论成功还是失败。FallbackToLogsOnError 将使用容器日志输出的最后一段,如果终止消息文件为空且容器以错误退出。日志输出限制为 2048 字节或 80 行,取较小值。默认为 File。无法更新。

  • livenessProbe (Probe)

    容器存活的周期性探测。如果探测失败,容器将被重新启动。无法更新。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • readinessProbe (Probe)

    容器服务就绪的周期性探测。如果探测失败,容器将从服务端点中移除。无法更新。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • startupProbe (Probe)

    StartupProbe 指示 Pod 已成功初始化。如果指定,则在成功完成之前不会执行其他探测。如果此探测失败,Pod 将被重新启动,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,此时可能需要很长时间来加载数据或预热缓存,而不是在稳定状态运行期间。这无法更新。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • restartPolicy (string)

    RestartPolicy 定义了 Pod 中单个容器的重启行为。此字段只能为 init 容器设置,且唯一允许的值为 "Always"。对于非 init 容器或未指定此字段时,重启行为由 Pod 的重启策略和容器类型定义。将 init 容器的 RestartPolicy 设置为 "Always" 将具有以下效果:此 init 容器将在退出时不断重新启动,直到所有常规容器都已终止。一旦所有常规容器都已完成,所有具有 restartPolicy "Always" 的 init 容器将被关闭。这种生命周期不同于正常的 init 容器,通常被称为“边车”容器。尽管此 init 容器仍然在 init 容器序列中启动,但它不会等待容器完成,然后才继续进行下一个 init 容器。相反,下一个 init 容器会在此 init 容器启动后立即启动,或者在任何 startupProbe 成功完成之后启动。

安全上下文

  • securityContext (SecurityContext)

    SecurityContext 定义了容器应运行的安全性选项。如果设置,SecurityContext 的字段将覆盖 PodSecurityContext 的等效字段。更多信息:https://kubernetes.ac.cn/docs/tasks/configure-pod-container/security-context/

    SecurityContext 包含将应用于容器的安全配置。某些字段同时存在于 SecurityContext 和 PodSecurityContext 中。当两者都设置时,SecurityContext 中的值优先。

    • securityContext.runAsUser (int64)

      用于运行容器进程入口点的 UID。如果未指定,则默认为映像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.runAsNonRoot (布尔值)

      指示容器必须作为非 root 用户运行。如果为 true,Kubelet 将在运行时验证映像以确保它不作为 UID 0(root)运行,如果确实如此,则会失败启动容器。如果未设置或为 false,则不会执行此类验证。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。

    • securityContext.runAsGroup (int64)

      用于运行容器进程入口点的 GID。如果未设置,则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.readOnlyRootFilesystem (boolean)

      此容器是否具有只读根文件系统。默认为 false。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.procMount (string)

      procMount 表示要用于容器的 proc 挂载类型。默认为 DefaultProcMount,它使用容器运行时的只读路径和屏蔽路径的默认值。这要求启用 ProcMountType 功能标志。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.privileged (boolean)

      在特权模式下运行容器。特权容器中的进程本质上等同于主机上的 root。默认为 false。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.allowPrivilegeEscalation (boolean)

      AllowPrivilegeEscalation 控制进程是否可以获得比其父进程更高的权限。此布尔值直接控制是否在容器进程上设置 no_new_privs 标志。当容器为以下情况时,AllowPrivilegeEscalation 始终为 true:1) 作为 Privileged 运行 2) 具有 CAP_SYS_ADMIN 请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.capabilities (Capabilities)

      在运行容器时要添加/删除的功能。默认为容器运行时授予的默认功能集。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      从运行的容器中添加和删除 POSIX 功能。

      • securityContext.capabilities.add ([]string)

        添加的功能

      • securityContext.capabilities.drop ([]string)

        删除的功能

    • securityContext.seccompProfile (SeccompProfile)

      此容器要使用的 seccomp 选项。如果在 pod 和容器级别都提供了 seccomp 选项,则容器选项将覆盖 pod 选项。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      SeccompProfile 定义 pod/容器的 seccomp 配置文件设置。只能设置一个配置文件源。

      • securityContext.seccompProfile.type (字符串),必需

        type 指示将应用哪种 seccomp 配置文件。有效选项为

        Localhost - 应使用节点上文件中定义的配置文件。RuntimeDefault - 应使用容器运行时默认配置文件。Unconfined - 不应应用任何配置文件。

      • securityContext.seccompProfile.localhostProfile (字符串)

        localhostProfile 指示应使用节点上文件中定义的配置文件。该配置文件必须在节点上预先配置才能正常工作。必须是相对于 kubelet 配置的 seccomp 配置文件位置的下降路径。如果类型为“Localhost”,则必须设置。对于任何其他类型,必须不设置。

    • securityContext.seLinuxOptions (SELinuxOptions)

      要应用于容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机的 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      SELinuxOptions 是要应用于容器的标签。

      • securityContext.seLinuxOptions.level (字符串)

        Level 是应用于容器的 SELinux 级别标签。

      • securityContext.seLinuxOptions.role (字符串)

        Role 是应用于容器的 SELinux 角色标签。

      • securityContext.seLinuxOptions.type (字符串)

        Type 是应用于容器的 SELinux 类型标签。

      • securityContext.seLinuxOptions.user (字符串)

        User 是应用于容器的 SELinux 用户标签。

    • securityContext.windowsOptions (WindowsSecurityContextOptions)

      应用于所有容器的 Windows 特定设置。如果未指定,将使用 PodSecurityContext 中的选项。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 linux 时,此字段无法设置。

      WindowsSecurityContextOptions 包含 Windows 特定的选项和凭据。

      • securityContext.windowsOptions.gmsaCredentialSpec (字符串)

        GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa) 在其中内联由 GMSACredentialSpecName 字段命名的 GMSA 凭据规范内容的位置。

      • securityContext.windowsOptions.gmsaCredentialSpecName (字符串)

        GMSACredentialSpecName 是要使用的 GMSA 凭据规范的名称。

      • securityContext.windowsOptions.hostProcess (布尔值)

        HostProcess 确定容器是否应作为“主机进程”容器运行。Pod 的所有容器必须具有相同的有效 HostProcess 值(不允许混合 HostProcess 容器和非 HostProcess 容器)。此外,如果 HostProcess 为 true,则 HostNetwork 也必须设置为 true。

      • securityContext.windowsOptions.runAsUserName (字符串)

        Windows 中用于运行容器进程入口点的用户名。如果未指定,则默认为映像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。

调试

  • stdin (boolean)

    此容器是否应在容器运行时为 stdin 分配缓冲区。如果未设置,则容器中从 stdin 读取将始终导致 EOF。默认为 false。

  • stdinOnce (boolean)

    容器运行时是否应在单个附加打开 stdin 通道后关闭它。当 stdin 为 true 时,stdin 流将在多个附加会话中保持打开状态。如果 stdinOnce 设置为 true,则 stdin 在容器启动时打开,在第一个客户端附加到 stdin 之前为空,然后保持打开状态并接受数据,直到客户端断开连接,此时 stdin 关闭并保持关闭状态,直到容器重新启动。如果此标志为 false,则从 stdin 读取的容器进程将永远不会收到 EOF。默认为 false

  • tty (boolean)

    此容器是否应为自身分配 TTY,也需要 'stdin' 为 true。默认为 false。

短暂容器

短暂容器是一个临时的容器,您可以将其添加到现有 Pod 中以进行用户启动的活动,例如调试。短暂容器没有资源或调度保证,并且在它们退出时或 Pod 被删除或重新启动时不会重新启动。如果短暂容器导致 Pod 超过其资源分配,kubelet 可能会逐出 Pod。

要添加短暂容器,请使用现有 Pod 的 ephemeralcontainers 子资源。短暂容器不能被删除或重新启动。


  • name (字符串), 必需

    指定为 DNS_LABEL 的短暂容器的名称。此名称必须在所有容器、init 容器和短暂容器中唯一。

  • targetContainerName (string)

    如果设置,则为此短暂容器所针对的 PodSpec 中的容器名称。短暂容器将在此容器的命名空间(IPC、PID 等)中运行。如果未设置,则短暂容器使用 Pod 规范中配置的命名空间。

    容器运行时必须实现对此功能的支持。如果运行时不支持命名空间定位,则设置此字段的结果未定义。

镜像

入口点

  • command ([]字符串)

    入口点数组。不在 shell 中执行。如果未提供,则使用镜像的 ENTRYPOINT。变量引用 $(VAR_NAME) 使用容器的环境进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将缩减为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如 "$$(VAR_NAME)" 将产生字符串字面量 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。无法更新。更多信息:https://kubernetes.ac.cn/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

  • args ([]字符串)

    入口点的参数。如果未提供,则使用镜像的 CMD。变量引用 $(VAR_NAME) 使用容器的环境进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将缩减为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如 "$$(VAR_NAME)" 将产生字符串字面量 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。无法更新。更多信息:https://kubernetes.ac.cn/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

  • workingDir (字符串)

    容器的工作目录。如果未指定,则使用容器运行时的默认值,该默认值可能在容器镜像中配置。不可更新。

环境变量

  • env ([]EnvVar)

    修补策略:按键 name 合并

    要在容器中设置的环境变量列表。不可更新。

    EnvVar 表示容器中存在的环境变量。

    • env.name (字符串), 必需

      环境变量的名称。必须为 C_IDENTIFIER。

    • env.value (字符串)

      变量引用 $(VAR_NAME) 使用容器中之前定义的环境变量和任何服务环境变量进行扩展。如果无法解析变量,则输入字符串中的引用将保持不变。双 $$ 将简化为单个 $,这允许对 $(VAR_NAME) 语法进行转义:例如,"$$(VAR_NAME)" 将产生字符串文字 "$(VAR_NAME)"。转义的引用将永远不会扩展,无论变量是否存在。

    • env.valueFrom (EnvVarSource)

      环境变量值的来源。如果 value 不为空,则不可使用。

      EnvVarSource 表示 EnvVar 值的来源。

      • env.valueFrom.configMapKeyRef (ConfigMapKeySelector)

        选择 ConfigMap 的键。

        从 ConfigMap 中选择一个键。

      • env.valueFrom.fieldRef (ObjectFieldSelector)

        选择 Pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels['\<KEY>']metadata.annotations['\<KEY>']、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。

      • env.valueFrom.resourceFieldRef (ResourceFieldSelector)

        选择容器的资源:目前仅支持资源限制和请求(limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory 和 requests.ephemeral-storage)。

      • env.valueFrom.secretKeyRef (SecretKeySelector)

        选择 Pod 命名空间中密钥的秘密

        SecretKeySelector 选择一个 Secret 的键。

  • envFrom ([]EnvFromSource)

    用于填充容器中环境变量的来源列表。源中定义的键必须是 C_IDENTIFIER。所有无效键将在容器启动时作为事件报告。当多个源中存在键时,与最后一个源关联的值将优先。由具有重复键的 Env 定义的值将优先。不可更新。

    EnvFromSource 表示一组 ConfigMap 的来源

    • envFrom.configMapRef (ConfigMapEnvSource)

      要从中选择的 ConfigMap

      *ConfigMapEnvSource 选择一个 ConfigMap 来填充环境变量。

      目标 ConfigMap 的 Data 字段的内容将表示键值对作为环境变量。*

    • envFrom.prefix (字符串)

      用于在 ConfigMap 中的每个键之前添加的可选标识符。必须是 C_IDENTIFIER。

    • envFrom.secretRef (SecretEnvSource)

      要从中选择的 Secret

      *SecretEnvSource 选择一个 Secret 来填充环境变量。

      目标 Secret 的 Data 字段的内容将表示键值对作为环境变量。*

  • volumeMounts ([]VolumeMount)

    修补策略:在键 mountPath 上合并

    挂载到容器文件系统的 Pod 卷。短暂容器不允许使用子路径挂载。无法更新。

    VolumeMount 描述了容器内卷的挂载。

    • volumeMounts.mountPath (字符串), 必需

      容器内应挂载卷的路径。不得包含 ':'。

    • volumeMounts.name (字符串), 必需

      这必须与卷的名称匹配。

    • volumeMounts.mountPropagation (字符串)

      mountPropagation 确定挂载如何从主机传播到容器,反之亦然。如果未设置,则使用 MountPropagationNone。此字段在 1.10 中处于 beta 版。

    • volumeMounts.readOnly (布尔值)

      如果为 true,则以只读方式挂载,否则为读写(false 或未指定)。默认为 false。

    • volumeMounts.subPath (字符串)

      卷内应挂载容器卷的路径。默认为 ""(卷的根目录)。

    • volumeMounts.subPathExpr (字符串)

      卷内应挂载容器卷的扩展路径。其行为类似于 SubPath,但环境变量引用 $(VAR_NAME) 使用容器的环境进行扩展。默认为 ""(卷的根目录)。SubPathExpr 和 SubPath 是互斥的。

  • volumeDevices ([]VolumeDevice)

    修补策略:在键 devicePath 上合并

    volumeDevices 是容器要使用的块设备列表。

    volumeDevice 描述了容器内原始块设备的映射。

    • volumeDevices.devicePath (字符串), 必需

      devicePath 是容器内部将设备映射到的路径。

    • volumeDevices.name (字符串), 必需

      name 必须与 Pod 中的持久卷声明的名称匹配

资源

  • resizePolicy ([]ContainerResizePolicy)

    原子:在合并期间将被替换

    容器的资源调整策略。

    ContainerResizePolicy 代表容器的资源调整策略。

    • resizePolicy.resourceName (string), required

      此资源调整策略应用于的资源名称。支持的值:cpu、memory。

    • resizePolicy.restartPolicy (string), required

      调整指定资源时要应用的重启策略。如果未指定,则默认为 NotRequired。

生命周期

  • terminationMessagePath (string)

    可选:将容器的终止消息写入的文件将被挂载到容器的文件系统中的路径。写入的消息旨在是简短的最终状态,例如断言失败消息。如果大于 4096 字节,则将被节点截断。所有容器的总消息长度将限制为 12kb。默认为 /dev/termination-log。无法更新。

  • terminationMessagePolicy (string)

    指示如何填充终止消息。File 将使用 terminationMessagePath 的内容来填充容器状态消息,无论成功还是失败。FallbackToLogsOnError 将使用容器日志输出的最后一段,如果终止消息文件为空且容器以错误退出。日志输出限制为 2048 字节或 80 行,取较小值。默认为 File。无法更新。

  • restartPolicy (string)

    容器的重启策略,用于管理 Pod 中每个容器的重启行为。这只能为 init 容器设置。你不能在短暂容器上设置此字段。

调试

  • stdin (boolean)

    此容器是否应在容器运行时为 stdin 分配缓冲区。如果未设置,则容器中从 stdin 读取将始终导致 EOF。默认为 false。

  • stdinOnce (boolean)

    容器运行时是否应在单个附加打开 stdin 通道后关闭它。当 stdin 为 true 时,stdin 流将在多个附加会话中保持打开状态。如果 stdinOnce 设置为 true,则 stdin 在容器启动时打开,在第一个客户端附加到 stdin 之前为空,然后保持打开状态并接受数据,直到客户端断开连接,此时 stdin 关闭并保持关闭状态,直到容器重新启动。如果此标志为 false,则从 stdin 读取的容器进程将永远不会收到 EOF。默认为 false

  • tty (boolean)

    此容器是否应为自身分配 TTY,也需要 'stdin' 为 true。默认为 false。

安全上下文

  • securityContext (SecurityContext)

    可选:SecurityContext 定义了短暂容器应运行的安全选项。如果设置,则 SecurityContext 的字段将覆盖 PodSecurityContext 的等效字段。

    SecurityContext 包含将应用于容器的安全配置。某些字段同时存在于 SecurityContext 和 PodSecurityContext 中。当两者都设置时,SecurityContext 中的值优先。

    • securityContext.runAsUser (int64)

      用于运行容器进程入口点的 UID。如果未指定,则默认为映像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.runAsNonRoot (布尔值)

      指示容器必须作为非 root 用户运行。如果为 true,Kubelet 将在运行时验证映像以确保它不作为 UID 0(root)运行,如果确实如此,则会失败启动容器。如果未设置或为 false,则不会执行此类验证。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。

    • securityContext.runAsGroup (int64)

      用于运行容器进程入口点的 GID。如果未设置,则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.readOnlyRootFilesystem (boolean)

      此容器是否具有只读根文件系统。默认为 false。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.procMount (string)

      procMount 表示要用于容器的 proc 挂载类型。默认为 DefaultProcMount,它使用容器运行时的只读路径和屏蔽路径的默认值。这要求启用 ProcMountType 功能标志。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.privileged (boolean)

      在特权模式下运行容器。特权容器中的进程本质上等同于主机上的 root。默认为 false。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.allowPrivilegeEscalation (boolean)

      AllowPrivilegeEscalation 控制进程是否可以获得比其父进程更高的权限。此布尔值直接控制是否在容器进程上设置 no_new_privs 标志。当容器为以下情况时,AllowPrivilegeEscalation 始终为 true:1) 作为 Privileged 运行 2) 具有 CAP_SYS_ADMIN 请注意,当 spec.os.name 为 windows 时,此字段无法设置。

    • securityContext.capabilities (Capabilities)

      在运行容器时要添加/删除的功能。默认为容器运行时授予的默认功能集。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      从运行的容器中添加和删除 POSIX 功能。

      • securityContext.capabilities.add ([]string)

        添加的功能

      • securityContext.capabilities.drop ([]string)

        删除的功能

    • securityContext.seccompProfile (SeccompProfile)

      此容器要使用的 seccomp 选项。如果在 pod 和容器级别都提供了 seccomp 选项,则容器选项将覆盖 pod 选项。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      SeccompProfile 定义 pod/容器的 seccomp 配置文件设置。只能设置一个配置文件源。

      • securityContext.seccompProfile.type (字符串),必需

        type 指示将应用哪种 seccomp 配置文件。有效选项为

        Localhost - 应使用节点上文件中定义的配置文件。RuntimeDefault - 应使用容器运行时默认配置文件。Unconfined - 不应应用任何配置文件。

      • securityContext.seccompProfile.localhostProfile (字符串)

        localhostProfile 指示应使用节点上文件中定义的配置文件。该配置文件必须在节点上预先配置才能正常工作。必须是相对于 kubelet 配置的 seccomp 配置文件位置的下降路径。如果类型为“Localhost”,则必须设置。对于任何其他类型,必须不设置。

    • securityContext.seLinuxOptions (SELinuxOptions)

      要应用于容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机的 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 windows 时,此字段无法设置。

      SELinuxOptions 是要应用于容器的标签。

      • securityContext.seLinuxOptions.level (字符串)

        Level 是应用于容器的 SELinux 级别标签。

      • securityContext.seLinuxOptions.role (字符串)

        Role 是应用于容器的 SELinux 角色标签。

      • securityContext.seLinuxOptions.type (字符串)

        Type 是应用于容器的 SELinux 类型标签。

      • securityContext.seLinuxOptions.user (字符串)

        User 是应用于容器的 SELinux 用户标签。

    • securityContext.windowsOptions (WindowsSecurityContextOptions)

      应用于所有容器的 Windows 特定设置。如果未指定,将使用 PodSecurityContext 中的选项。如果同时在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 中指定的值优先。请注意,当 spec.os.name 为 linux 时,此字段无法设置。

      WindowsSecurityContextOptions 包含 Windows 特定的选项和凭据。

      • securityContext.windowsOptions.gmsaCredentialSpec (字符串)

        GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa) 在其中内联由 GMSACredentialSpecName 字段命名的 GMSA 凭据规范内容的位置。

      • securityContext.windowsOptions.gmsaCredentialSpecName (字符串)

        GMSACredentialSpecName 是要使用的 GMSA 凭据规范的名称。

      • securityContext.windowsOptions.hostProcess (布尔值)

        HostProcess 确定容器是否应作为“主机进程”容器运行。Pod 的所有容器必须具有相同的有效 HostProcess 值(不允许混合 HostProcess 容器和非 HostProcess 容器)。此外,如果 HostProcess 为 true,则 HostNetwork 也必须设置为 true。

      • securityContext.windowsOptions.runAsUserName (字符串)

        Windows 中用于运行容器进程入口点的用户名。如果未指定,则默认为映像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中都设置,则 SecurityContext 中指定的值优先于该容器。

不允许

  • ports ([]ContainerPort)

    修补策略:在键 containerPort 上合并

    映射:在键 containerPort, protocol 上的唯一值将在合并期间保留

    短暂容器不允许使用端口。

    ContainerPort 表示单个容器中的网络端口。

    • ports.containerPort (int32), 必需

      要在 Pod 的 IP 地址上公开的端口号。这必须是有效的端口号,0 < x < 65536。

    • ports.hostIP (字符串)

      将外部端口绑定到的主机 IP。

    • ports.hostPort (int32)

      要在主机上公开的端口号。如果指定,这必须是有效的端口号,0 < x < 65536。如果指定了 HostNetwork,则这必须与 ContainerPort 相匹配。大多数容器不需要此选项。

    • ports.name (字符串)

      如果指定,这必须是 IANA_SVC_NAME 并且在 Pod 中是唯一的。Pod 中的每个命名端口都必须具有唯一的名称。可由服务引用的端口名称。

    • ports.protocol (字符串)

      端口协议。必须为 UDP、TCP 或 SCTP。默认为 "TCP"。

  • resources (ResourceRequirements)

    短暂容器不允许使用资源。短暂容器使用已分配给 Pod 的备用资源。

    ResourceRequirements 描述了计算资源要求。

    • resources.claims ([]ResourceClaim)

      映射:合并期间将保留键名称上的唯一值。

      Claims 列出了此容器使用的资源名称,这些名称在 spec.resourceClaims 中定义。

      这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能网关。

      此字段是不可变的。它只能为容器设置。

      ResourceClaim 引用 PodSpec.ResourceClaims 中的一项。

      • resources.claims.name (字符串), 必需

        名称必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一项的名称匹配。它使该资源在容器内部可用。

    • resources.limits (map[string]Quantity)

      Limits 描述了允许的计算资源的最大数量。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

    • resources.requests (map[string]Quantity)

      Requests 描述了所需的最小计算资源量。如果容器省略了 Requests,则默认为 Limits(如果显式指定),否则默认为实现定义的值。Requests 不能超过 Limits。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

  • lifecycle (Lifecycle)

    短暂容器不允许使用生命周期。

    Lifecycle 描述了管理系统应针对容器生命周期事件采取的操作。对于 PostStart 和 PreStop 生命周期处理程序,容器的管理将阻塞,直到操作完成,除非容器进程失败,在这种情况下,处理程序将中止。

  • livenessProbe (Probe)

    短暂容器不允许使用探测。

  • readinessProbe (Probe)

    短暂容器不允许使用探测。

  • startupProbe (Probe)

    短暂容器不允许使用探测。

LifecycleHandler

LifecycleHandler 定义了生命周期钩子中应采取的特定操作。除了 TCPSocket 之外,必须指定一个且仅一个字段。


  • exec (ExecAction)

    Exec 指定要采取的操作。

    ExecAction 描述了“在容器中运行”操作。

    • exec.command ([]string)

      Command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录 ('/')。该命令只是简单地执行,它不在 shell 中运行,因此传统的 shell 指令 ('|', 等) 不会起作用。要使用 shell,你需要显式调用该 shell。退出状态为 0 被视为存活/健康,非零状态为不健康。

  • httpGet (HTTPGetAction)

    HTTPGet 指定要执行的 http 请求。

    HTTPGetAction 描述了基于 HTTP Get 请求的操作。

    • httpGet.port (IntOrString), 必需

      要访问容器上的端口的名称或编号。编号必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

      IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 序列化和反序列化时,它会生成或使用内部类型。这允许你拥有例如可以接受名称或编号的 JSON 字段。

    • httpGet.host (string)

      要连接到的主机名,默认为 Pod IP。你可能希望在 httpHeaders 中设置“Host”。

    • httpGet.httpHeaders ([]HTTPHeader)

      要设置在请求中的自定义标头。HTTP 允许重复标头。

      HTTPHeader 描述了在 HTTP 探测中使用的自定义标头

      • httpGet.httpHeaders.name (string), 必需

        标头字段名称。这将在输出时被规范化,因此大小写不同的名称将被理解为相同的标头。

      • httpGet.httpHeaders.value (string), 必需

        标头字段值

    • httpGet.path (string)

      要在 HTTP 服务器上访问的路径。

    • httpGet.scheme (string)

      用于连接到主机的方案。默认为 HTTP。

  • tcpSocket (TCPSocketAction)

    已弃用。TCPSocket 不被支持为 LifecycleHandler,为了向后兼容性而保留。此字段没有验证,当指定 tcp 处理程序时,生命周期钩子将在运行时失败。

    TCPSocketAction 描述了基于打开套接字的操作

    • tcpSocket.port (IntOrString), 必需

      要访问容器上的端口的编号或名称。编号必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

      IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 序列化和反序列化时,它会生成或使用内部类型。这允许你拥有例如可以接受名称或编号的 JSON 字段。

    • tcpSocket.host (string)

      可选:要连接到的主机名,默认为 Pod IP。

NodeAffinity

节点亲和性是一组节点亲和性调度规则。


  • preferredDuringSchedulingIgnoredDuringExecution ([]PreferredSchedulingTerm)

    调度程序将优先将 Pod 调度到满足此字段指定的亲和性表达式的节点,但它可以选择违反一个或多个表达式的节点。最优先的节点是具有最大权重总和的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 亲和性表达式等)的每个节点,通过迭代此字段的元素并添加“权重”来计算总和如果节点与相应的 matchExpressions 相匹配,则将“权重”添加到总和中;具有最高总和的节点(或节点)是最优先的。

    一个空的 preferred scheduling term 与所有对象匹配,隐式权重为 0(即它是无操作)。一个空 preferred scheduling term 不与任何对象匹配(即也是无操作)。

    • preferredDuringSchedulingIgnoredDuringExecution.preference (NodeSelectorTerm), 必需

      一个节点选择器项,与相应的权重相关联。

      一个空或空的节点选择器项不与任何对象匹配。它们的要求是 ANDed。TopologySelectorTerm 类型实现了 NodeSelectorTerm 的一个子集。

      • preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions ([]NodeSelectorRequirement)

        通过节点的标签进行节点选择器要求列表。

      • preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields ([]NodeSelectorRequirement)

        通过节点的字段进行节点选择器要求列表。

    • preferredDuringSchedulingIgnoredDuringExecution.weight (int32), 必需

      与匹配相应的 nodeSelectorTerm 相关的权重,范围为 1-100。

  • requiredDuringSchedulingIgnoredDuringExecution (NodeSelector)

    如果在此字段指定的亲和性要求在调度时未满足,则 Pod 不会调度到该节点。如果在此字段指定的亲和性要求在 Pod 执行期间的某个时间点不再满足(例如,由于更新),则系统可能或可能不尝试最终将 Pod 从其节点中驱逐出去。

    节点选择器表示对一组节点执行一个或多个标签查询的结果的并集;也就是说,它表示由节点选择器项表示的选择器的 OR。

    • requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms ([]NodeSelectorTerm), 必需

      必需。节点选择器项列表。这些项是 ORed。

      一个空或空的节点选择器项不与任何对象匹配。它们的要求是 ANDed。TopologySelectorTerm 类型实现了 NodeSelectorTerm 的一个子集。

      • requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)

        通过节点的标签进行节点选择器要求列表。

      • requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)

        通过节点的字段进行节点选择器要求列表。

PodAffinity

Pod 亲和性是一组 Pod 间亲和性调度规则。


  • preferredDuringSchedulingIgnoredDuringExecution ([]WeightedPodAffinityTerm)

    调度程序将优先将 Pod 调度到满足此字段指定的亲和性表达式的节点,但它可以选择违反一个或多个表达式的节点。最优先的节点是具有最大权重总和的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 亲和性表达式等)的每个节点,通过迭代此字段的元素并添加“权重”来计算总和如果节点具有与相应的 podAffinityTerm 匹配的 Pod,则将“权重”添加到总和中;具有最高总和的节点(或节点)是最优先的。

    所有匹配的 WeightedPodAffinityTerm 字段的权重都会在每个节点上加起来,以找到最优先的节点(或节点)

    • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm (PodAffinityTerm), 必需

      必需。一个 Pod 亲和性项,与相应的权重相关联。

      定义了一组 Pod(即那些相对于给定命名空间(或命名空间)匹配 labelSelector 的 Pod),这个 Pod 应该与之共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 与任何运行着该组 Pod 中的 Pod 的节点的标签键值匹配的节点上

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey (string), 必需

        此 Pod 应该与在指定命名空间中匹配 labelSelector 的 Pod 共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 topologyKey 的值与任何运行着所选 Pod 的节点的标签键值匹配的节点上。空 topologyKey 不允许。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector (LabelSelector)

        对一组资源(在本例中为 Pod)的标签查询。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector (LabelSelector)

        对项适用的命名空间集的标签查询。该项应用于此字段选择和 namespaces 字段列出的命名空间的并集。空选择器和空或空的命名空间列表表示“此 Pod 的命名空间”。空选择器 ({}) 与所有命名空间匹配。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces ([]string)

        namespaces 指定项适用的命名空间名称的静态列表。该项应用于此字段列出的命名空间和 namespaceSelector 选择的命名空间的并集。空或空的命名空间列表和空 namespaceSelector 表示“此 Pod 的命名空间”。

    • preferredDuringSchedulingIgnoredDuringExecution.weight (int32), 必需

      与匹配相应的 podAffinityTerm 相关的权重,范围为 1-100。

  • requiredDuringSchedulingIgnoredDuringExecution ([]PodAffinityTerm)

    如果在此字段指定的亲和性要求在调度时未满足,则 Pod 不会调度到该节点。如果在此字段指定的亲和性要求在 Pod 执行期间的某个时间点不再满足(例如,由于 Pod 标签更新),则系统可能或可能不尝试最终将 Pod 从其节点中驱逐出去。当有多个元素时,与每个 podAffinityTerm 相对应的节点列表会被求交,即所有项都必须满足。

    定义了一组 Pod(即那些相对于给定命名空间(或命名空间)匹配 labelSelector 的 Pod),这个 Pod 应该与之共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 与任何运行着该组 Pod 中的 Pod 的节点的标签键值匹配的节点上

    • requiredDuringSchedulingIgnoredDuringExecution.topologyKey (string), 必需

      此 Pod 应该与在指定命名空间中匹配 labelSelector 的 Pod 共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 topologyKey 的值与任何运行着所选 Pod 的节点的标签键值匹配的节点上。空 topologyKey 不允许。

    • requiredDuringSchedulingIgnoredDuringExecution.labelSelector (LabelSelector)

      对一组资源(在本例中为 Pod)的标签查询。

    • requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector (LabelSelector)

      对项适用的命名空间集的标签查询。该项应用于此字段选择和 namespaces 字段列出的命名空间的并集。空选择器和空或空的命名空间列表表示“此 Pod 的命名空间”。空选择器 ({}) 与所有命名空间匹配。

    • requiredDuringSchedulingIgnoredDuringExecution.namespaces ([]string)

      namespaces 指定项适用的命名空间名称的静态列表。该项应用于此字段列出的命名空间和 namespaceSelector 选择的命名空间的并集。空或空的命名空间列表和空 namespaceSelector 表示“此 Pod 的命名空间”。

PodAntiAffinity

Pod 反亲和性是一组 Pod 间反亲和性调度规则。


  • preferredDuringSchedulingIgnoredDuringExecution ([]WeightedPodAffinityTerm)

    调度程序会优先将 Pod 调度到满足此字段中指定的反亲和性表达式的节点,但它可能会选择违反一个或多个表达式的节点。最优先的节点是权重总和最大的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 反亲和性表达式等)的每个节点,通过遍历此字段的元素并根据节点是否具有与相应 podAffinityTerm 匹配的 Pod 来将“权重”添加到总和中,来计算总和;总和最高的节点是最优先的节点。

    所有匹配的 WeightedPodAffinityTerm 字段的权重都会在每个节点上加起来,以找到最优先的节点(或节点)

    • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm (PodAffinityTerm), 必需

      必需。一个 Pod 亲和性项,与相应的权重相关联。

      定义了一组 Pod(即那些相对于给定命名空间(或命名空间)匹配 labelSelector 的 Pod),这个 Pod 应该与之共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 与任何运行着该组 Pod 中的 Pod 的节点的标签键值匹配的节点上

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey (string), 必需

        此 Pod 应该与在指定命名空间中匹配 labelSelector 的 Pod 共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 topologyKey 的值与任何运行着所选 Pod 的节点的标签键值匹配的节点上。空 topologyKey 不允许。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector (LabelSelector)

        对一组资源(在本例中为 Pod)的标签查询。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector (LabelSelector)

        对项适用的命名空间集的标签查询。该项应用于此字段选择和 namespaces 字段列出的命名空间的并集。空选择器和空或空的命名空间列表表示“此 Pod 的命名空间”。空选择器 ({}) 与所有命名空间匹配。

      • preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces ([]string)

        namespaces 指定项适用的命名空间名称的静态列表。该项应用于此字段列出的命名空间和 namespaceSelector 选择的命名空间的并集。空或空的命名空间列表和空 namespaceSelector 表示“此 Pod 的命名空间”。

    • preferredDuringSchedulingIgnoredDuringExecution.weight (int32), 必需

      与匹配相应的 podAffinityTerm 相关的权重,范围为 1-100。

  • requiredDuringSchedulingIgnoredDuringExecution ([]PodAffinityTerm)

    如果在此字段中指定的反亲和性要求在调度时未满足,则 Pod 将不会调度到该节点。如果在此字段中指定的反亲和性要求在 Pod 执行期间的某个时刻不再满足(例如,由于 Pod 标签更新),系统可能会或可能不会尝试最终将 Pod 从其节点中驱逐。当存在多个元素时,将对每个 podAffinityTerm 对应的节点列表进行交集,即所有术语都必须满足。

    定义了一组 Pod(即那些相对于给定命名空间(或命名空间)匹配 labelSelector 的 Pod),这个 Pod 应该与之共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 与任何运行着该组 Pod 中的 Pod 的节点的标签键值匹配的节点上

    • requiredDuringSchedulingIgnoredDuringExecution.topologyKey (string), 必需

      此 Pod 应该与在指定命名空间中匹配 labelSelector 的 Pod 共置(亲和性)或不共置(反亲和性),其中共置定义为运行在标签键值为 topologyKey 的值与任何运行着所选 Pod 的节点的标签键值匹配的节点上。空 topologyKey 不允许。

    • requiredDuringSchedulingIgnoredDuringExecution.labelSelector (LabelSelector)

      对一组资源(在本例中为 Pod)的标签查询。

    • requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector (LabelSelector)

      对项适用的命名空间集的标签查询。该项应用于此字段选择和 namespaces 字段列出的命名空间的并集。空选择器和空或空的命名空间列表表示“此 Pod 的命名空间”。空选择器 ({}) 与所有命名空间匹配。

    • requiredDuringSchedulingIgnoredDuringExecution.namespaces ([]string)

      namespaces 指定项适用的命名空间名称的静态列表。该项应用于此字段列出的命名空间和 namespaceSelector 选择的命名空间的并集。空或空的命名空间列表和空 namespaceSelector 表示“此 Pod 的命名空间”。

探测

探测描述了针对容器执行的健康检查,以确定它是否存活或已准备好接收流量。


  • exec (ExecAction)

    Exec 指定要采取的操作。

    ExecAction 描述了“在容器中运行”操作。

    • exec.command ([]string)

      Command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录 ('/')。该命令只是简单地执行,它不在 shell 中运行,因此传统的 shell 指令 ('|', 等) 不会起作用。要使用 shell,你需要显式调用该 shell。退出状态为 0 被视为存活/健康,非零状态为不健康。

  • httpGet (HTTPGetAction)

    HTTPGet 指定要执行的 http 请求。

    HTTPGetAction 描述了基于 HTTP Get 请求的操作。

    • httpGet.port (IntOrString), 必需

      要访问容器上的端口的名称或编号。编号必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

      IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 序列化和反序列化时,它会生成或使用内部类型。这允许你拥有例如可以接受名称或编号的 JSON 字段。

    • httpGet.host (string)

      要连接到的主机名,默认为 Pod IP。你可能希望在 httpHeaders 中设置“Host”。

    • httpGet.httpHeaders ([]HTTPHeader)

      要设置在请求中的自定义标头。HTTP 允许重复标头。

      HTTPHeader 描述了在 HTTP 探测中使用的自定义标头

      • httpGet.httpHeaders.name (string), 必需

        标头字段名称。这将在输出时被规范化,因此大小写不同的名称将被理解为相同的标头。

      • httpGet.httpHeaders.value (string), 必需

        标头字段值

    • httpGet.path (string)

      要在 HTTP 服务器上访问的路径。

    • httpGet.scheme (string)

      用于连接到主机的方案。默认为 HTTP。

  • tcpSocket (TCPSocketAction)

    TCPSocket 指定涉及 TCP 端口的操作。

    TCPSocketAction 描述了基于打开套接字的操作

    • tcpSocket.port (IntOrString), 必需

      要访问容器上的端口的编号或名称。编号必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

      IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 序列化和反序列化时,它会生成或使用内部类型。这允许你拥有例如可以接受名称或编号的 JSON 字段。

    • tcpSocket.host (string)

      可选:要连接到的主机名,默认为 Pod IP。

  • initialDelaySeconds (int32)

    容器启动后开始进行存活探测的秒数。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • terminationGracePeriodSeconds (int64)

    探测失败后 Pod 需要优雅终止的可选持续时间(以秒为单位)。宽限期是在向 Pod 中运行的进程发送终止信号后,以及强制使用终止信号强行停止进程的时间间隔(以秒为单位)。将此值设置为预期清理进程所需时间的长度。如果此值为空,将使用 Pod 的 terminationGracePeriodSeconds。否则,此值将覆盖 Pod 规范中提供的该值。该值必须是非负整数。值为零表示立即通过终止信号停止(没有关闭的机会)。这是一个测试版字段,需要启用 ProbeTerminationGracePeriod 功能开关。最小值为 1。如果未设置,将使用 spec.terminationGracePeriodSeconds。

  • periodSeconds (int32)

    执行探测的频率(以秒为单位)。默认为 10 秒。最小值为 1。

  • timeoutSeconds (int32)

    探测超时后的秒数。默认为 1 秒。最小值为 1。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • failureThreshold (int32)

    探测在成功后被认为失败所需的连续失败的最小次数。默认为 3。最小值为 1。

  • successThreshold (int32)

    探测在失败后被认为成功所需的连续成功的最小次数。默认为 1。对于存活探测和启动探测,必须为 1。最小值为 1。

  • grpc (GRPCAction)

    GRPC 指定涉及 GRPC 端口的操作。

    **

PodStatus

PodStatus 表示有关 Pod 状态的信息。状态可能落后于系统的实际状态,尤其是在托管 Pod 的节点无法联系控制平面时。


  • nominatedNodeName (string)

    nominatedNodeName 仅在该 Pod 预占节点上的其他 Pod 时设置,但它无法立即调度,因为预占受害者会收到其优雅终止期。此字段不保证 Pod 将调度到该节点。如果其他节点更早地变得可用,调度程序可能会决定将 Pod 放置在其他地方。调度程序也可能会决定将该节点上的资源分配给在预占后创建的更高优先级的 Pod。因此,当 Pod 被调度时,此字段可能与 PodSpec.nodeName 不同。

  • hostIP (string)

    hostIP 包含分配给 Pod 的主机的 IP 地址。如果 Pod 尚未启动,则为空。Pod 可以分配给 kubelet 存在问题的节点,这意味着即使 Pod 被分配给节点,HostIP 也不会更新。

  • hostIPs ([]HostIP)

    补丁策略:按键 ip 合并

    原子:在合并期间将被替换

    hostIPs 包含分配给主机的 IP 地址。如果指定了此字段,则第一个条目必须与 hostIP 字段匹配。如果 Pod 尚未启动,则此列表为空。Pod 可以分配给 kubelet 存在问题的节点,这意味着即使 Pod 被分配给该节点,HostIPs 也不会更新。

    HostIP 表示分配给主机的单个 IP 地址。

    • hostIPs.ip (string)

      IP 是分配给主机的 IP 地址

  • startTime (Time)

    Kubelet 确认该对象的时间(RFC 3339 日期和时间)。这发生在 Kubelet 拉取 Pod 的容器镜像之前。

    Time 是 time.Time 的包装器,支持正确地编组到 YAML 和 JSON 中。包装器适用于 time 包提供的许多工厂方法。

  • phase (string)

    Pod 的阶段是 Pod 生命周期中它所处位置的简单、高级概述。conditions 数组、reason 和 message 字段以及各个容器状态数组包含有关 Pod 状态的更多详细信息。有五种可能的阶段值

    Pending: Pod 已被 Kubernetes 系统接受,但一个或多个容器镜像尚未创建。这包括在调度之前的时间以及通过网络下载镜像所花费的时间,这可能需要一段时间。Running: Pod 已绑定到节点,并且所有容器都已创建。至少有一个容器仍在运行,或正在启动或重新启动。Succeeded: Pod 中的所有容器都已成功终止,并且不会重新启动。Failed: Pod 中的所有容器都已终止,并且至少有一个容器已失败终止。容器要么以非零状态退出,要么被系统终止。Unknown: 由于某种原因,无法获取 Pod 的状态,通常是由于与 Pod 主机的通信错误。

    更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

  • message (string)

    一条人类可读的消息,指示有关 Pod 处于此状态的原因的详细信息。

  • reason (string)

    一条简短的骆驼式消息,指示有关 Pod 处于此状态的原因的详细信息。例如,“Evicted”

  • podIP (string)

    分配给 Pod 的 podIP 地址。至少在集群内可路由。如果尚未分配,则为空。

  • podIPs ([]PodIP)

    补丁策略:按键 ip 合并

    podIPs 包含分配给 Pod 的 IP 地址。如果指定了此字段,则第 0 个条目必须与 podIP 字段匹配。Pod 最多可以为每个 IPv4 和 IPv6 分配 1 个值。如果尚未分配任何 IP,则此列表为空。

    PodIP 表示分配给 Pod 的单个 IP 地址。

    • podIPs.ip (string)

      IP 是分配给 Pod 的 IP 地址

  • conditions ([]PodCondition)

    修补策略:根据键 type 合并

    Pod 的当前服务状态。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

    PodCondition 包含有关此 Pod 的当前状态的详细信息。

    • conditions.status (string), required

      Status 是条件的状态。可以是 True、False、Unknown。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

    • conditions.type (string), required

      Type 是条件的类型。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

    • conditions.lastProbeTime (Time)

      我们最后一次探测条件的时间。

      Time 是 time.Time 的包装器,支持正确地编组到 YAML 和 JSON 中。包装器适用于 time 包提供的许多工厂方法。

    • conditions.lastTransitionTime (Time)

      条件从一个状态转换到另一个状态的最后时间。

      Time 是 time.Time 的包装器,支持正确地编组到 YAML 和 JSON 中。包装器适用于 time 包提供的许多工厂方法。

    • conditions.message (string)

      人类可读的消息,指示有关上次转换的详细信息。

    • conditions.reason (string)

      条件上次转换的唯一、单字、骆驼式原因。

  • qosClass (string)

    根据资源需求分配给 Pod 的服务质量 (QOS) 分类。有关可用的 QOS 类别的信息,请参见 PodQOSClass 类型。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes

  • initContainerStatuses ([]ContainerStatus)

    该列表中每个清单中的 init 容器都有一个条目。最近一次成功的 init 容器将具有 ready = true,最近一次启动的容器将设置 startTime。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

    ContainerStatus 包含有关此容器的当前状态的详细信息。

  • containerStatuses ([]ContainerStatus)

    该列表中每个清单中的容器都有一个条目。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

    ContainerStatus 包含有关此容器的当前状态的详细信息。

  • ephemeralContainerStatuses ([]ContainerStatus)

    在此 Pod 中运行的任何短暂容器的状态。

    ContainerStatus 包含有关此容器的当前状态的详细信息。

  • resourceClaimStatuses ([]PodResourceClaimStatus)

    修补策略:保留键,按键 name 合并

    映射:合并期间将保留键名称上的唯一值。

    资源声明的状态。

    PodResourceClaimStatus 存储在每个 PodResourceClaim 的 PodStatus 中,该 PodResourceClaim 引用 ResourceClaimTemplate。它存储了对应 ResourceClaim 的生成名称。

    • resourceClaimStatuses.name (string), required

      Name 在 Pod 内唯一标识此资源声明。这必须与 pod.spec.resourceClaims 中的条目名称匹配,这意味着该字符串必须是 DNS_LABEL。

    • resourceClaimStatuses.resourceClaimName (string)

      ResourceClaimName 是为 Pod 在 Pod 命名空间中生成的 ResourceClaim 的名称。如果未设置,则无需生成 ResourceClaim。在这种情况下,可以忽略 pod.spec.resourceClaims 条目。

  • resize (string)

    Pod 容器所需资源调整的状态。如果没有任何资源调整待处理,则为空。对容器资源的任何更改都会自动将其设置为“Proposed”。

PodList

PodList 是 Pod 的列表。


操作


get 读取指定的 Pod

HTTP 请求

GET /api/v1/namespaces/{namespace}/pods/{name}

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

401: 未授权

get 读取指定 Pod 的 ephemeralcontainers

HTTP 请求

GET /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

401: 未授权

get 读取指定 Pod 的日志

HTTP 请求

GET /api/v1/namespaces/{namespace}/pods/{name}/log

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • container (查询中): 字符串

    要流式传输日志的容器。默认为只有一个容器的 Pod 的唯一容器。

  • follow (查询中): 布尔值

    跟踪 Pod 的日志流。默认为 false。

  • insecureSkipTLSVerifyBackend (查询中): 布尔值

    insecureSkipTLSVerifyBackend 指示 apiserver 不应确认其连接到的后端的提供证书的有效性。这将使 apiserver 与后端之间的 HTTPS 连接变得不安全。这意味着 apiserver 无法验证它收到的日志数据是否来自真实的 kubelet。如果 kubelet 配置为验证 apiserver 的 TLS 凭据,这并不意味着与真实 kubelet 的连接容易受到中间人攻击(例如,攻击者无法拦截来自真实 kubelet 的实际日志数据)。

  • limitBytes (查询中): 整数

    如果设置,则从服务器读取的字节数,在终止日志输出之前。这可能不会显示完整的最后一行日志,并且可能返回略多于或略少于指定限制的字节数。

  • pretty (查询中): 字符串

    漂亮

  • previous (查询中): 布尔值

    返回之前已终止的容器日志。默认为 false。

  • sinceSeconds (查询中): 整数

    相对于当前时间,以秒为单位的相对时间,从该时间开始显示日志。如果此值早于 Pod 启动时间,则仅返回 Pod 启动后的日志。如果此值在未来,则不会返回任何日志。只能指定 sinceSeconds 或 sinceTime 之一。

  • tailLines (查询中): 整数

    如果设置,则显示日志末尾的行的数量。如果未指定,则从容器创建或 sinceSeconds 或 sinceTime 开始显示日志

  • timestamps (查询中): 布尔值

    如果为 true,则在每行日志输出的开头添加 RFC3339 或 RFC3339Nano 时间戳。默认为 false。

响应

200 (字符串): OK

401: 未授权

get 读取指定 Pod 的状态

HTTP 请求

GET /api/v1/namespaces/{namespace}/pods/{name}/status

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

401: 未授权

list 列出或监视 Pod 类型的对象

HTTP 请求

GET /api/v1/namespaces/{namespace}/pods

参数

响应

200 (PodList): OK

401: 未授权

list 列出或监视 Pod 类型的对象

HTTP 请求

GET /api/v1/pods

参数

响应

200 (PodList): OK

401: 未授权

create 创建一个 Pod

HTTP 请求

POST /api/v1/namespaces/{namespace}/pods

参数

响应

200 (Pod): OK

201 (Pod): 已创建

202 (Pod): 已接受

401: 未授权

update 替换指定的 Pod

HTTP 请求

PUT /api/v1/namespaces/{namespace}/pods/{name}

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Pod,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

update 替换指定 Pod 的 ephemeralcontainers

HTTP 请求

PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Pod,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

update 替换指定 Pod 的状态

HTTP 请求

PUT /api/v1/namespaces/{namespace}/pods/{name}/status

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Pod,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

patch 部分更新指定的 Pod

HTTP 请求

PATCH /api/v1/namespaces/{namespace}/pods/{name}

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Patch,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • force (查询中): 布尔值

    强制

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

patch 部分更新指定 Pod 的 ephemeralcontainers

HTTP 请求

PATCH /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Patch,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • force (查询中): 布尔值

    强制

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

patch 部分更新指定 Pod 的状态

HTTP 请求

PATCH /api/v1/namespaces/{namespace}/pods/{name}/status

参数

  • name (路径中): 字符串,必需

    Pod 的名称

  • namespace (路径中): 字符串,必需

    命名空间

  • body: Patch,必需

  • dryRun (查询中): 字符串

    dryRun

  • fieldManager (查询中): 字符串

    fieldManager

  • fieldValidation (查询中): 字符串

    fieldValidation

  • force (查询中): 布尔值

    强制

  • pretty (查询中): 字符串

    漂亮

响应

200 (Pod): OK

201 (Pod): 已创建

401: 未授权

delete 删除一个 Pod

HTTP 请求

DELETE /api/v1/namespaces/{namespace}/pods/{name}

参数

响应

200 (Pod): OK

202 (Pod): 已接受

401: 未授权

deletecollection 删除 Pod 集合

HTTP 请求

DELETE /api/v1/namespaces/{namespace}/pods

参数

响应

200 (Status): OK

401: 未授权

此页面是自动生成的。

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

上次修改于 2023 年 7 月 26 日下午 1:45 PST: 生成内容 (1e2ed88743)