14.6. Prometheus [monitoring.coreos.com/v1]


描述
Prometheus 定义 Prometheus 部署。
类型
对象
必填
  • spec

14.6.1. 规格

Expand
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

Prometheus 集群所需行为的规格。更多信息: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

对象

Prometheus 集群最近观察到的状态。只读。从 apiserver 请求时不包括,仅来自 Prometheus Operator API 本身。更多信息: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

14.6.1.1. .spec

Expand
属性类型描述

additionalAlertManagerConfigs

对象

additionalAlertmanagerConfigs 允许指定包含其他 Prometheus AlertManager 配置的 Secret 的密钥。指定的 Alertmanager 配置附加到 Prometheus Operator 生成的配置中。指定的作业配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config。附加 AlertManager 配置后,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后不会破坏 Prometheus 不兼容的 AlertManager 配置。

additionalAlertRelabelConfigs

对象

additionalAlertRelabelConfigs 允许指定包含其他 Prometheus 警报重新标记配置的 Secret 键。指定的警报重新标记配置附加到 Prometheus Operator 生成的配置中。指定的警报重新标记配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs。附加警报重新标记配置后,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后没有不兼容的警报重新标记配置会破坏 Prometheus。

additionalScrapeConfigs

对象

additionalScrapeConfigs 允许指定包含其他 Prometheus 提取配置的 Secret 的密钥。指定的提取配置附加到 Prometheus Operator 生成的配置中。指定的作业配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config。附加提取配置时,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后没有不兼容的提取配置会破坏 Prometheus。

关联性

对象

如果指定,pod 的调度限制。

警报

对象

定义警报的详细信息。

allowOverlappingBlocks

布尔值

AllowOverlappingBlocks 在 Prometheus 中启用垂直压缩和垂直查询合并。这在 Prometheus 中仍是实验性的,因此可能会在任何即将发布的发行版本中有所变化。

apiserverConfig

对象

apiserverConfig 允许指定主机和 auth 方法来访问 apiserver。如果留空,则假定 Prometheus 在集群内运行,并自动发现 API 服务器,并使用 /var/run/secrets/kubernetes.io/serviceaccount/ 中的 pod 的 CA 证书和 bearer 令牌文件。

arbitraryFSAccessThroughSMs

对象

arbitraryFSAccessThroughSMs 配置基于服务监控器的配置是否可以访问 Prometheus 容器文件系统上的任意文件,如 bearer 令牌文件。

baseImage

字符串

用于 Prometheus 部署的基础镜像。弃用:使用 'image' 替代

configMaps

数组(字符串)

ConfigMap 是与 Prometheus 对象相同的命名空间中的 ConfigMap 列表,应该挂载到 Prometheus Pod 中。ConfigMap 挂载到 /etc/prometheus/configmaps/<configmap-name> 中。

containers

array

容器允许注入其他容器或修改 Operator 生成的容器。这可用于允许向 Prometheus pod 添加身份验证代理,或更改 Operator 生成的容器的行为。如果容器共享相同名称和修改是通过策略合并补丁进行的,则此处描述的容器会修改 Operator 生成的容器。当前容器名称有: prometheusconfig-reloaderthanos-sidecar。覆盖容器完全不在维护人员支持的范围之外,您可以接受这种行为可能会随时中断,而不会注意到。

containers[]

对象

要在 pod 中运行的单一应用程序容器。

disableCompaction

布尔值

禁用 prometheus 压缩。

enableAdminAPI

布尔值

启用对 prometheus Web admin API 的访问。默认为 false 的值。警告:启用 admin API 可启用变异端点、删除数据、关闭 Prometheus 等。请谨慎启用此功能,建议用户通过代理添加额外的身份验证授权,以确保只有有权执行这些操作的客户端才能这样做。如需更多信息,请参阅 https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis

enableFeatures

数组(字符串)

启用对 Prometheus 禁用的功能的访问。默认情况下,不启用任何功能。启用禁用的功能完全超出了维护人员支持的范围,因此您接受这个行为可能会在不通知的情况下中断。如需更多信息,请参阅 https://prometheus.io/docs/prometheus/latest/disabled_features/

enforcedBodySizeLimit

字符串

enforcedBodySizeLimit 定义 Prometheus 可接受的未压缩响应正文的最大大小。使用大于这个字节的正文响应会导致提取失败。示例:100MB。如果定义,这个限制将应用到所有服务/pod 监视器和探测。这是一个实验性功能,以后可能会更改或移除此行为。仅在 Prometheus 版本 2.28.0 及更新版本中有效。

enforcedLabelLimit

整数

对示例接受的标签数的 per-scrape 限制。如果指标后存在超过这个数量的标签,则整个提取将被视为失败。0 表示没有限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

enforcedLabelNameLengthLimit

整数

针对示例接受的标签名称长度的 per-scrape 限制。如果标签名称大于这个数字 post-relabeling,则整个提取将被视为失败。0 表示没有限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

enforcedLabelValueLengthLimit

整数

对示例接受的标签值长度的 per-scrape 限制。如果标签值超过这个数字后指标重新标记,则整个提取将被视为失败。0 表示没有限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

enforcedNamespaceLabel

字符串

EnforcedNamespaceLabel 如果设置,标签将添加到 1。所有 user-metrics (由 ServiceMonitorPodMonitorProbeConfig 对象创建)和 2. 在所有 PrometheusRule 对象(除 prometheusRulesExcludedFromEnforce之外)除外,以记录规则,并记录其表达式中使用的指标(加速)。标签名称是此字段的值。label 值是创建对象的命名空间(上述)。

enforcedSampleLimit

整数

enforcedSampleLimit 定义将接受的提取示例数量的全局限制。这会覆盖每个 ServiceMonitor 或/and PodMonitor 设置的任何 SampleLimit。管理员用来强制 SampleLimit 使用它来保持在所需限制下的示例/系列的整体数量。请注意,如果 SampleLimit 较低,则会使用该值。

enforcedTargetLimit

整数

EnforcedTargetLimit 在刮除目标数量上定义了一个全局限制。这会覆盖每个 ServiceMonitor 或/and PodMonitor 设置的任何 TargetLimit。管理员用来强制 TargetLimit 使用它来保持目标的整体数量在所需限制下。请注意,如果 TargetLimit 较低,则该值将被改为使用 (如果任一值为零)除外,在这种情况下,将使用非零值。如果这两个值都为零,则不强制实施限制。

evaluationInterval

字符串

连续评估之间的间隔。默认: 1m

externalLabels

对象(字符串)

与外部系统通信时添加到任何时间序列或警报的标签(联邦、远程存储、Alertmanager)。

externalUrl

字符串

Prometheus 实例将位于的外部 URL。这是生成正确的 URL 所必需的。如果没有从 DNS 名称的根目录提供 Prometheus,则需要此项。

ignoreNamespaceSelectors

布尔值

如果设为 true,则 IgnoreNamespaceSelectors 将忽略 podmonitor 和 servicemonitor 配置中的 NamespaceSelector 设置,它们只会发现其当前命名空间中的端点。默认为false。

image

字符串

如果指定的优先级高于 baseImage、tag 和 sha 组合,则镜像。仍然需要指定版本,以确保 Prometheus Operator 知道要配置的 Prometheus 版本。

imagePullSecrets

array

用于从 registry 中拉取 prometheus 和 alertmanager 镜像的 secret 的可选引用列表,请参阅 http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

对象

LocalObjectReference 包含足够信息,供您在同一命名空间中查找引用的对象。

initContainers

array

initContainers 允许将 initContainers 添加到 pod 定义中。它们可用于从外部来源获取用于注入 Prometheus 配置的 secret。执行 initContainer 期间的任何错误将导致 Pod 重启。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers 描述了修改 Operator 生成的 init 容器,如果它们共享相同的名称和修改,则通过策略合并补丁进行。当前的 init 容器名称为: init-config-reloader。覆盖 init 容器完全超出了维护人员支持的范围,因此您接受这个行为可能会在不通知的情况下中断。

initContainers[]

对象

要在 pod 中运行的单一应用程序容器。

listenLocal

布尔值

ListenLocal 使 Prometheus 服务器侦听回送,使其不会与 Pod IP 绑定。

logFormat

字符串

Prometheus 配置的日志格式。

logLevel

字符串

用于配置 Prometheus 的日志级别。

minReadySeconds

整数

新创建的 pod 应该就绪的最小秒数,无需任何容器崩溃,使其被视为可用。默认值为 0 (pod 会在就绪后马上被视为可用),这是 alpha 字段,需要启用 StatefulSetMinReadySeconds 功能门。

nodeSelector

对象(字符串)

定义 Pod 调度到哪些节点上。

overrideHonorLabels

布尔值

如果设置为 true,则 OverrideHonorLabels 会覆盖所有配置了 honor_labels 的用户。如果在 ServiceMonitor 或 PodMonitor 中将 HonorLabels 设置为 true,则会覆盖 honor_labels 为 false。

overrideHonorTimestamps

布尔值

OverrideHonorTimestamps 允许全局强制执行所有提取配置的时间戳。

paused

布尔值

当 Prometheus 部署暂停时,除了删除外的操作不会在底层对象上执行。

podMetadata

对象

PodMetadata 配置向 prometheus pod 传播的标签和注解。

podMonitorNamespaceSelector

对象

命名空间的标签,用于 PodMonitor 发现。如果为 nil,则只检查自己的命名空间。

podMonitorSelector

对象

为目标发现选择 实验性 PodMonitor。弃用: 如果没有指定此和 serviceMonitorSelector,则配置将非受管。

portName

字符串

用于 pod 和管理服务的端口名称。默认值为 web

priorityClassName

字符串

分配给 Pod 的优先级类

probeNamespaceSelector

对象

为探测发现选择 实验性 命名空间。如果为 nil,则只检查自己的命名空间。

probeSelector

对象

为目标发现选择 实验性 探测。

prometheusExternalLabelName

字符串

用于表示 Prometheus 实例名称的 Prometheus 外部标签的名称。默认为 prometheus 的值。当值设为空字符串时,不会添加 外部标签("")。

prometheusRulesExcludedFromEnforce

array

prometheusRulesExcludedFromEnforce - 要从添加命名空间标签的 enforcing 中排除的 prometheus 规则列表。仅在 enforcedNamespaceLabel 设置为 true 时才有效。确保为每个对设置了 ruleNamespace 和 ruleName

prometheusRulesExcludedFromEnforce[]

对象

PrometheusRuleExcludeConfig 允许用户配置排除的 PrometheusRule 名称及其命名空间,同时为警报和指标强制命名空间标签。

query

对象

QuerySpec 定义启动 Prometheus 时的查询命令行标志。

queryLogFile

字符串

QueryLogFile 指定 PromQL 查询要记录到的文件。请注意,此位置必须是可写的,并且可以使用附加的卷保留。或者,位置可以设置为 stdout 位置,如 /dev/stdout,以将信息记录到默认的 Prometheus 日志流。这仅适用于 Prometheus >= 2.16.0 的版本。如需了解更多详细信息,请参阅 Prometheus 文档(https://prometheus.io/docs/guides/query-log/)

remoteRead

array

如果指定,remote_read spec。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。

remoteRead[]

对象

RemoteReadSpec 为 prometheus 定义 remote_read 配置。

remoteWrite

array

如果指定,remote_write spec。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。

remoteWrite[]

对象

RemoteWriteSpec 为 prometheus 定义 remote_write 配置。

replicaExternalLabelName

字符串

用于表示副本名称的 Prometheus 外部标签名称。默认为 prometheus_replica 的值。当值设为空字符串时,不会添加 外部标签("")。

replicas

整数

为 Prometheus 部署部署的每个分片的副本数。乘以分片的副本数是创建的 Pod 的总数。

资源

对象

定义单个 Pod 的资源请求和限值。

保留

字符串

Prometheus 应该保留数据的持续时间。默认为 '24h',必须与正则表达式 [0-9]+(ms|s|m|h|d|w|y) (毫秒秒小时周数)匹配。

retentionSize

字符串

块使用的最大磁盘空间量。支持的单位:B, KB, MB, GB, TB, PB, EB.EX :512MB

routePrefix

字符串

Prometheus 注册 HTTP 处理程序的路由前缀。这非常有用,如果使用 ExternalURL 和代理被重写请求的 HTTP 路由,并且实际的 ExternalURL 仍为 true,但服务器在不同路由前缀下服务请求。例如,用于 kubectl 代理

ruleNamespaceSelector

对象

为 PrometheusRules 发现选择的命名空间。如果未指定,则只使用与 Prometheus 对象相同的命名空间。

ruleSelector

对象

选择要从中加载警报/记录规则的 PrometheusRules 的选择器。直到(不包括)Prometheus Operator v0.24.0 Prometheus Operator 将任何旧的规则 ConfigMap 迁移到 RuleSelector 选择的 PrometheusRule 自定义资源。确保它与您不想迁移的任何配置映射不匹配。

rules

对象

/--rules the/ 命令行参数。

scrapeInterval

字符串

连续提取之间的间隔。默认: 1m

scrapeTimeout

字符串

在出错前等待目标响应的秒数。

secrets

数组(字符串)

secret 是与 Prometheus 对象相同的命名空间中的 Secret 列表,应该挂载到 Prometheus Pod 中。Secret 被挂载到 /etc/prometheus/secrets/<secret-name> 中。

securityContext

对象

securityContext 包含 pod 级别的安全属性和通用容器设置。默认为默认的 PodSecurityContext。

serviceAccountName

字符串

serviceAccountName 是用于运行 Prometheus Pod 的 ServiceAccount 的名称。

serviceMonitorNamespaceSelector

对象

命名空间的标签,用于 ServiceMonitor 发现。如果为 nil,则只检查自己的命名空间。

serviceMonitorSelector

对象

为目标发现选择 ServiceMonitor。弃用: 如果没有指定此和 podMonitorSelector,则配置将非受管。

sha

字符串

要部署的 Prometheus 容器镜像的 SHA。默认为 version 的值。与标签类似,但 SHA 明确部署不可变的容器镜像。如果设置了 SHA,则忽略 version 和 Tag。弃用:改为使用 'image'。镜像摘要可以作为镜像 URL 的一部分指定。

分片

整数

EXPERIMENTAL :将目标分发到的分片数量。乘以分片的副本数是创建的 Pod 的总数。请注意,缩减分片不会将数据重新划分到剩余的实例中,必须手动移动。增加分片不会重新划分数据,但它将继续从同一实例使用。要全局查询使用 Thanos sidecar 和 Thanos querier 或远程写入数据到中央位置。分片是在 地址 目标 meta-label 的内容中进行的。

storage

对象

存储 spec 以指定如何使用存储。

tag

字符串

要部署的 Prometheus 容器镜像的标签。默认为 version 的值。如果设置了 Tag,则忽略 version。弃用:改为使用 'image'。镜像标签可以作为镜像 URL 的一部分指定。

Thanos

对象

Thanos 配置允许在 Thanos 环境中配置 Prometheus 服务器的各个方面。本节是实验性的,可能会在任何发行版本中没有弃用通知。这是实验性的,可能随时更改而不向后兼容。

容限(tolerations)

array

如果指定,pod 的容限。

tolerations[]

对象

附加此 Toleration 的 pod,以使用匹配的 operator <operator> 来容许与 triple <key,value,effect> 匹配的任何污点。

topologySpreadConstraints

array

如果指定,pod 的拓扑分布约束。

topologySpreadConstraints[]

对象

TopologySpreadConstraint 指定如何将匹配的 pod 分散到给定拓扑中。

version

字符串

要部署的 Prometheus 版本。

volumeMounts

array

volumeMounts 允许在输出 StatefulSet 定义上配置额外的 VolumeMounts。指定 volumeMounts 将附加到 prometheus 容器中的其他 VolumeMounts 中,后者由 StorageSpec 对象而生成。

volumeMounts[]

对象

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

array

卷允许在输出 StatefulSet 定义中配置额外的卷。指定的卷将附加到因为 StorageSpec 对象生成的其他卷中。

volumes[]

对象

卷代表 pod 中可以被 pod 中任何容器访问的命名卷。

walCompression

布尔值

使用 Snappy 启用 write-ahead 日志的压缩。这个标志只在 Prometheus >= 2.11.0 的版本中可用。

web

对象

WebSpec 在启动 Prometheus 时定义 Web 命令行标志。

14.6.1.2. .spec.additionalAlertManagerConfigs

描述
additionalAlertmanagerConfigs 允许指定包含其他 Prometheus AlertManager 配置的 Secret 的密钥。指定的 Alertmanager 配置附加到 Prometheus Operator 生成的配置中。指定的作业配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config。附加 AlertManager 配置后,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后不会破坏 Prometheus 不兼容的 AlertManager 配置。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.3. .spec.additionalAlertRelabelConfigs

描述
additionalAlertRelabelConfigs 允许指定包含其他 Prometheus 警报重新标记配置的 Secret 键。指定的警报重新标记配置附加到 Prometheus Operator 生成的配置中。指定的警报重新标记配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs。附加警报重新标记配置后,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后没有不兼容的警报重新标记配置会破坏 Prometheus。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.4. .spec.additionalScrapeConfigs

描述
additionalScrapeConfigs 允许指定包含其他 Prometheus 提取配置的 Secret 的密钥。指定的提取配置附加到 Prometheus Operator 生成的配置中。指定的作业配置必须具有官方 Prometheus 文档中指定的表单 :https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config。附加提取配置时,用户负责确保其有效。请注意,使用此功能可能会破坏 Prometheus 的升级。建议查看 Prometheus 发行注记,以确保升级后没有不兼容的提取配置会破坏 Prometheus。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.5. .spec.affinity

描述
如果指定,pod 的调度限制。
类型
对象
Expand
属性类型描述

nodeAffinity

对象

描述 pod 的节点关联性调度规则。

podAffinity

对象

描述 pod 关联性调度规则(例如,将此 pod 放置到同一节点、区域等)。

podAntiAffinity

对象

描述 pod 反关联性调度规则(例如,避免将此 pod 放置到同一节点、区等)。

14.6.1.6. .spec.affinity.nodeAffinity

描述
描述 pod 的节点关联性调度规则。
类型
对象
Expand
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

array

调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、必需DuringScheduling 关联性表达式等)的节点,通过迭代此字段元素并在总和中添加"权重"来计算总和,如果节点与对应的 matchExpressions 匹配;最高总和最高的节点是首选的。

preferredDuringSchedulingIgnoredDuringExecution[]

对象

空的首选调度术语与所有带有隐式权重 0 的对象匹配(例如,它是一个 no-op)。空首选调度术语不匹配任何对象(例如,也不是 no-op)。

requiredDuringSchedulingIgnoredDuringExecution

对象

如果在调度时没有满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间某个时间点上满足此字段指定的关联性要求(例如,由于更新),系统可能无法最终尝试从其节点驱除 pod。

描述
调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、必需DuringScheduling 关联性表达式等)的节点,通过迭代此字段元素并在总和中添加"权重"来计算总和,如果节点与对应的 matchExpressions 匹配;最高总和最高的节点是首选的。
类型
array
描述
空的首选调度术语与所有带有隐式权重 0 的对象匹配(例如,它是一个 no-op)。空首选调度术语不匹配任何对象(例如,也不是 no-op)。
类型
对象
必填
  • preference
  • weight
Expand
属性类型描述

preference

对象

节点选择器,与对应的权重相关联。

weight

整数

与对应 nodeSelectorTerm 匹配的权重,在 1 到 100 之间。

描述
节点选择器,与对应的权重相关联。
类型
对象
Expand
属性类型描述

matchExpressions

array

按节点标签划分的节点选择器要求列表。

matchExpressions[]

对象

节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchFields

array

按节点字段的节点选择器要求列表。

matchFields[]

对象

节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

描述
按节点标签划分的节点选择器要求列表。
类型
array
描述
节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

描述
按节点字段的节点选择器要求列表。
类型
array
描述
节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

描述
如果在调度时没有满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间某个时间点上满足此字段指定的关联性要求(例如,由于更新),系统可能无法最终尝试从其节点驱除 pod。
类型
对象
必填
  • nodeSelectorTerms
Expand
属性类型描述

nodeSelectorTerms

array

必需。节点选择器术语列表。术语为 ORed。

nodeSelectorTerms[]

对象

空或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。

描述
必需。节点选择器术语列表。术语为 ORed。
类型
array
描述
空或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
类型
对象
Expand
属性类型描述

matchExpressions

array

按节点标签划分的节点选择器要求列表。

matchExpressions[]

对象

节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchFields

array

按节点字段的节点选择器要求列表。

matchFields[]

对象

节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

描述
按节点标签划分的节点选择器要求列表。
类型
array
描述
节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

描述
按节点字段的节点选择器要求列表。
类型
array
描述
节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

14.6.1.21. .spec.affinity.podAffinity

描述
描述 pod 关联性调度规则(例如,将此 pod 放置到同一节点、区域等)。
类型
对象
Expand
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

array

调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、必需DuringScheduling 关联性表达式等)的节点,通过迭代此字段元素并在总和中添加"权重"的总和,如果节点具有与对应 podAffinityTerm 匹配的 pod,以及最高总和最高的节点。

preferredDuringSchedulingIgnoredDuringExecution[]

对象

每个节点会添加所有匹配的 WeightedPodAffinityTerm 字段的权重,以查找最首选的节点。

requiredDuringSchedulingIgnoredDuringExecution

array

如果在调度时没有满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间某个时间点上满足此字段指定的关联性要求(例如,由于 pod 标签更新),系统可能也可能不最终尝试从其节点驱除 pod。当有多个元素时,与每个 podAffinityTerm 对应的节点列表会交集,例如所有术语都必须满足。

requiredDuringSchedulingIgnoredDuringExecution[]

对象

定义一组与给定命名空间匹配的 labelSelector 匹配的一组 pod (即,这个 pod 应该与运行 pod 的 pod 共存(关联性)或非并置(反关联性)匹配,其中 co-located 定义为在带有 <topologyKey> 标签值的节点上运行,其键为 <topologyKey> 匹配。

描述
调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、必需DuringScheduling 关联性表达式等)的节点,通过迭代此字段元素并在总和中添加"权重"的总和,如果节点具有与对应 podAffinityTerm 匹配的 pod,以及最高总和最高的节点。
类型
array
描述
每个节点会添加所有匹配的 WeightedPodAffinityTerm 字段的权重,以查找最首选的节点。
类型
对象
必填
  • podAffinityTerm
  • weight
Expand
属性类型描述

podAffinityTerm

对象

必需。与对应的权重关联的 pod 关联性术语。

weight

整数

与对应 podAffinityTerm 匹配的权重在 1-100 之间。

描述
必需。与对应的权重关联的 pod 关联性术语。
类型
对象
必填
  • topologyKey
Expand
属性类型描述

labelSelector

对象

对一组资源进行的标签查询,本例中为 pod。

命名空间

数组(字符串)

namespaces 指定 labelSelector 应用到的命名空间(匹配); null 或空列表表示"此 pod 的命名空间"

topologyKey

字符串

此 pod 应该并置(关联性)或与指定命名空间中的 labelSelector 匹配的 pod 共处(反关联性),其中 co-located 定义为运行任何带有 key topologyKey 的标签值的节点上运行。不允许空的 topologyKey。

描述
对一组资源进行的标签查询,本例中为 pod。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

描述
如果在调度时没有满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间某个时间点上满足此字段指定的关联性要求(例如,由于 pod 标签更新),系统可能也可能不最终尝试从其节点驱除 pod。当有多个元素时,与每个 podAffinityTerm 对应的节点列表会交集,例如所有术语都必须满足。
类型
array
描述
定义一组与给定命名空间匹配的 labelSelector 匹配的一组 pod (即,这个 pod 应该与运行 pod 的 pod 共存(关联性)或非并置(反关联性)匹配,其中 co-located 定义为在带有 <topologyKey> 标签值的节点上运行,其键为 <topologyKey> 匹配。
类型
对象
必填
  • topologyKey
Expand
属性类型描述

labelSelector

对象

对一组资源进行的标签查询,本例中为 pod。

命名空间

数组(字符串)

namespaces 指定 labelSelector 应用到的命名空间(匹配); null 或空列表表示"此 pod 的命名空间"

topologyKey

字符串

此 pod 应该并置(关联性)或与指定命名空间中的 labelSelector 匹配的 pod 共处(反关联性),其中 co-located 定义为运行任何带有 key topologyKey 的标签值的节点上运行。不允许空的 topologyKey。

描述
对一组资源进行的标签查询,本例中为 pod。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.33. .spec.affinity.podAntiAffinity

描述
描述 pod 反关联性调度规则(例如,避免将此 pod 放置到同一节点、区等)。
类型
对象
Expand
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

array

调度程序希望将 pod 调度到满足此字段指定的反关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、所需的DuringScheduling 反关联性表达式等)的节点,通过迭代此字段的元素以及 "weight" 的总和,如果节点具有与对应 podAffinityTerm 匹配的 pod,以及最高总和最高的节点。

preferredDuringSchedulingIgnoredDuringExecution[]

对象

每个节点会添加所有匹配的 WeightedPodAffinityTerm 字段的权重,以查找最首选的节点。

requiredDuringSchedulingIgnoredDuringExecution

array

如果在调度时没有满足此字段指定的反关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间发生此字段指定的反关联性要求(例如,由于 pod 标签更新),系统可能最终尝试从其节点驱除 pod。当有多个元素时,与每个 podAffinityTerm 对应的节点列表会交集,例如所有术语都必须满足。

requiredDuringSchedulingIgnoredDuringExecution[]

对象

定义一组与给定命名空间匹配的 labelSelector 匹配的一组 pod (即,这个 pod 应该与运行 pod 的 pod 共存(关联性)或非并置(反关联性)匹配,其中 co-located 定义为在带有 <topologyKey> 标签值的节点上运行,其键为 <topologyKey> 匹配。

描述
调度程序希望将 pod 调度到满足此字段指定的反关联性表达式的节点,但可以选择违反一个或多个表达式的节点。最首选的节点是,具有最高权重和最高权重的节点,即满足所有调度要求(资源请求、所需的DuringScheduling 反关联性表达式等)的节点,通过迭代此字段的元素以及 "weight" 的总和,如果节点具有与对应 podAffinityTerm 匹配的 pod,以及最高总和最高的节点。
类型
array
描述
每个节点会添加所有匹配的 WeightedPodAffinityTerm 字段的权重,以查找最首选的节点。
类型
对象
必填
  • podAffinityTerm
  • weight
Expand
属性类型描述

podAffinityTerm

对象

必需。与对应的权重关联的 pod 关联性术语。

weight

整数

与对应 podAffinityTerm 匹配的权重在 1-100 之间。

描述
必需。与对应的权重关联的 pod 关联性术语。
类型
对象
必填
  • topologyKey
Expand
属性类型描述

labelSelector

对象

对一组资源进行的标签查询,本例中为 pod。

命名空间

数组(字符串)

namespaces 指定 labelSelector 应用到的命名空间(匹配); null 或空列表表示"此 pod 的命名空间"

topologyKey

字符串

此 pod 应该并置(关联性)或与指定命名空间中的 labelSelector 匹配的 pod 共处(反关联性),其中 co-located 定义为运行任何带有 key topologyKey 的标签值的节点上运行。不允许空的 topologyKey。

描述
对一组资源进行的标签查询,本例中为 pod。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

描述
如果在调度时没有满足此字段指定的反关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间发生此字段指定的反关联性要求(例如,由于 pod 标签更新),系统可能最终尝试从其节点驱除 pod。当有多个元素时,与每个 podAffinityTerm 对应的节点列表会交集,例如所有术语都必须满足。
类型
array
描述
定义一组与给定命名空间匹配的 labelSelector 匹配的一组 pod (即,这个 pod 应该与运行 pod 的 pod 共存(关联性)或非并置(反关联性)匹配,其中 co-located 定义为在带有 <topologyKey> 标签值的节点上运行,其键为 <topologyKey> 匹配。
类型
对象
必填
  • topologyKey
Expand
属性类型描述

labelSelector

对象

对一组资源进行的标签查询,本例中为 pod。

命名空间

数组(字符串)

namespaces 指定 labelSelector 应用到的命名空间(匹配); null 或空列表表示"此 pod 的命名空间"

topologyKey

字符串

此 pod 应该并置(关联性)或与指定命名空间中的 labelSelector 匹配的 pod 共处(反关联性),其中 co-located 定义为运行任何带有 key topologyKey 的标签值的节点上运行。不允许空的 topologyKey。

描述
对一组资源进行的标签查询,本例中为 pod。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.45. .spec.alerting

描述
定义警报的详细信息。
类型
对象
必填
  • alertmanagers
Expand
属性类型描述

alertmanagers

array

AlertmanagerEndpoints Prometheus 应该针对它触发警报。

alertmanagers[]

对象

AlertmanagerEndpoints 定义单个 Endpoints 对象的选择,其中包含用于触发警报的 alertmanager IP。

14.6.1.46. .spec.alerting.alertmanagers

描述
AlertmanagerEndpoints Prometheus 应该针对它触发警报。
类型
array

14.6.1.47. .spec.alerting.alertmanagers[]

描述
AlertmanagerEndpoints 定义单个 Endpoints 对象的选择,其中包含用于触发警报的 alertmanager IP。
类型
对象
必填
  • name
  • namespace
  • port
Expand
属性类型描述

apiVersion

字符串

Prometheus 用来发送警报的 Alertmanager API 版本。它可以是 "v1" 或 "v2"。

授权

对象

此 alertmanager 端点的授权部分

bearerTokenFile

字符串

从向 Alertmanager 进行身份验证时使用的文件系统的 BearerTokenFile。

name

字符串

命名空间中的 Endpoints 对象的名称。

namespace

字符串

Endpoints 对象的命名空间。

pathPrefix

字符串

HTTP 路径警报的前缀被推送到。

port

integer-or-string

Alertmanager API 在其上公开的端口。

scheme

字符串

触发警报时要使用的方案。

timeout

字符串

在推送警报时,超时是一个每个目标 Alertmanager 超时。

tlsConfig

对象

用于 alertmanager 连接的 TLS 配置。

14.6.1.48. .spec.alerting.alertmanagers[].authorization

描述
此 alertmanager 端点的授权部分
类型
对象
Expand
属性类型描述

credentials

对象

包含请求凭证的 secret 密钥

type

字符串

设置身份验证类型。默认为 Bearer,Basic 将导致错误

描述
包含请求凭证的 secret 密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.50. .spec.alerting.alertmanagers[].tlsConfig

描述
用于 alertmanager 连接的 TLS 配置。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cafile

字符串

用于目标的 Prometheus 容器中 CA 证书的路径。

cert

对象

包含目标客户端证书文件的结构。

certFile

字符串

目标的 Prometheus 容器中客户端证书文件的路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

目标的 Prometheus 容器中客户端密钥文件的路径。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

14.6.1.51. .spec.alerting.alertmanagers[].tlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.54. .spec.alerting.alertmanagers[].tlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.58. .spec.apiserverConfig

描述
apiserverConfig 允许指定主机和 auth 方法来访问 apiserver。如果留空,则假定 Prometheus 在集群内运行,并自动发现 API 服务器,并使用 /var/run/secrets/kubernetes.io/serviceaccount/ 中的 pod 的 CA 证书和 bearer 令牌文件。
类型
对象
必填
  • 主机
Expand
属性类型描述

授权

对象

用于访问 apiserver 的授权部分

basicAuth

对象

basicAuth 允许端点通过基本身份验证进行身份验证

bearerToken

字符串

用于访问 apiserver 的 bearer 令牌。

bearerTokenFile

字符串

读取用于访问 apiserver 的 bearer 令牌的文件。

主机

字符串

apiserver 的主机。由主机名或 IP 组成的有效字符串,后跟一个可选的端口号

tlsConfig

对象

用于访问 apiserver 的 TLS 配置。

14.6.1.59. .spec.apiserverConfig.authorization

描述
用于访问 apiserver 的授权部分
类型
对象
Expand
属性类型描述

credentials

对象

包含请求凭证的 secret 密钥

credentialsFile

字符串

从中读取 secret 的文件,与凭证相互排斥(来自 SafeAuthorization)

type

字符串

设置身份验证类型。默认为 Bearer,Basic 将导致错误

14.6.1.60. .spec.apiserverConfig.authorization.credentials

描述
包含请求凭证的 secret 密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.61. .spec.apiserverConfig.basicAuth

描述
basicAuth 允许端点通过基本身份验证进行身份验证
类型
对象
Expand
属性类型描述

password

对象

服务监控命名空间中的 secret,其中包含用于身份验证的密码。

username

对象

服务监控命名空间中的 secret,其中包含用于身份验证的用户名。

14.6.1.62. .spec.apiserverConfig.basicAuth.password

描述
服务监控命名空间中的 secret,其中包含用于身份验证的密码。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.63. .spec.apiserverConfig.basicAuth.username

描述
服务监控命名空间中的 secret,其中包含用于身份验证的用户名。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.64. .spec.apiserverConfig.tlsConfig

描述
用于访问 apiserver 的 TLS 配置。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cafile

字符串

用于目标的 Prometheus 容器中 CA 证书的路径。

cert

对象

包含目标客户端证书文件的结构。

certFile

字符串

目标的 Prometheus 容器中客户端证书文件的路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

目标的 Prometheus 容器中客户端密钥文件的路径。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

14.6.1.65. .spec.apiserverConfig.tlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.66. .spec.apiserverConfig.tlsConfig.ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.67. .spec.apiserverConfig.tlsConfig.ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.68. .spec.apiserverConfig.tlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.69. .spec.apiserverConfig.tlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.70. .spec.apiserverConfig.tlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.71. .spec.apiserverConfig.tlsConfig.keySecret

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.72. .spec.arbitraryFSAccessThroughSMs

描述
arbitraryFSAccessThroughSMs 配置基于服务监控器的配置是否可以访问 Prometheus 容器文件系统上的任意文件,如 bearer 令牌文件。
类型
对象
Expand
属性类型描述

deny

布尔值

 

14.6.1.73. .spec.containers

描述
容器允许注入其他容器或修改 Operator 生成的容器。这可用于允许向 Prometheus pod 添加身份验证代理,或更改 Operator 生成的容器的行为。如果容器共享相同名称和修改是通过策略合并补丁进行的,则此处描述的容器会修改 Operator 生成的容器。当前容器名称有: prometheusconfig-reloaderthanos-sidecar。覆盖容器完全不在维护人员支持的范围之外,您可以接受这种行为可能会随时中断,而不会注意到。
类型
array

14.6.1.74. .spec.containers[]

描述
要在 pod 中运行的单一应用程序容器。
类型
对象
必填
  • name
Expand
属性类型描述

args

数组(字符串)

入口点的参数。如果没有提供,则使用 docker 镜像的 CMD。变量引用 $(VAR_NAME)使用容器的环境扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

命令

数组(字符串)

ENTRYPOINT 数组。不在 shell 中执行。如果没有提供,则使用 docker 镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器的环境扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

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

env[]

对象

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

envFrom

array

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

envFrom[]

对象

EnvFromSource 代表一组 ConfigMap 的源

image

字符串

Docker 镜像名称。更多信息: https://kubernetes.io/docs/concepts/containers/images 此字段是可选的,允许更高级别的配置管理在工作负载控制器(如 Deployment 和 StatefulSets)中覆盖默认或覆盖容器镜像。

imagePullPolicy

字符串

镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签,则默认为 Always,否则为 IfNotPresent。无法更新。更多信息: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

对象

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

livenessProbe

对象

定期探测容器存活度。如果探测失败,容器将重启。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

字符串

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

ports

array

要从容器公开的端口列表。在此处公开端口可让系统有关容器使用的网络连接的额外信息,但主要是信息。在这里不指定端口不阻止公开该端口。任何侦听容器内的默认"0.0.0.0"地址的端口都可从网络访问。无法更新。

ports[]

对象

containerPort 代表单个容器中的网络端口。

readinessProbe

对象

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

资源

对象

此容器所需的计算资源。无法更新。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

securityContext

对象

pod 应该使用的安全选项运行。更多信息: https://kubernetes.io/docs/concepts/policy/security-context/ 更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

对象

startupProbe 表示 Pod 已成功初始化。如果指定,则不会执行其他探测,直到成功完成为止。如果这个探测失败,则 Pod 将重启,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,当可能需要很长时间才能加载数据或热缓存时,而不是处于 steady-state 操作期间。无法更新。这是 StartupProbe 功能标记启用的 beta 功能。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdin

布尔值

此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置,则容器中的 stdin 读取始终会导致 EOF。默认值为 false。

stdinOnce

布尔值

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

terminationMessagePath

字符串

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

terminationMessagePolicy

字符串

指明终止消息应如何填充。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空,且容器退出并显示错误,则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行(以小)。默认为 file。无法更新。

tty

布尔值

此容器是否应为其自身分配一个 一 个,还需要"stdin"为 true。默认值为 false。

volumeDevices

array

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

volumeDevices[]

对象

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

volumeMounts

array

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

volumeMounts[]

对象

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

workingDir

字符串

容器的工作目录。如果没有指定,则使用容器运行时的默认值,这可能会在容器镜像中配置。无法更新。

14.6.1.75. .spec.containers[].env

描述
要在容器中设置的环境变量列表。无法更新。
类型
array

14.6.1.76. .spec.containers[].env[]

描述
EnvVar 代表容器中存在的环境变量。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

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

value

字符串

变量引用 $(VAR_NAME)使用容器中之前定义的环境变量以及任何服务环境变量进行扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。默认值为 ""。

valueFrom

对象

环境变量值的源。如果值不为空,则无法使用。

14.6.1.77. .spec.containers[].env[].valueFrom

描述
环境变量值的源。如果值不为空,则无法使用。
类型
对象
Expand
属性类型描述

configMapKeyRef

对象

选择 ConfigMap 的键。

fieldRef

对象

选择 pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels、metadata.annotations、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。

resourceFieldRef

对象

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

secretKeyRef

对象

在 pod 命名空间中选择一个 secret 的密钥

描述
选择 ConfigMap 的键。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.79. .spec.containers[].env[].valueFrom.fieldRef

描述
选择 pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels、metadata.annotations、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。
类型
对象
必填
  • fieldPath
Expand
属性类型描述

apiVersion

字符串

FieldPath 编写的模式版本,默认为 "v1"。

fieldPath

字符串

要在指定 API 版本中选择的字段路径。

描述
选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limit.memory、limit.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。
类型
对象
必填
  • resource
Expand
属性类型描述

containerName

字符串

容器名称:卷需要,对于 env vars 是可选的

divisor

integer-or-string

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

14.6.1.81. .spec.containers[].env[].valueFrom.secretKeyRef

描述
在 pod 命名空间中选择一个 secret 的密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.82. .spec.containers[].envFrom

描述
在容器中填充环境变量的源列表。源中定义的密钥必须是 C_IDENTIFIER。容器启动时,所有无效密钥都会报告为事件。当多个源中存在键时,与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。
类型
array

14.6.1.83. .spec.containers[].envFrom[]

描述
EnvFromSource 代表一组 ConfigMap 的源
类型
对象
Expand
属性类型描述

configMapRef

对象

要从中选择的 ConfigMap

prefix

字符串

ConfigMap 中每个键的可选标识符。必须是 C_IDENTIFIER。

secretRef

对象

要从中选择的 Secret

14.6.1.84. .spec.containers[].envFrom[].configMapRef

描述
要从中选择的 ConfigMap
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap

14.6.1.85. .spec.containers[].envFrom[].secretRef

描述
要从中选择的 Secret
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret

14.6.1.86. .spec.containers[].lifecycle

描述
管理系统应采取的操作响应容器生命周期事件。无法更新。
类型
对象
Expand
属性类型描述

postStart

对象

postStart 在容器创建后立即调用。如果处理程序失败,容器将被终止并根据重启策略重启。容器块的其他管理,直到 hook 完成为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

对象

由于 API 请求或管理事件(如存活度/启动探测失败、抢占、资源争用等),在容器终止之前调用 preStop。如果容器崩溃或退出,则不会调用处理程序。终止发送到处理器的原因。Pod 的终止宽限期计数在执行 PreStop hooked 之前开始。无论处理程序的结果是什么,容器最终会在 Pod 终止宽限期内终止。容器块的其他管理,直到 hook 完成或直到达到终止宽限期为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

14.6.1.87. .spec.containers[].lifecycle.postStart

描述
postStart 在容器创建后立即调用。如果处理程序失败,容器将被终止并根据重启策略重启。容器块的其他管理,直到 hook 完成为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

httpGet

对象

httpGet 指定要执行的 http 请求。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

14.6.1.88. .spec.containers[].lifecycle.postStart.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.89. .spec.containers[].lifecycle.postStart.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.92. .spec.containers[].lifecycle.postStart.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.93. .spec.containers[].lifecycle.preStop

描述
由于 API 请求或管理事件(如存活度/启动探测失败、抢占、资源争用等),在容器终止之前调用 preStop。如果容器崩溃或退出,则不会调用处理程序。终止发送到处理器的原因。Pod 的终止宽限期计数在执行 PreStop hooked 之前开始。无论处理程序的结果是什么,容器最终会在 Pod 终止宽限期内终止。容器块的其他管理,直到 hook 完成或直到达到终止宽限期为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

httpGet

对象

httpGet 指定要执行的 http 请求。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

14.6.1.94. .spec.containers[].lifecycle.preStop.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.95. .spec.containers[].lifecycle.preStop.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.98. .spec.containers[].lifecycle.preStop.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.99. .spec.containers[].livenessProbe

描述
定期探测容器存活度。如果探测失败,容器将重启。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.100. .spec.containers[].livenessProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.101. .spec.containers[].livenessProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.104. .spec.containers[].livenessProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.105. .spec.containers[].ports

描述
要从容器公开的端口列表。在此处公开端口可让系统有关容器使用的网络连接的额外信息,但主要是信息。在这里不指定端口不阻止公开该端口。任何侦听容器内的默认"0.0.0.0"地址的端口都可从网络访问。无法更新。
类型
array

14.6.1.106. .spec.containers[].ports[]

描述
containerPort 代表单个容器中的网络端口。
类型
对象
必填
  • containerPort
Expand
属性类型描述

containerPort

整数

在 pod IP 地址上公开的端口数量。这必须是有效的端口号 0 < x < 65536。

hostIP

字符串

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

hostPort

整数

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

name

字符串

如果指定,这必须是 pod 中的 IANA_SVC_NAME 和 unique。pod 中的每个命名端口都必须具有唯一的名称。服务可以引用的端口的名称。

protocol

字符串

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

14.6.1.107. .spec.containers[].readinessProbe

描述
容器服务的定期探测。如果探测失败,容器将从服务端点中删除。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.108. .spec.containers[].readinessProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.109. .spec.containers[].readinessProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.112. .spec.containers[].readinessProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.113. .spec.containers[].resources

描述
此容器所需的计算资源。无法更新。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

14.6.1.114. .spec.containers[].securityContext

描述
pod 应该使用的安全选项运行。更多信息: https://kubernetes.io/docs/concepts/policy/security-context/ 更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
类型
对象
Expand
属性类型描述

allowPrivilegeEscalation

布尔值

allowPrivilegeEscalation 控制进程是否可以获得比父进程更多的特权。此 bool 直接控制是否在容器进程上设置 no_new_privs 标志。当容器为 1 时,allowPrivilegeEscalation 始终为 true,作为 Privileged 2 运行)具有 CAP_SYS_ADMIN

功能

对象

运行容器时添加/丢弃的功能。默认为容器运行时授予的默认功能集。

privileged

布尔值

以特权模式运行容器。特权容器中的进程基本上相当于主机上的 root。默认为false。

procMount

字符串

procMount 表示要用于容器的 proc 挂载类型。默认为 DefaultProcMount,它对只读路径和屏蔽的路径使用容器运行时默认值。这需要启用 ProcMountType 功能标记。

readOnlyRootFilesystem

布尔值

此容器是否具有只读根文件系统。默认值为 false。

runAsGroup

整数

运行容器进程的入口点的 GID。如果未设置,则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

runAsNonRoot

布尔值

表示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证镜像,以确保它不会以 UID 0 (root)运行,如果容器确实正常运行。如果未设置或为 false,则不会执行这样的验证。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

runAsUser

整数

运行容器进程的入口点的 UID。如果未指定,则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

seLinuxOptions

对象

要应用到容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

windowsOptions

对象

应用到所有容器的 Windows 具体设置。如果未指定,则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

14.6.1.115. .spec.containers[].securityContext.capabilities

描述
运行容器时添加/丢弃的功能。默认为容器运行时授予的默认功能集。
类型
对象
Expand
属性类型描述

add

数组(字符串)

添加了功能

drop

数组(字符串)

删除的功能

描述
要应用到容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。
类型
对象
Expand
属性类型描述

level

字符串

level 是应用到容器的 SELinux 级别标签。

role

字符串

Role 是一个适用于容器的 SELinux 角色标签。

type

字符串

type 是应用到容器的 SELinux 类型标签。

user

字符串

用户是应用到容器的 SELinux 用户标签。

描述
应用到所有容器的 Windows 具体设置。如果未指定,则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。
类型
对象
Expand
属性类型描述

gmsaCredentialSpec

字符串

GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa)内联由 GMSACredentialSpecName 字段命名的 GMSA 凭证规格的内容。

gmsaCredentialSpecName

字符串

GMSACredentialSpecName 是要使用的 GMSA 凭证规格的名称。

runAsUserName

字符串

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

14.6.1.118. .spec.containers[].startupProbe

描述
startupProbe 表示 Pod 已成功初始化。如果指定,则不会执行其他探测,直到成功完成为止。如果这个探测失败,则 Pod 将重启,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,当可能需要很长时间才能加载数据或热缓存时,而不是处于 steady-state 操作期间。无法更新。这是 StartupProbe 功能标记启用的 beta 功能。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.119. .spec.containers[].startupProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.120. .spec.containers[].startupProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.123. .spec.containers[].startupProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.124. .spec.containers[].volumeDevices

描述
volumeDevices 是容器要使用的块设备列表。
类型
array

14.6.1.125. .spec.containers[].volumeDevices[]

描述
volumeDevice 描述了容器中原始块设备的映射。
类型
对象
必填
  • devicePath
  • name
Expand
属性类型描述

devicePath

字符串

DevicePath 是设备要映射到的容器内的路径。

name

字符串

名称必须与 pod 中的 persistentVolumeClaim 的名称匹配

14.6.1.126. .spec.containers[].volumeMounts

描述
要挂载到容器文件系统的 Pod 卷。无法更新。
类型
array

14.6.1.127. .spec.containers[].volumeMounts[]

描述
VolumeMount 描述了容器内卷的挂载。
类型
对象
必填
  • mountPath
  • name
Expand
属性类型描述

mountPath

字符串

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

mountPropagation

字符串

mountPropagation 决定如何将挂载从主机传播到容器,以及传输的其他方式。如果没有设置,则使用 MountPropagationNone。此字段在 1.10 中是 beta。

name

字符串

这必须与卷的名称匹配。

readOnly

布尔值

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

subPath

字符串

应该从中挂载容器卷的卷内的路径。默认为 "" (卷的 root)。

subPathExpr

字符串

在卷中应该挂载容器的卷的扩展路径。的行为与 SubPath 类似,但环境变量引用 $(VAR_NAME)使用容器的环境扩展。默认为 "" (卷的 root)。SubPathExpr 和 SubPath 是互斥的。

14.6.1.128. .spec.imagePullSecrets

描述
用于从 registry 中拉取 prometheus 和 alertmanager 镜像的 secret 的可选引用列表,请参阅 http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
类型
array

14.6.1.129. .spec.imagePullSecrets[]

描述
LocalObjectReference 包含足够信息,供您在同一命名空间中查找引用的对象。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.130. .spec.initContainers

描述
initContainers 允许将 initContainers 添加到 pod 定义中。它们可用于从外部来源获取用于注入 Prometheus 配置的 secret。执行 initContainer 期间的任何错误将导致 Pod 重启。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers 描述了修改 Operator 生成的 init 容器,如果它们共享相同的名称和修改,则通过策略合并补丁进行。当前的 init 容器名称为: init-config-reloader。覆盖 init 容器完全超出了维护人员支持的范围,因此您接受这个行为可能会在不通知的情况下中断。
类型
array

14.6.1.131. .spec.initContainers[]

描述
要在 pod 中运行的单一应用程序容器。
类型
对象
必填
  • name
Expand
属性类型描述

args

数组(字符串)

入口点的参数。如果没有提供,则使用 docker 镜像的 CMD。变量引用 $(VAR_NAME)使用容器的环境扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

命令

数组(字符串)

ENTRYPOINT 数组。不在 shell 中执行。如果没有提供,则使用 docker 镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器的环境扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

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

env[]

对象

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

envFrom

array

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

envFrom[]

对象

EnvFromSource 代表一组 ConfigMap 的源

image

字符串

Docker 镜像名称。更多信息: https://kubernetes.io/docs/concepts/containers/images 此字段是可选的,允许更高级别的配置管理在工作负载控制器(如 Deployment 和 StatefulSets)中覆盖默认或覆盖容器镜像。

imagePullPolicy

字符串

镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签,则默认为 Always,否则为 IfNotPresent。无法更新。更多信息: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

对象

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

livenessProbe

对象

定期探测容器存活度。如果探测失败,容器将重启。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

字符串

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

ports

array

要从容器公开的端口列表。在此处公开端口可让系统有关容器使用的网络连接的额外信息,但主要是信息。在这里不指定端口不阻止公开该端口。任何侦听容器内的默认"0.0.0.0"地址的端口都可从网络访问。无法更新。

ports[]

对象

containerPort 代表单个容器中的网络端口。

readinessProbe

对象

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

资源

对象

此容器所需的计算资源。无法更新。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

securityContext

对象

pod 应该使用的安全选项运行。更多信息: https://kubernetes.io/docs/concepts/policy/security-context/ 更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

对象

startupProbe 表示 Pod 已成功初始化。如果指定,则不会执行其他探测,直到成功完成为止。如果这个探测失败,则 Pod 将重启,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,当可能需要很长时间才能加载数据或热缓存时,而不是处于 steady-state 操作期间。无法更新。这是 StartupProbe 功能标记启用的 beta 功能。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdin

布尔值

此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置,则容器中的 stdin 读取始终会导致 EOF。默认值为 false。

stdinOnce

布尔值

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

terminationMessagePath

字符串

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

terminationMessagePolicy

字符串

指明终止消息应如何填充。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空,且容器退出并显示错误,则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行(以小)。默认为 file。无法更新。

tty

布尔值

此容器是否应为其自身分配一个 一 个,还需要"stdin"为 true。默认值为 false。

volumeDevices

array

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

volumeDevices[]

对象

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

volumeMounts

array

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

volumeMounts[]

对象

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

workingDir

字符串

容器的工作目录。如果没有指定,则使用容器运行时的默认值,这可能会在容器镜像中配置。无法更新。

14.6.1.132. .spec.initContainers[].env

描述
要在容器中设置的环境变量列表。无法更新。
类型
array

14.6.1.133. .spec.initContainers[].env[]

描述
EnvVar 代表容器中存在的环境变量。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

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

value

字符串

变量引用 $(VAR_NAME)使用容器中之前定义的环境变量以及任何服务环境变量进行扩展。如果无法解析变量,则输入字符串中的引用不会改变。$(VAR_NAME)语法可以使用双 ie: (VAR_NAME)进行转义。转义的引用永远不会扩展,无论变量是否存在。默认值为 ""。

valueFrom

对象

环境变量值的源。如果值不为空,则无法使用。

14.6.1.134. .spec.initContainers[].env[].valueFrom

描述
环境变量值的源。如果值不为空,则无法使用。
类型
对象
Expand
属性类型描述

configMapKeyRef

对象

选择 ConfigMap 的键。

fieldRef

对象

选择 pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels、metadata.annotations、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。

resourceFieldRef

对象

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

secretKeyRef

对象

在 pod 命名空间中选择一个 secret 的密钥

描述
选择 ConfigMap 的键。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.136. .spec.initContainers[].env[].valueFrom.fieldRef

描述
选择 pod 的字段:支持 metadata.name、metadata.namespace、metadata.labels、metadata.annotations、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。
类型
对象
必填
  • fieldPath
Expand
属性类型描述

apiVersion

字符串

FieldPath 编写的模式版本,默认为 "v1"。

fieldPath

字符串

要在指定 API 版本中选择的字段路径。

描述
选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limit.memory、limit.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。
类型
对象
必填
  • resource
Expand
属性类型描述

containerName

字符串

容器名称:卷需要,对于 env vars 是可选的

divisor

integer-or-string

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

描述
在 pod 命名空间中选择一个 secret 的密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.139. .spec.initContainers[].envFrom

描述
在容器中填充环境变量的源列表。源中定义的密钥必须是 C_IDENTIFIER。容器启动时,所有无效密钥都会报告为事件。当多个源中存在键时,与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。
类型
array

14.6.1.140. .spec.initContainers[].envFrom[]

描述
EnvFromSource 代表一组 ConfigMap 的源
类型
对象
Expand
属性类型描述

configMapRef

对象

要从中选择的 ConfigMap

prefix

字符串

ConfigMap 中每个键的可选标识符。必须是 C_IDENTIFIER。

secretRef

对象

要从中选择的 Secret

14.6.1.141. .spec.initContainers[].envFrom[].configMapRef

描述
要从中选择的 ConfigMap
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap

14.6.1.142. .spec.initContainers[].envFrom[].secretRef

描述
要从中选择的 Secret
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret

14.6.1.143. .spec.initContainers[].lifecycle

描述
管理系统应采取的操作响应容器生命周期事件。无法更新。
类型
对象
Expand
属性类型描述

postStart

对象

postStart 在容器创建后立即调用。如果处理程序失败,容器将被终止并根据重启策略重启。容器块的其他管理,直到 hook 完成为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

对象

由于 API 请求或管理事件(如存活度/启动探测失败、抢占、资源争用等),在容器终止之前调用 preStop。如果容器崩溃或退出,则不会调用处理程序。终止发送到处理器的原因。Pod 的终止宽限期计数在执行 PreStop hooked 之前开始。无论处理程序的结果是什么,容器最终会在 Pod 终止宽限期内终止。容器块的其他管理,直到 hook 完成或直到达到终止宽限期为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

14.6.1.144. .spec.initContainers[].lifecycle.postStart

描述
postStart 在容器创建后立即调用。如果处理程序失败,容器将被终止并根据重启策略重启。容器块的其他管理,直到 hook 完成为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

httpGet

对象

httpGet 指定要执行的 http 请求。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

14.6.1.145. .spec.initContainers[].lifecycle.postStart.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.150. .spec.initContainers[].lifecycle.preStop

描述
由于 API 请求或管理事件(如存活度/启动探测失败、抢占、资源争用等),在容器终止之前调用 preStop。如果容器崩溃或退出,则不会调用处理程序。终止发送到处理器的原因。Pod 的终止宽限期计数在执行 PreStop hooked 之前开始。无论处理程序的结果是什么,容器最终会在 Pod 终止宽限期内终止。容器块的其他管理,直到 hook 完成或直到达到终止宽限期为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

httpGet

对象

httpGet 指定要执行的 http 请求。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

14.6.1.151. .spec.initContainers[].lifecycle.preStop.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.156. .spec.initContainers[].livenessProbe

描述
定期探测容器存活度。如果探测失败,容器将重启。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.157. .spec.initContainers[].livenessProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.158. .spec.initContainers[].livenessProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.161. .spec.initContainers[].livenessProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.162. .spec.initContainers[].ports

描述
要从容器公开的端口列表。在此处公开端口可让系统有关容器使用的网络连接的额外信息,但主要是信息。在这里不指定端口不阻止公开该端口。任何侦听容器内的默认"0.0.0.0"地址的端口都可从网络访问。无法更新。
类型
array

14.6.1.163. .spec.initContainers[].ports[]

描述
containerPort 代表单个容器中的网络端口。
类型
对象
必填
  • containerPort
Expand
属性类型描述

containerPort

整数

在 pod IP 地址上公开的端口数量。这必须是有效的端口号 0 < x < 65536。

hostIP

字符串

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

hostPort

整数

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

name

字符串

如果指定,这必须是 pod 中的 IANA_SVC_NAME 和 unique。pod 中的每个命名端口都必须具有唯一的名称。服务可以引用的端口的名称。

protocol

字符串

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

14.6.1.164. .spec.initContainers[].readinessProbe

描述
容器服务的定期探测。如果探测失败,容器将从服务端点中删除。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.165. .spec.initContainers[].readinessProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.166. .spec.initContainers[].readinessProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.169. .spec.initContainers[].readinessProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.170. .spec.initContainers[].resources

描述
此容器所需的计算资源。无法更新。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

14.6.1.171. .spec.initContainers[].securityContext

描述
pod 应该使用的安全选项运行。更多信息: https://kubernetes.io/docs/concepts/policy/security-context/ 更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
类型
对象
Expand
属性类型描述

allowPrivilegeEscalation

布尔值

allowPrivilegeEscalation 控制进程是否可以获得比父进程更多的特权。此 bool 直接控制是否在容器进程上设置 no_new_privs 标志。当容器为 1 时,allowPrivilegeEscalation 始终为 true,作为 Privileged 2 运行)具有 CAP_SYS_ADMIN

功能

对象

运行容器时添加/丢弃的功能。默认为容器运行时授予的默认功能集。

privileged

布尔值

以特权模式运行容器。特权容器中的进程基本上相当于主机上的 root。默认为false。

procMount

字符串

procMount 表示要用于容器的 proc 挂载类型。默认为 DefaultProcMount,它对只读路径和屏蔽的路径使用容器运行时默认值。这需要启用 ProcMountType 功能标记。

readOnlyRootFilesystem

布尔值

此容器是否具有只读根文件系统。默认值为 false。

runAsGroup

整数

运行容器进程的入口点的 GID。如果未设置,则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

runAsNonRoot

布尔值

表示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证镜像,以确保它不会以 UID 0 (root)运行,如果容器确实正常运行。如果未设置或为 false,则不会执行这样的验证。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

runAsUser

整数

运行容器进程的入口点的 UID。如果未指定,则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

seLinuxOptions

对象

要应用到容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

windowsOptions

对象

应用到所有容器的 Windows 具体设置。如果未指定,则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

描述
运行容器时添加/丢弃的功能。默认为容器运行时授予的默认功能集。
类型
对象
Expand
属性类型描述

add

数组(字符串)

添加了功能

drop

数组(字符串)

删除的功能

描述
要应用到容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。
类型
对象
Expand
属性类型描述

level

字符串

level 是应用到容器的 SELinux 级别标签。

role

字符串

Role 是一个适用于容器的 SELinux 角色标签。

type

字符串

type 是应用到容器的 SELinux 类型标签。

user

字符串

用户是应用到容器的 SELinux 用户标签。

描述
应用到所有容器的 Windows 具体设置。如果未指定,则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。
类型
对象
Expand
属性类型描述

gmsaCredentialSpec

字符串

GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa)内联由 GMSACredentialSpecName 字段命名的 GMSA 凭证规格的内容。

gmsaCredentialSpecName

字符串

GMSACredentialSpecName 是要使用的 GMSA 凭证规格的名称。

runAsUserName

字符串

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

14.6.1.175. .spec.initContainers[].startupProbe

描述
startupProbe 表示 Pod 已成功初始化。如果指定,则不会执行其他探测,直到成功完成为止。如果这个探测失败,则 Pod 将重启,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,当可能需要很长时间才能加载数据或热缓存时,而不是处于 steady-state 操作期间。无法更新。这是 StartupProbe 功能标记启用的 beta 功能。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
类型
对象
Expand
属性类型描述

exec

对象

应该只指定以下之一和其中之一。exec 指定要执行的操作。

failureThreshold

整数

成功后探测被视为失败的最小连续失败。默认值为 3。最小值为 1。

httpGet

对象

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

在启动存活度探测前容器启动后的秒数。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

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

successThreshold

整数

在失败后,探测的连续成功才被视为成功。默认值为 1。对于存活度和启动,必须是 1。最小值为 1。

tcpSocket

对象

tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook

timeoutSeconds

整数

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

14.6.1.176. .spec.initContainers[].startupProbe.exec

描述
应该只指定以下之一和其中之一。exec 指定要执行的操作。
类型
对象
Expand
属性类型描述

命令

数组(字符串)

command 是在容器内执行的命令行,命令的工作目录是容器文件系统中的根目录('/')。命令只是 exec,它不在 shell 中运行,因此传统的 shell 指令('|' 等)将无法工作。要使用 shell,您需要明确调用至该 shell。退出状态 0 被视为 live/healthy,非零则被视为不健康。

14.6.1.177. .spec.initContainers[].startupProbe.httpGet

描述
httpGet 指定要执行的 http 请求。
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置 "Host"。

httpHeaders

array

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

httpHeaders[]

对象

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

path

字符串

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

port

integer-or-string

要在容器中访问的端口的名称或数。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

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

描述
要在请求中设置的自定义标头。HTTP 允许重复标头。
类型
array
描述
HTTPHeader 描述了在 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

标头字段名称

value

字符串

标头字段值

14.6.1.180. .spec.initContainers[].startupProbe.tcpSocket

描述
tcpSocket 指定涉及 TCP 端口的操作。尚不支持 TCP hook:实现实际的 TCP 生命周期 hook
类型
对象
必填
  • port
Expand
属性类型描述

主机

字符串

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

port

integer-or-string

要在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

14.6.1.181. .spec.initContainers[].volumeDevices

描述
volumeDevices 是容器要使用的块设备列表。
类型
array

14.6.1.182. .spec.initContainers[].volumeDevices[]

描述
volumeDevice 描述了容器中原始块设备的映射。
类型
对象
必填
  • devicePath
  • name
Expand
属性类型描述

devicePath

字符串

DevicePath 是设备要映射到的容器内的路径。

name

字符串

名称必须与 pod 中的 persistentVolumeClaim 的名称匹配

14.6.1.183. .spec.initContainers[].volumeMounts

描述
要挂载到容器文件系统的 Pod 卷。无法更新。
类型
array

14.6.1.184. .spec.initContainers[].volumeMounts[]

描述
VolumeMount 描述了容器内卷的挂载。
类型
对象
必填
  • mountPath
  • name
Expand
属性类型描述

mountPath

字符串

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

mountPropagation

字符串

mountPropagation 决定如何将挂载从主机传播到容器,以及传输的其他方式。如果没有设置,则使用 MountPropagationNone。此字段在 1.10 中是 beta。

name

字符串

这必须与卷的名称匹配。

readOnly

布尔值

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

subPath

字符串

应该从中挂载容器卷的卷内的路径。默认为 "" (卷的 root)。

subPathExpr

字符串

在卷中应该挂载容器的卷的扩展路径。的行为与 SubPath 类似,但环境变量引用 $(VAR_NAME)使用容器的环境扩展。默认为 "" (卷的 root)。SubPathExpr 和 SubPath 是互斥的。

14.6.1.185. .spec.podMetadata

描述
PodMetadata 配置向 prometheus pod 传播的标签和注解。
类型
对象
Expand
属性类型描述

annotations

对象(字符串)

注解是一个无结构的键值映射,与资源存储,可通过外部工具设置来存储和检索任意元数据。它们不可查询,应在修改对象时保留。更多信息: http://kubernetes.io/docs/user-guide/annotations

labels

对象(字符串)

可用于组织和分类(范围和选择)对象的字符串键和值映射。可能与复制控制器和服务选择器匹配。更多信息: http://kubernetes.io/docs/user-guide/labels

name

字符串

名称在命名空间中必须是唯一的。在创建资源时是必需的,但有些资源可能允许客户端自动请求生成适当名称。名称主要用于创建 idempotence 和配置定义。无法更新。更多信息: http://kubernetes.io/docs/user-guide/identifiers#names

14.6.1.186. .spec.podMonitorNamespaceSelector

描述
命名空间的标签,用于 PodMonitor 发现。如果为 nil,则只检查自己的命名空间。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.189. .spec.podMonitorSelector

描述
为目标发现选择 实验性 PodMonitor。弃用: 如果没有指定此和 serviceMonitorSelector,则配置将非受管。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.190. .spec.podMonitorSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.191. .spec.podMonitorSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.192. .spec.probeNamespaceSelector

描述
为探测发现选择 实验性 命名空间。如果为 nil,则只检查自己的命名空间。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.193. .spec.probeNamespaceSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.194. .spec.probeNamespaceSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.195. .spec.probeSelector

描述
为目标发现选择 实验性 探测。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.196. .spec.probeSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.197. .spec.probeSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.198. .spec.prometheusRulesExcludedFromEnforce

描述
prometheusRulesExcludedFromEnforce - 要从添加命名空间标签的 enforcing 中排除的 prometheus 规则列表。仅在 enforcedNamespaceLabel 设置为 true 时才有效。确保为每个对设置了 ruleNamespace 和 ruleName
类型
array

14.6.1.199. .spec.prometheusRulesExcludedFromEnforce[]

描述
PrometheusRuleExcludeConfig 允许用户配置排除的 PrometheusRule 名称及其命名空间,同时为警报和指标强制命名空间标签。
类型
对象
必填
  • ruleName
  • ruleNamespace
Expand
属性类型描述

ruleName

字符串

RuleNamespace - 排除规则的名称

ruleNamespace

字符串

RuleNamespace - 排除规则的命名空间

14.6.1.200. .spec.query

描述
QuerySpec 定义启动 Prometheus 时的查询命令行标志。
类型
对象
Expand
属性类型描述

lookbackDelta

字符串

在表达式评估期间允许检索指标的 delta 差别。

maxConcurrency

整数

可以同时运行的并发查询数。

maxSamples

整数

单个查询可加载到内存的最大样本数。请注意,如果查询将超过此样本加载到内存中,则查询将失败,因此也会限制查询可以返回的样本数量。

timeout

字符串

查询在中止前可能需要的最长时间。

14.6.1.201. .spec.remoteRead

描述
如果指定,remote_read spec。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。
类型
array

14.6.1.202. .spec.remoteRead[]

描述
RemoteReadSpec 为 prometheus 定义 remote_read 配置。
类型
对象
必填
  • url
Expand
属性类型描述

授权

对象

远程读取的授权部分

basicAuth

对象

URL 的basicAuth。

bearerToken

字符串

用于远程读取的 bearer 令牌。

bearerTokenFile

字符串

用于读取远程读取的 bearer 令牌的文件。

name

字符串

如果指定,远程读取队列的名称必须是唯一的。名称用于指标和登录,以区分读取配置。仅在 Prometheus 版本 2.15.0 及更新版本中有效。

oauth2

对象

用于 URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

proxyUrl

字符串

可选 ProxyURL

readRecent

布尔值

是否应该对本地存储应具有完整数据的时间范围进行查询。

remoteTimeout

字符串

对远程读取端点的请求超时。

requiredMatchers

对象(字符串)

可选的匹配者列表必须存在于选择器中,才能查询远程读取端点。

tlsConfig

对象

用于远程读取的 TLS 配置。

url

字符串

要发送示例的端点的 URL。

14.6.1.203. .spec.remoteRead[].authorization

描述
远程读取的授权部分
类型
对象
Expand
属性类型描述

credentials

对象

包含请求凭证的 secret 密钥

credentialsFile

字符串

从中读取 secret 的文件,与凭证相互排斥(来自 SafeAuthorization)

type

字符串

设置身份验证类型。默认为 Bearer,Basic 将导致错误

14.6.1.204. .spec.remoteRead[].authorization.credentials

描述
包含请求凭证的 secret 密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.205. .spec.remoteRead[].basicAuth

描述
URL 的basicAuth。
类型
对象
Expand
属性类型描述

password

对象

服务监控命名空间中的 secret,其中包含用于身份验证的密码。

username

对象

服务监控命名空间中的 secret,其中包含用于身份验证的用户名。

14.6.1.206. .spec.remoteRead[].basicAuth.password

描述
服务监控命名空间中的 secret,其中包含用于身份验证的密码。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.207. .spec.remoteRead[].basicAuth.username

描述
服务监控命名空间中的 secret,其中包含用于身份验证的用户名。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.208. .spec.remoteRead[].oauth2

描述
用于 URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。
类型
对象
必填
  • clientId
  • clientSecret
  • tokenUrl
Expand
属性类型描述

clientId

对象

包含 OAuth2 客户端 ID 的 secret 或 configmap

clientSecret

对象

包含 OAuth2 客户端 secret 的 secret

endpointParams

对象(字符串)

附加到令牌 URL 的参数

范围

数组(字符串)

用于令牌请求的 OAuth2 范围

tokenUrl

字符串

从中获取令牌的 URL

14.6.1.209. .spec.remoteRead[].oauth2.clientId

描述
包含 OAuth2 客户端 ID 的 secret 或 configmap
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.210. .spec.remoteRead[].oauth2.clientId.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.211. .spec.remoteRead[].oauth2.clientId.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.212. .spec.remoteRead[].oauth2.clientSecret

描述
包含 OAuth2 客户端 secret 的 secret
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.213. .spec.remoteRead[].tlsConfig

描述
用于远程读取的 TLS 配置。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cafile

字符串

用于目标的 Prometheus 容器中 CA 证书的路径。

cert

对象

包含目标客户端证书文件的结构。

certFile

字符串

目标的 Prometheus 容器中客户端证书文件的路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

目标的 Prometheus 容器中客户端密钥文件的路径。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

14.6.1.214. .spec.remoteRead[].tlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.215. .spec.remoteRead[].tlsConfig.ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.216. .spec.remoteRead[].tlsConfig.ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.217. .spec.remoteRead[].tlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.218. .spec.remoteRead[].tlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.219. .spec.remoteRead[].tlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.220. .spec.remoteRead[].tlsConfig.keySecret

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.221. .spec.remoteWrite

描述
如果指定,remote_write spec。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。
类型
array

14.6.1.222. .spec.remoteWrite[]

描述
RemoteWriteSpec 为 prometheus 定义 remote_write 配置。
类型
对象
必填
  • url
Expand
属性类型描述

授权

对象

远程写入的授权部分

basicAuth

对象

URL 的basicAuth。

bearerToken

字符串

用于远程写入的 bearer 令牌。

bearerTokenFile

字符串

用于读取用于远程写入的 bearer 令牌的文件。

标头

对象(字符串)

要与每个远程写入请求一起发送的自定义 HTTP 标头。请注意,由 Prometheus 本身设置的标头无法覆盖。仅在 Prometheus 版本 2.25.0 及更新版本中有效。

metadataConfig

对象

MetadataConfig 配置将一系列元数据发送到远程存储。

name

字符串

如果指定,远程写入队列的名称必须是唯一的。名称用于指标并登录以区分队列。仅在 Prometheus 版本 2.15.0 及更新版本中有效。

oauth2

对象

用于 URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

proxyUrl

字符串

可选 ProxyURL

queueConfig

对象

QueueConfig 允许调整远程写入队列参数。

remoteTimeout

字符串

对远程写入端点的请求超时。

sendExemplars

布尔值

允许通过远程写入发送 exemplars。请注意,必须使用 enableFeature 选项启用 exemplar-storage 本身,以便在第一次位置中提取 exemplars。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

tlsConfig

对象

用于远程写入的 TLS 配置。

url

字符串

要发送示例的端点的 URL。

writeRelabelConfigs

array

远程写入重新标记配置列表。

writeRelabelConfigs[]

对象

RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs&gt; - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

14.6.1.223. .spec.remoteWrite[].authorization

描述
远程写入的授权部分
类型
对象
Expand
属性类型描述

credentials

对象

包含请求凭证的 secret 密钥

credentialsFile

字符串

从中读取 secret 的文件,与凭证相互排斥(来自 SafeAuthorization)

type

字符串

设置身份验证类型。默认为 Bearer,Basic 将导致错误

14.6.1.224. .spec.remoteWrite[].authorization.credentials

描述
包含请求凭证的 secret 密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.225. .spec.remoteWrite[].basicAuth

描述
URL 的basicAuth。
类型
对象
Expand
属性类型描述

password

对象

服务监控命名空间中的 secret,其中包含用于身份验证的密码。

username

对象

服务监控命名空间中的 secret,其中包含用于身份验证的用户名。

14.6.1.226. .spec.remoteWrite[].basicAuth.password

描述
服务监控命名空间中的 secret,其中包含用于身份验证的密码。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.227. .spec.remoteWrite[].basicAuth.username

描述
服务监控命名空间中的 secret,其中包含用于身份验证的用户名。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.228. .spec.remoteWrite[].metadataConfig

描述
MetadataConfig 配置将一系列元数据发送到远程存储。
类型
对象
Expand
属性类型描述

send

布尔值

指标元数据是否发送到远程存储。

sendInterval

字符串

指标元数据的频率发送到远程存储。

14.6.1.229. .spec.remoteWrite[].oauth2

描述
用于 URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。
类型
对象
必填
  • clientId
  • clientSecret
  • tokenUrl
Expand
属性类型描述

clientId

对象

包含 OAuth2 客户端 ID 的 secret 或 configmap

clientSecret

对象

包含 OAuth2 客户端 secret 的 secret

endpointParams

对象(字符串)

附加到令牌 URL 的参数

范围

数组(字符串)

用于令牌请求的 OAuth2 范围

tokenUrl

字符串

从中获取令牌的 URL

14.6.1.230. .spec.remoteWrite[].oauth2.clientId

描述
包含 OAuth2 客户端 ID 的 secret 或 configmap
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.231. .spec.remoteWrite[].oauth2.clientId.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.232. .spec.remoteWrite[].oauth2.clientId.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.233. .spec.remoteWrite[].oauth2.clientSecret

描述
包含 OAuth2 客户端 secret 的 secret
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.234. .spec.remoteWrite[].queueConfig

描述
QueueConfig 允许调整远程写入队列参数。
类型
对象
Expand
属性类型描述

batchSendDeadline

字符串

BatchSendDeadline 是示例在缓冲区中等待的最长时间。

capacity

整数

capacity 是每个分片缓冲的示例数量,然后开始丢弃它们。

maxBackoff

字符串

MaxBackoff 是最大重试延迟。

maxRetries

整数

maxRetries 是在可恢复错误时重试批处理的次数上限。

maxSamplesPerSend

整数

MaxSamplesPerSend 是每个发送的最大样本数。

maxShards

整数

MaxShards 是分片的最大数量,即并发数量。

minBackoff

字符串

MinBackoff 是初始重试延迟。每次重试时会加倍。

minShards

整数

MinShards 是最小分片数量,即并发数量。

14.6.1.235. .spec.remoteWrite[].tlsConfig

描述
用于远程写入的 TLS 配置。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cafile

字符串

用于目标的 Prometheus 容器中 CA 证书的路径。

cert

对象

包含目标客户端证书文件的结构。

certFile

字符串

目标的 Prometheus 容器中客户端证书文件的路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

目标的 Prometheus 容器中客户端密钥文件的路径。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

14.6.1.236. .spec.remoteWrite[].tlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.237. .spec.remoteWrite[].tlsConfig.ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.238. .spec.remoteWrite[].tlsConfig.ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.239. .spec.remoteWrite[].tlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.240. .spec.remoteWrite[].tlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.241. .spec.remoteWrite[].tlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.242. .spec.remoteWrite[].tlsConfig.keySecret

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.243. .spec.remoteWrite[].writeRelabelConfigs

描述
远程写入重新标记配置列表。
类型
array

14.6.1.244. .spec.remoteWrite[].writeRelabelConfigs[]

描述
RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs&gt; - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
类型
对象
Expand
属性类型描述

action

字符串

根据正则表达式匹配执行的操作。默认为 'replace'

modulus

整数

modulus 用来获取源标签值的哈希值。

regex

字符串

匹配提取值的正则表达式。默认为 '(DSL)'

替换

字符串

如果正则表达式匹配,则执行 regex replace 的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置的分隔符。默认为 ';'。

sourceLabels

数组(字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符进行串联,并与替换、保留和丢弃操作配置的正则表达式匹配。

targetLabel

字符串

在 replace 操作中写入结果值的标签。这是替换操作所必需的。正则表达式捕获组可用。

14.6.1.245. .spec.resources

描述
定义单个 Pod 的资源请求和限值。
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

14.6.1.246. .spec.ruleNamespaceSelector

描述
为 PrometheusRules 发现选择的命名空间。如果未指定,则只使用与 Prometheus 对象相同的命名空间。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.247. .spec.ruleNamespaceSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.248. .spec.ruleNamespaceSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.249. .spec.ruleSelector

描述
选择要从中加载警报/记录规则的 PrometheusRules 的选择器。直到(不包括)Prometheus Operator v0.24.0 Prometheus Operator 将任何旧的规则 ConfigMap 迁移到 RuleSelector 选择的 PrometheusRule 自定义资源。确保它与您不想迁移的任何配置映射不匹配。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.250. .spec.ruleSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.251. .spec.ruleSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.252. .spec.rules

描述
/--rules the/ 命令行参数。
类型
对象
Expand
属性类型描述

alert

对象

/--rules.alert.*/ command-line arguments

14.6.1.253. .spec.rules.alert

描述
/--rules.alert.*/ command-line arguments
类型
对象
Expand
属性类型描述

forGracePeriod

字符串

警报和恢复的 'for' 状态之间的最短持续时间。这只适用于配置的"for"时间大于宽限期的警报。

forOutageTolerance

字符串

容许恢复警报状态的 prometheus 中断的最长时间。

resendDelay

字符串

在将警报重新发送到 Alertmanager 前等待的最短时间。

14.6.1.254. .spec.securityContext

描述
securityContext 包含 pod 级别的安全属性和通用容器设置。默认为默认的 PodSecurityContext。
类型
对象
Expand
属性类型描述

fsGroup

整数

适用于 pod 中所有容器的特殊补充组。某些卷类型允许 Kubelet 更改该卷的所有权,使其归 pod 所有:1。拥有的 GID 将是 FSGroup 2。设定 setgid 位(卷中创建的新文件将归 FSGroup 所有)3。权限位是 OR'd with rw-rw----,如果未设置,Kubelet 不会修改任何卷的所有权和权限。

fsGroupChangePolicy

字符串

fsGroupChangePolicy 定义在 Pod 中公开卷前更改卷的所有权和权限的行为。此字段仅适用于支持基于 fsGroup 的所有权(和权限)的卷类型。它对临时卷类型没有影响,如 secret、configmaps 和 emptydir。有效值为 "OnRootMismatch" 和 "Always"。如果没有指定,则默认为 "Always"。

runAsGroup

整数

运行容器进程的入口点的 GID。如果未设置,则使用运行时默认值。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将优先用于该容器。

runAsNonRoot

布尔值

表示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证镜像,以确保它不会以 UID 0 (root)运行,如果容器确实正常运行。如果未设置或为 false,则不会执行这样的验证。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

runAsUser

整数

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

seLinuxOptions

对象

要应用到所有容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将优先用于该容器。

supplementalGroups

数组(整数)

除了容器的主 GID 外,应用到每个容器中运行的第一个进程的组列表。如果未指定,则不会将任何组添加到任何容器中。

sysctl

array

sysctl 包含用于 pod 的命名空间 sysctl 列表。带有不支持的 sysctl (通过容器运行时)的 Pod 可能无法启动。

sysctls[]

对象

sysctl 定义要设置的内核参数

windowsOptions

对象

应用到所有容器的 Windows 具体设置。如果未指定,则使用容器的 SecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。

14.6.1.255. .spec.securityContext.seLinuxOptions

描述
要应用到所有容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将优先用于该容器。
类型
对象
Expand
属性类型描述

level

字符串

level 是应用到容器的 SELinux 级别标签。

role

字符串

Role 是一个适用于容器的 SELinux 角色标签。

type

字符串

type 是应用到容器的 SELinux 类型标签。

user

字符串

用户是应用到容器的 SELinux 用户标签。

14.6.1.256. .spec.securityContext.sysctls

描述
sysctl 包含用于 pod 的命名空间 sysctl 列表。带有不支持的 sysctl (通过容器运行时)的 Pod 可能无法启动。
类型
array

14.6.1.257. .spec.securityContext.sysctls[]

描述
sysctl 定义要设置的内核参数
类型
对象
必填
  • name
  • value
Expand
属性类型描述

name

字符串

要设置的属性的名称

value

字符串

要设置的属性值

14.6.1.258. .spec.securityContext.windowsOptions

描述
应用到所有容器的 Windows 具体设置。如果未指定,则使用容器的 SecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则 SecurityContext 的值将具有优先权。
类型
对象
Expand
属性类型描述

gmsaCredentialSpec

字符串

GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa)内联由 GMSACredentialSpecName 字段命名的 GMSA 凭证规格的内容。

gmsaCredentialSpecName

字符串

GMSACredentialSpecName 是要使用的 GMSA 凭证规格的名称。

runAsUserName

字符串

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

14.6.1.259. .spec.serviceMonitorNamespaceSelector

描述
命名空间的标签,用于 ServiceMonitor 发现。如果为 nil,则只检查自己的命名空间。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.262. .spec.serviceMonitorSelector

描述
为目标发现选择 ServiceMonitor。弃用: 如果没有指定此和 podMonitorSelector,则配置将非受管。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.6.1.263. .spec.serviceMonitorSelector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array

14.6.1.264. .spec.serviceMonitorSelector.matchExpressions[]

描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.265. .spec.storage

描述
存储 spec 以指定如何使用存储。
类型
对象
Expand
属性类型描述

disableMountSubPath

布尔值

已弃用: 默认情况下,子路径使用量将在以后的版本中被禁用,这个选项将变得不必要的。DisableMountSubPath 允许删除卷挂载中的任何 subPath 使用量。

emptyDir

对象

Prometheus StatefulSets 使用的 EmptyDirVolumeSource。如果指定,则使用代替任何 volumeClaimTemplate。更多信息: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

volumeClaimTemplate

对象

Prometheus StatefulSets 使用的 PVC spec。

14.6.1.266. .spec.storage.emptyDir

描述
Prometheus StatefulSets 使用的 EmptyDirVolumeSource。如果指定,则使用代替任何 volumeClaimTemplate。更多信息: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
类型
对象
Expand
属性类型描述

字符串

哪个类型的存储介质应该支持此目录。默认值为 "",这意味着使用节点的默认介质。必须是空字符串(默认)或内存。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit

integer-or-string

此 EmptyDir 卷所需的本地存储总量。大小限制也适用于内存介质。内存介质 EmptyDir 的最大使用量是此处指定的 SizeLimit 和 pod 中所有容器的总和之间的最小值。默认值为 nil,这意味着限制未定义。更多信息: http://kubernetes.io/docs/user-guide/volumes#emptydir

14.6.1.267. .spec.storage.volumeClaimTemplate

描述
Prometheus StatefulSets 使用的 PVC spec。
类型
对象
Expand
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

对象

EmbeddedMetadata 包含与 EmbededResource 相关的元数据。

spec

对象

spec 定义 pod 作者请求的卷所需的特征。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

status

对象

status 代表持久性卷声明的当前信息/状态。只读。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

14.6.1.268. .spec.storage.volumeClaimTemplate.metadata

描述
EmbeddedMetadata 包含与 EmbededResource 相关的元数据。
类型
对象
Expand
属性类型描述

annotations

对象(字符串)

注解是一个无结构的键值映射,与资源存储,可通过外部工具设置来存储和检索任意元数据。它们不可查询,应在修改对象时保留。更多信息: http://kubernetes.io/docs/user-guide/annotations

labels

对象(字符串)

可用于组织和分类(范围和选择)对象的字符串键和值映射。可能与复制控制器和服务选择器匹配。更多信息: http://kubernetes.io/docs/user-guide/labels

name

字符串

名称在命名空间中必须是唯一的。在创建资源时是必需的,但有些资源可能允许客户端自动请求生成适当名称。名称主要用于创建 idempotence 和配置定义。无法更新。更多信息: http://kubernetes.io/docs/user-guide/identifiers#names

14.6.1.269. .spec.storage.volumeClaimTemplate.spec

描述
spec 定义 pod 作者请求的卷所需的特征。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
类型
对象
Expand
属性类型描述

accessModes

数组(字符串)

accessModes 包含卷应具有所需的访问模式。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

对象

此字段可以用来指定现有的 VolumeSnapshot 对象(snapshot.storage.k8s.io/VolumeSnapshot - Beta),如果置备程序或外部控制器支持指定的数据源,则必须启用适当的功能门(VolumeSnapshotDataSource 或任何VolumeDataSource)。 它将基于指定数据源的内容创建一个新卷。如果不支持指定的数据源,则不会创建该卷,且故障将报告为事件。未来,我们计划支持更多数据源类型,并且置备程序的行为可能会改变。

资源

对象

resources 代表卷应具有的最小资源。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

对象

要考虑绑定的卷的标签查询。

storageClassName

字符串

声明所需的 StorageClass 的名称。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

字符串

volumeMode 定义声明需要哪些卷类型。如果没有包含在 claim spec 中,则 Filesystem 的值会被表示。

volumeName

字符串

volumeName 是支持此声明的 PersistentVolume 的绑定引用。

描述
此字段可以用来指定现有的 VolumeSnapshot 对象(snapshot.storage.k8s.io/VolumeSnapshot - Beta),如果置备程序或外部控制器支持指定的数据源,则必须启用适当的功能门(VolumeSnapshotDataSource 或任何VolumeDataSource)。 它将基于指定数据源的内容创建一个新卷。如果不支持指定的数据源,则不会创建该卷,且故障将报告为事件。未来,我们计划支持更多数据源类型,并且置备程序的行为可能会改变。
类型
对象
必填
  • kind
  • name
Expand
属性类型描述

apiGroup

字符串

apigroup 是被引用资源的组。如果没有指定 APIGroup,则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型,需要 APIGroup。

kind

字符串

kind 是被引用的资源类型

name

字符串

name 是被引用的资源的名称

描述
resources 代表卷应具有的最小资源。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

14.6.1.272. .spec.storage.volumeClaimTemplate.spec.selector

描述
要考虑绑定的卷的标签查询。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.275. .spec.storage.volumeClaimTemplate.status

描述
status 代表持久性卷声明的当前信息/状态。只读。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
类型
对象
Expand
属性类型描述

accessModes

数组(字符串)

accessModes 包含支持 PVC 的卷的实际访问模式。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

capacity

integer-or-string

代表基础卷的实际资源。

conditions

array

持久性卷声明的当前条件。如果底层持久性卷正在调整大小,则条件将被设置为 'ResizeStarted'。

conditions[]

对象

PersistentVolumeClaimCondition 提供有关 pvc 状态的详细信息

phase

字符串

phase 代表 PersistentVolumeClaim 的当前阶段。

描述
持久性卷声明的当前条件。如果底层持久性卷正在调整大小,则条件将被设置为 'ResizeStarted'。
类型
array
描述
PersistentVolumeClaimCondition 提供有关 pvc 状态的详细信息
类型
对象
必填
  • status
  • type
Expand
属性类型描述

lastProbeTime

字符串

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

lastTransitionTime

字符串

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

message

字符串

人类可读的消息,指示最后一次转换的详细信息。

reason

字符串

唯一,这应该是简短的、可理解的机器字符串,为条件最后一次转换提供原因。如果报告"ResizeStarted"表示底层持久性卷正在调整大小。

status

字符串

 

type

字符串

PersistentVolumeClaimConditionType 是 PersistentVolumeClaimCondition.Type 的有效值

14.6.1.278. .spec.thanos

描述
Thanos 配置允许在 Thanos 环境中配置 Prometheus 服务器的各个方面。本节是实验性的,可能会在任何发行版本中没有弃用通知。这是实验性的,可能随时更改而不向后兼容。
类型
对象
Expand
属性类型描述

baseImage

字符串

如果默认镜像以外的其他镜像,Thanos 基础镜像。弃用:使用 'image' 替代

grpcServerTlsConfig

对象

grpcServerTlsConfig 配置 gRPC 服务器,Thanos Querier 从中读取记录的规则数据。注:当前只支持 CAFile、CertFile 和 KeyFile 字段。映射到 '--grpc-server-tls the CLI args。

image

字符串

如果指定的优先级高于 baseImage、tag 和 sha 组合,则镜像。仍然需要指定版本,以确保 Prometheus Operator 知道要配置的 Thanos 版本。

listenLocal

布尔值

ListenLocal 使 Thanos sidecar 侦听回送,因此它不会与 Pod IP 绑定。

logFormat

字符串

要配置的 Thanos sidecar 的 logFormat。

logLevel

字符串

用于配置 Thanos sidecar 的 logLevel。

minTime

字符串

用于配置 Thanos sidecar 的 MinTime。选项可以是 RFC3339 格式的恒定时间,也可以是相对于当前时间的持续时间,如 -1d 或 2h45m。有效持续时间单位为 ms、s、m、h、d、w、y。

objectStorageConfig

对象

ObjectStorageConfig 在 Thanos 中配置对象存储。ObjectStorageConfigFile 和较低顺序优先级的替代选择。

objectStorageConfigFile

字符串

ObjectStorageConfigFile 指定对象存储配置文件的路径。与 ObjectStorageConfig 一起使用时,ObjectStorageConfigFile 具有优先权。

readyTimeout

字符串

ReadyTimeout 是 Thanos sidecar 等待 Prometheus 启动的最长时间。eg 10m

资源

对象

资源定义 Thanos sidecar 的资源要求。如果没有提供,则不会设置请求/限制

sha

字符串

要部署的 Thanos 容器镜像的 SHA。默认为 version 的值。与标签类似,但 SHA 明确部署不可变的容器镜像。如果设置了 SHA,则忽略 version 和 Tag。弃用:改为使用 'image'。镜像摘要可以作为镜像 URL 的一部分指定。

tag

字符串

要部署的 Thanos sidecar 容器镜像的标签。默认为 version 的值。如果设置了 Tag,则忽略 version。弃用:改为使用 'image'。镜像标签可以作为镜像 URL 的一部分指定。

tracingConfig

对象

tracingConfig 在 Thanos 中配置追踪。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。

tracingConfigFile

字符串

tracingConfig 指定追踪配置文件的路径。与 TracingConfig 一同使用时,TracingConfigFile 具有优先权。

version

字符串

版本描述了要使用的 Thanos 版本。

volumeMounts

array

volumeMounts 允许在输出 StatefulSet 定义上配置额外的 VolumeMounts。指定 volumeMounts 将附加到 thanos-sidecar 容器中的其他 VolumeMounts 中。

volumeMounts[]

对象

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

14.6.1.279. .spec.thanos.grpcServerTlsConfig

描述
grpcServerTlsConfig 配置 gRPC 服务器,Thanos Querier 从中读取记录的规则数据。注:当前只支持 CAFile、CertFile 和 KeyFile 字段。映射到 '--grpc-server-tls the CLI args。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cafile

字符串

用于目标的 Prometheus 容器中 CA 证书的路径。

cert

对象

包含目标客户端证书文件的结构。

certFile

字符串

目标的 Prometheus 容器中客户端证书文件的路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

目标的 Prometheus 容器中客户端密钥文件的路径。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

14.6.1.280. .spec.thanos.grpcServerTlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.281. .spec.thanos.grpcServerTlsConfig.ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.282. .spec.thanos.grpcServerTlsConfig.ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.283. .spec.thanos.grpcServerTlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.284. .spec.thanos.grpcServerTlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.285. .spec.thanos.grpcServerTlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.286. .spec.thanos.grpcServerTlsConfig.keySecret

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.287. .spec.thanos.objectStorageConfig

描述
ObjectStorageConfig 在 Thanos 中配置对象存储。ObjectStorageConfigFile 和较低顺序优先级的替代选择。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.288. .spec.thanos.resources

描述
资源定义 Thanos sidecar 的资源要求。如果没有提供,则不会设置请求/限制
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

14.6.1.289. .spec.thanos.tracingConfig

描述
tracingConfig 在 Thanos 中配置追踪。这是一个实验性功能,它可能会以中断的方式更改任何即将发布的版本。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.290. .spec.thanos.volumeMounts

描述
volumeMounts 允许在输出 StatefulSet 定义上配置额外的 VolumeMounts。指定 volumeMounts 将附加到 thanos-sidecar 容器中的其他 VolumeMounts 中。
类型
array

14.6.1.291. .spec.thanos.volumeMounts[]

描述
VolumeMount 描述了容器内卷的挂载。
类型
对象
必填
  • mountPath
  • name
Expand
属性类型描述

mountPath

字符串

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

mountPropagation

字符串

mountPropagation 决定如何将挂载从主机传播到容器,以及传输的其他方式。如果没有设置,则使用 MountPropagationNone。此字段在 1.10 中是 beta。

name

字符串

这必须与卷的名称匹配。

readOnly

布尔值

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

subPath

字符串

应该从中挂载容器卷的卷内的路径。默认为 "" (卷的 root)。

subPathExpr

字符串

在卷中应该挂载容器的卷的扩展路径。的行为与 SubPath 类似,但环境变量引用 $(VAR_NAME)使用容器的环境扩展。默认为 "" (卷的 root)。SubPathExpr 和 SubPath 是互斥的。

14.6.1.292. .spec.tolerations

描述
如果指定,pod 的容限。
类型
array

14.6.1.293. .spec.tolerations[]

描述
附加此 Toleration 的 pod,以使用匹配的 operator <operator> 来容许与 triple <key,value,effect> 匹配的任何污点。
类型
对象
Expand
属性类型描述

effect

字符串

effect 表示污点效果要匹配的污点。空意味着匹配所有污点效果。指定后,允许的值为 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空,运算符必须是 Exists;此组合意味着匹配所有值和所有键。

operator

字符串

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

tolerationSeconds

整数

tolerationSeconds 代表容限(必须具有 NoExecute effect,否则此字段将被忽略)容许污点的时间周期。默认情况下,它没有被设置,这意味着容许污点(不要驱除)。零值和负值将被视为系统 0 (立即撤离)。

value

字符串

value 是容限匹配的污点值。如果运算符是 Exists,则该值应该为空,否则仅是一个常规字符串。

14.6.1.294. .spec.topologySpreadConstraints

描述
如果指定,pod 的拓扑分布约束。
类型
array

14.6.1.295. .spec.topologySpreadConstraints[]

描述
TopologySpreadConstraint 指定如何将匹配的 pod 分散到给定拓扑中。
类型
对象
必填
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
属性类型描述

labelSelector

对象

labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算来确定其对应拓扑域中的 pod 数量。

maxSkew

整数

maxSkew 描述了 pod 可能不均匀分布的程度。它是给定拓扑类型的任意拓扑域中的匹配 pod 数量之间允许的最大差别。例如,在 3 区集群中,MaxSkew 设置为 1,且具有与 1/1/0: | zone1 | zone2 | zone2 | zone2 | zone2 | zone3 的相同 labelSelector 分布的 pod;如果 MaxSkew 为 1,则传入的 pod 只能调度到 zone3,使其调度到 zone1 (zone2) 将在 zone1 (zone2)上使 ActualSkew (2-0)违反 MaxSkew (1). - 如果 MaxSkew 为 2, 传入的 pod 可以调度到任何区域。这是必填字段。默认值为 1,不允许使用 0。

topologyKey

字符串

topologyKey 是节点标签的密钥。带有具有此键和相同值标签的节点被视为在同一拓扑中。我们考虑每个 <key, value> 作为 "bucket",并尝试将 pod 数量放置到每个存储桶中。这是必填字段。

whenUnsatisfiable

字符串

whenUnsatisfiable 指示在没有满足分布约束时如何处理 pod。- DoNotSchedule (默认)告知调度程序不调度它 - ScheduleAnyway 会告知调度程序仍然在调度它时被视为 "Unsatisfiable",只有将传入的 pod 放置到任何拓扑上违反了 "MaxSkew"。例如,在 3 区集群中,MaxSkew 设置为 1,并且具有与 3/1/1: | zone1 | zone2 | zone3 | zone3 | zone2 | zone3 | zone3 的相同 labelSelector 分布的 pod,则传入的 pod 只能调度到 zone2 (zone3) 在 zone2 (zone3)满足 MaxSkew (1)上成为 3/2/1 (3/1/2)作为 ActualSkew (2-1)。换句话说,集群仍然可以进行平衡,但调度程序不会使其更不平衡。这是必填字段。

14.6.1.296. .spec.topologySpreadConstraints[].labelSelector

描述
labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算来确定其对应拓扑域中的 pod 数量。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.6.1.299. .spec.volumeMounts

描述
volumeMounts 允许在输出 StatefulSet 定义上配置额外的 VolumeMounts。指定 volumeMounts 将附加到 prometheus 容器中的其他 VolumeMounts 中,后者由 StorageSpec 对象而生成。
类型
array

14.6.1.300. .spec.volumeMounts[]

描述
VolumeMount 描述了容器内卷的挂载。
类型
对象
必填
  • mountPath
  • name
Expand
属性类型描述

mountPath

字符串

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

mountPropagation

字符串

mountPropagation 决定如何将挂载从主机传播到容器,以及传输的其他方式。如果没有设置,则使用 MountPropagationNone。此字段在 1.10 中是 beta。

name

字符串

这必须与卷的名称匹配。

readOnly

布尔值

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

subPath

字符串

应该从中挂载容器卷的卷内的路径。默认为 "" (卷的 root)。

subPathExpr

字符串

在卷中应该挂载容器的卷的扩展路径。的行为与 SubPath 类似,但环境变量引用 $(VAR_NAME)使用容器的环境扩展。默认为 "" (卷的 root)。SubPathExpr 和 SubPath 是互斥的。

14.6.1.301. .spec.volumes

描述
卷允许在输出 StatefulSet 定义中配置额外的卷。指定的卷将附加到因为 StorageSpec 对象生成的其他卷中。
类型
array

14.6.1.302. .spec.volumes[]

描述
卷代表 pod 中可以被 pod 中任何容器访问的命名卷。
类型
对象
必填
  • name
Expand
属性类型描述

awsElasticBlockStore

对象

awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

对象

azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。

azureFile

对象

azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。

cephfs

对象

CephFS 代表共享 pod 生命周期的主机上 Ceph FS 挂载

cinder

对象

Cinder 代表在 kubelet 主机上附加并挂载的 cinder 卷。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

configMap

对象

ConfigMap 代表应该填充这个卷的 configMap

csi

对象

CSI (容器存储接口)代表由外部 CSI 驱动程序(Alpha 功能)处理的存储。

downwardAPI

对象

downwardAPI 代表有关应该填充此卷的 pod 的 Downward API

emptyDir

对象

emptyDir 代表共享 pod 生命周期的临时目录。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

fc

对象

FC 代表附加到 kubelet 主机机器的光纤通道资源,然后公开给 pod。

flexVolume

对象

FlexVolume 代表一个通用卷资源,它使用基于 exec 的插件置备/附加。

flocker

对象

flocker 代表附加到 kubelet 主机的 Flocker 卷。这取决于 Flocker 控制服务正在运行

gcePersistentDisk

对象

gcePersistentDisk 代表一个 GCE Disk 资源,附加到 kubelet 的主机机器,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

对象

gitRepo 代表特定修订版本上的 git 存储库。DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器,请将 EmptyDir 挂载到 InitContainer 中,以使用 git 克隆存储库,然后将 EmptyDir 挂载到 Pod 的容器中。

glusterfs

对象

GlusterFS 代表共享 pod 生命周期的主机上的 Glusterfs 挂载。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

对象

hostpath 代表主机上直接公开给容器的机器上已存在的文件或目录。这通常用于系统代理或允许查看主机的其他特权操作。大多数容器都不需要此操作。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath ---ö(jonesdl)需要限制谁可以使用主机目录挂载,以及谁可以以读/写形式挂载主机目录。

iscsi

对象

ISCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源,然后公开给 pod。更多信息: https://examples.k8s.io/volumes/iscsi/README.md

name

字符串

卷的名称。必须是 pod 中的 DNS_LABEL 和 unique。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

nfs

对象

NFS 代表共享 pod 生命周期的主机上的 NFS 挂载: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

对象

PersistentVolumeClaimVolumeSource 代表对同一命名空间中的 PersistentVolumeClaim 的引用。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

对象

PhotnPersistentDisk 代表附加并挂载到 kubelet 主机上的 PhotonController 持久磁盘

portworxVolume

对象

portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷

projected

对象

在一个资源 secret、configmaps 和 Downward API 中所有的项目

quobyte

对象

quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载

rbd

对象

rbd 代表共享 pod 生命周期的主机上 Rados 块设备挂载。更多信息: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

对象

scaleIO 代表附加并挂载到 Kubernetes 节点上的 ScaleIO 持久性卷。

secret

对象

Secret 代表应填充此卷的 secret。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

对象

Storageos 代表在 Kubernetes 节点上附加并挂载的 StorageOS 卷。

vsphereVolume

对象

vsphereVolume 代表附加并挂载到 kubelet 主机上的 vSphere 卷

14.6.1.303. .spec.volumes[].awsElasticBlockStore

描述
awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
类型
对象
必填
  • volumeID
Expand
属性类型描述

fsType

字符串

要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore 114: 如何阻止文件系统中的错误破坏机器

分区

整数

要挂载的卷中的分区。如果省略,则默认由卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷快照是"0" (或者您可以将属性留空)。

readOnly

布尔值

指定 "true" 来强制并将 VolumeMounts 中的 ReadOnly 属性设置为 "true"。如果省略,则默认为 "false"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

字符串

AWS (Amazon EBS 卷)中持久磁盘资源的唯一 ID。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

14.6.1.304. .spec.volumes[].azureDisk

描述
azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。
类型
对象
必填
  • diskName
  • diskURI
Expand
属性类型描述

cachingMode

字符串

主机缓存模式:无、只读、读写。

diskName

字符串

blob 存储中的数据磁盘的名称

diskURI

字符串

blob 存储中的数据磁盘的 URI

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

kind

字符串

预期值 Shared: 每个存储帐户 Dedicated 多个 blob 磁盘:每个存储帐户 Managed: azure managed data disk (仅限受管可用性集中)。默认为 shared

readOnly

布尔值

默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

14.6.1.305. .spec.volumes[].azureFile

描述
azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。
类型
对象
必填
  • secretName
  • shareName
Expand
属性类型描述

readOnly

布尔值

默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

secretName

字符串

包含 Azure 存储帐户名称和密钥的 secret 名称

shareName

字符串

共享名称

14.6.1.306. .spec.volumes[].cephfs

描述
CephFS 代表共享 pod 生命周期的主机上 Ceph FS 挂载
类型
对象
必填
  • monitor
Expand
属性类型描述

monitor

数组(字符串)

必需: monitor 是 Ceph 监视器更多信息的集合: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

字符串

可选:用作挂载的 root,而不是完整的 Ceph 树,默认为 /

readOnly

布尔值

可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

字符串

可选: SecretFile 是用户密钥环的路径,默认为 /etc/ceph/user.secret more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

对象

可选: SecretRef 对 User 的身份验证 secret 的引用,默认为空。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

user

字符串

可选: User 是 rados 用户名,默认为 admin more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

14.6.1.307. .spec.volumes[].cephfs.secretRef

描述
可选: SecretRef 对 User 的身份验证 secret 的引用,默认为空。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.308. .spec.volumes[].cinder

描述
Cinder 代表在 kubelet 主机上附加并挂载的 cinder 卷。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md
类型
对象
必填
  • volumeID
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

布尔值

可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

对象

可选:指向包含用于连接 OpenStack 的参数的 secret 对象。

volumeID

字符串

用于识别 cinder 中卷的卷 ID。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

14.6.1.309. .spec.volumes[].cinder.secretRef

描述
可选:指向包含用于连接 OpenStack 的参数的 secret 对象。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.310. .spec.volumes[].configMap

描述
ConfigMap 代表应该填充这个卷的 configMap
类型
对象
Expand
属性类型描述

defaultMode

整数

可选:默认在创建的文件中使用模式位。必须是 0 到 0777 之间的值。默认值为 0644。路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

items

array

如果未指定,引用的 ConfigMap 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了 ConfigMap 中不存在的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。

items[]

对象

将字符串键映射到卷内的路径。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.311. .spec.volumes[].configMap.items

描述
如果未指定,引用的 ConfigMap 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了 ConfigMap 中不存在的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。
类型
array

14.6.1.312. .spec.volumes[].configMap.items[]

描述
将字符串键映射到卷内的路径。
类型
对象
必填
  • key
  • path
Expand
属性类型描述

key

字符串

项目的密钥。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

要将密钥映射到的文件的相对路径。可能不是绝对路径。可能不包含 path 元素 '..'。可能无法以字符串 '..' 开头。

14.6.1.313. .spec.volumes[].csi

描述
CSI (容器存储接口)代表由外部 CSI 驱动程序(Alpha 功能)处理的存储。
类型
对象
必填
  • driver
Expand
属性类型描述

driver

字符串

driver 是处理这个卷的 CSI 驱动程序的名称。请咨询您的管理员以获取在集群中注册的正确名称。

fsType

字符串

要挂载的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果没有提供,空值会被传递给相关的 CSI 驱动程序,该驱动程序将决定要应用的默认文件系统。

nodePublishSecretRef

对象

NodePublishSecretRef 是对包含敏感信息的 secret 对象的引用,用于传递给 CSI 驱动程序来完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的,如果没有 secret,则可能为空。如果 secret 对象包含多个 secret,则会传递所有 secret 引用。

readOnly

布尔值

为卷指定只读配置。默认为 false (读/写)。

volumeAttributes

对象(字符串)

volumeAttributes 存储传递给 CSI 驱动程序的特定于驱动程序的属性。如需支持的值,请参考您的驱动程序文档。

14.6.1.314. .spec.volumes[].csi.nodePublishSecretRef

描述
NodePublishSecretRef 是对包含敏感信息的 secret 对象的引用,用于传递给 CSI 驱动程序来完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的,如果没有 secret,则可能为空。如果 secret 对象包含多个 secret,则会传递所有 secret 引用。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.315. .spec.volumes[].downwardAPI

描述
downwardAPI 代表有关应该填充此卷的 pod 的 Downward API
类型
对象
Expand
属性类型描述

defaultMode

整数

可选:默认在创建的文件中使用模式位。必须是 0 到 0777 之间的值。默认值为 0644。路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

items

array

items 是 Downward API 卷文件列表

items[]

对象

DownwardAPIVolumeFile 代表创建包含 pod 字段的文件的信息

14.6.1.316. .spec.volumes[].downwardAPI.items

描述
items 是 Downward API 卷文件列表
类型
array

14.6.1.317. .spec.volumes[].downwardAPI.items[]

描述
DownwardAPIVolumeFile 代表创建包含 pod 字段的文件的信息
类型
对象
必填
  • path
Expand
属性类型描述

fieldRef

对象

必需: 选择 pod 的字段:只支持注解、标签、名称和命名空间。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

必需:path 是要创建的文件的相对路径名称。不得是绝对的,或包含 '..' 路径。必须经过 utf-8 编码。相对路径的第一个项不得以 '.' 开头

resourceFieldRef

对象

选择容器的资源:当前仅支持资源限制和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。

14.6.1.318. .spec.volumes[].downwardAPI.items[].fieldRef

描述
必需: 选择 pod 的字段:只支持注解、标签、名称和命名空间。
类型
对象
必填
  • fieldPath
Expand
属性类型描述

apiVersion

字符串

FieldPath 编写的模式版本,默认为 "v1"。

fieldPath

字符串

要在指定 API 版本中选择的字段路径。

描述
选择容器的资源:当前仅支持资源限制和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。
类型
对象
必填
  • resource
Expand
属性类型描述

containerName

字符串

容器名称:卷需要,对于 env vars 是可选的

divisor

integer-or-string

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

14.6.1.320. .spec.volumes[].emptyDir

描述
emptyDir 代表共享 pod 生命周期的临时目录。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
类型
对象
Expand
属性类型描述

字符串

哪个类型的存储介质应该支持此目录。默认值为 "",这意味着使用节点的默认介质。必须是空字符串(默认)或内存。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit

integer-or-string

此 EmptyDir 卷所需的本地存储总量。大小限制也适用于内存介质。内存介质 EmptyDir 的最大使用量是此处指定的 SizeLimit 和 pod 中所有容器的总和之间的最小值。默认值为 nil,这意味着限制未定义。更多信息: http://kubernetes.io/docs/user-guide/volumes#emptydir

14.6.1.321. .spec.volumes[].fc

描述
FC 代表附加到 kubelet 主机机器的光纤通道资源,然后公开给 pod。
类型
对象
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。ado: 如何防止文件系统中的错误破坏机器

lun

整数

可选: FC 目标 lun 号

readOnly

布尔值

可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

targetWWNs

数组(字符串)

可选: FC 目标全球名称(WWN)

wwids

数组(字符串)

可选: FC 卷全局识别符(wwids) Either wwids 或 targetWWN 和 lun 的组合都必须被设置,但不能同时设置。

14.6.1.322. .spec.volumes[].flexVolume

描述
FlexVolume 代表一个通用卷资源,它使用基于 exec 的插件置备/附加。
类型
对象
必填
  • driver
Expand
属性类型描述

driver

字符串

driver 是此卷要使用的驱动程序名称。

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统依赖于 FlexVolume 脚本。

options

对象(字符串)

可选:额外的命令选项(若有)。

readOnly

布尔值

可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

secretRef

对象

可选: SecretRef 引用包含要传递给插件脚本的敏感信息的 secret 对象。如果没有指定 secret 对象,这可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会传递给插件脚本。

14.6.1.323. .spec.volumes[].flexVolume.secretRef

描述
可选: SecretRef 引用包含要传递给插件脚本的敏感信息的 secret 对象。如果没有指定 secret 对象,这可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会传递给插件脚本。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.324. .spec.volumes[].flocker

描述
flocker 代表附加到 kubelet 主机的 Flocker 卷。这取决于 Flocker 控制服务正在运行
类型
对象
Expand
属性类型描述

datasetName

字符串

在 Flocker 的 dataset 上作为 metadata name 存储的数据的名称应被视为已弃用

datasetUUID

字符串

dataset 的 UUID。这是 Flocker 数据集的唯一标识符

14.6.1.325. .spec.volumes[].gcePersistentDisk

描述
gcePersistentDisk 代表一个 GCE Disk 资源,附加到 kubelet 的主机机器,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
类型
对象
必填
  • pdName
Expand
属性类型描述

fsType

字符串

要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk 114: 如何阻止文件系统中的错误破坏机器

分区

整数

要挂载的卷中的分区。如果省略,则默认由卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷快照是"0" (或者您可以将属性留空)。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

字符串

GCE 中 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

布尔值

此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

14.6.1.326. .spec.volumes[].gitRepo

描述
gitRepo 代表特定修订版本上的 git 存储库。DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器,请将 EmptyDir 挂载到 InitContainer 中,以使用 git 克隆存储库,然后将 EmptyDir 挂载到 Pod 的容器中。
类型
对象
必填
  • 软件仓库
Expand
属性类型描述

目录

字符串

目标目录名称。不得包含或以 '.' 开头。如果提供了 '.',则卷目录将是 git 存储库。否则,卷将在具有指定名称的子目录中包含 git 存储库。

软件仓库

字符串

仓库 URL

revision

字符串

指定修订版本的提交哈希。

14.6.1.327. .spec.volumes[].glusterfs

描述
GlusterFS 代表共享 pod 生命周期的主机上的 Glusterfs 挂载。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md
类型
对象
必填
  • 端点
  • path
Expand
属性类型描述

端点

字符串

endpointName 是详细说明 Glusterfs 拓扑的端点名称。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

字符串

path 是 Glusterfs 卷路径。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

14.6.1.328. .spec.volumes[].hostPath

描述
hostpath 代表主机上直接公开给容器的机器上已存在的文件或目录。这通常用于系统代理或允许查看主机的其他特权操作。大多数容器都不需要此操作。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath ---ö(jonesdl)需要限制谁可以使用主机目录挂载,以及谁可以以读/写形式挂载主机目录。
类型
对象
必填
  • path
Expand
属性类型描述

path

字符串

主机上目录的路径。如果路径是符号链接,它将遵循到实际路径的链接。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

字符串

HostPath Volume Defaults 为 "" more information: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

14.6.1.329. .spec.volumes[].iscsi

描述
ISCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源,然后公开给 pod。更多信息: https://examples.k8s.io/volumes/iscsi/README.md
类型
对象
必填
  • iqn
  • lun
  • targetPortal
Expand
属性类型描述

chapAuthDiscovery

布尔值

是否支持 iSCSI 发现 CHAP 身份验证

chapAuthSession

布尔值

是否支持 iSCSI 会话 CHAP 身份验证

fsType

字符串

要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#iscsi 114: 如何阻止文件系统中的错误破坏机器

initiatorName

字符串

自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName,则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。

iqn

字符串

目标 iSCSI 限定名称。

iscsiInterface

字符串

使用 iSCSI 传输的 iSCSI 接口名称。默认为 'default'(tcp)。

lun

整数

iSCSI 目标 Lun 号。

门户

数组(字符串)

iSCSI 目标门户列表.如果端口不是默认端口(通常为 TCP 端口 860 和 3260),则门户是 IP 或 ip_addr:port。

readOnly

布尔值

此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。默认为false。

secretRef

对象

用于 iSCSI 目标和发起方身份验证的 CHAP Secret

targetPortal

字符串

iSCSI 目标门户.如果端口不是默认端口(通常为 TCP 端口 860 和 3260),则门户是 IP 或 ip_addr:port。

14.6.1.330. .spec.volumes[].iscsi.secretRef

描述
用于 iSCSI 目标和发起方身份验证的 CHAP Secret
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.331. .spec.volumes[].nfs

描述
NFS 代表共享 pod 生命周期的主机上的 NFS 挂载: https://kubernetes.io/docs/concepts/storage/volumes#nfs
类型
对象
必填
  • path
  • server
Expand
属性类型描述

path

字符串

NFS 服务器导出的路径。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

布尔值

此处的只读将强制使用只读权限挂载 NFS 导出。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

字符串

server 是 NFS 服务器的主机名或 IP 地址。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

14.6.1.332. .spec.volumes[].persistentVolumeClaim

描述
PersistentVolumeClaimVolumeSource 代表对同一命名空间中的 PersistentVolumeClaim 的引用。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
类型
对象
必填
  • claimName
Expand
属性类型描述

claimName

字符串

claimName 是与使用此卷的 pod 相同的命名空间中的 PersistentVolumeClaim 的名称。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

readOnly

布尔值

将强制 VolumeMount 中的 ReadOnly 设置。默认 false。

14.6.1.333. .spec.volumes[].photonPersistentDisk

描述
PhotnPersistentDisk 代表附加并挂载到 kubelet 主机上的 PhotonController 持久磁盘
类型
对象
必填
  • pdID
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

pdID

字符串

标识 Photon Controller 持久磁盘的 ID

14.6.1.334. .spec.volumes[].portworxVolume

描述
portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷
类型
对象
必填
  • volumeID
Expand
属性类型描述

fsType

字符串

fstype 代表要挂载 Must 的文件系统类型,是主机操作系统支持的文件系统类型。EX. "ext4", "xfs"。如果未指定,则隐式推断为"ext4"。

readOnly

布尔值

默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

volumeID

字符串

VolumeId 唯一标识 Portworx 卷

14.6.1.335. .spec.volumes[].projected

描述
在一个资源 secret、configmaps 和 Downward API 中所有的项目
类型
对象
必填
  • sources
Expand
属性类型描述

defaultMode

整数

默认用于创建文件的模式位。必须是 0 到 0777 之间的值。路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

sources

array

卷投射列表

sources[]

对象

可以投射与其他支持的卷类型进行投射

14.6.1.336. .spec.volumes[].projected.sources

描述
卷投射列表
类型
array

14.6.1.337. .spec.volumes[].projected.sources[]

描述
可以投射与其他支持的卷类型进行投射
类型
对象
Expand
属性类型描述

configMap

对象

有关项目的 configMap 数据的信息

downwardAPI

对象

有关项目 downwardAPI 数据的信息

secret

对象

有关项目 secret 数据的信息

serviceAccountToken

对象

有关项目的 serviceAccountToken 数据的信息

14.6.1.338. .spec.volumes[].projected.sources[].configMap

描述
有关项目的 configMap 数据的信息
类型
对象
Expand
属性类型描述

items

array

如果未指定,引用的 ConfigMap 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了 ConfigMap 中不存在的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。

items[]

对象

将字符串键映射到卷内的路径。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

描述
如果未指定,引用的 ConfigMap 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了 ConfigMap 中不存在的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。
类型
array
描述
将字符串键映射到卷内的路径。
类型
对象
必填
  • key
  • path
Expand
属性类型描述

key

字符串

项目的密钥。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

要将密钥映射到的文件的相对路径。可能不是绝对路径。可能不包含 path 元素 '..'。可能无法以字符串 '..' 开头。

14.6.1.341. .spec.volumes[].projected.sources[].downwardAPI

描述
有关项目 downwardAPI 数据的信息
类型
对象
Expand
属性类型描述

items

array

items 是 DownwardAPIVolume 文件的列表

items[]

对象

DownwardAPIVolumeFile 代表创建包含 pod 字段的文件的信息

描述
items 是 DownwardAPIVolume 文件的列表
类型
array
描述
DownwardAPIVolumeFile 代表创建包含 pod 字段的文件的信息
类型
对象
必填
  • path
Expand
属性类型描述

fieldRef

对象

必需: 选择 pod 的字段:只支持注解、标签、名称和命名空间。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

必需:path 是要创建的文件的相对路径名称。不得是绝对的,或包含 '..' 路径。必须经过 utf-8 编码。相对路径的第一个项不得以 '.' 开头

resourceFieldRef

对象

选择容器的资源:当前仅支持资源限制和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。

描述
必需: 选择 pod 的字段:只支持注解、标签、名称和命名空间。
类型
对象
必填
  • fieldPath
Expand
属性类型描述

apiVersion

字符串

FieldPath 编写的模式版本,默认为 "v1"。

fieldPath

字符串

要在指定 API 版本中选择的字段路径。

描述
选择容器的资源:当前仅支持资源限制和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。
类型
对象
必填
  • resource
Expand
属性类型描述

containerName

字符串

容器名称:卷需要,对于 env vars 是可选的

divisor

integer-or-string

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

14.6.1.346. .spec.volumes[].projected.sources[].secret

描述
有关项目 secret 数据的信息
类型
对象
Expand
属性类型描述

items

array

如果未指定,引用的 Secret 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了没有存在于 Secret 中的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。

items[]

对象

将字符串键映射到卷内的路径。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

描述
如果未指定,引用的 Secret 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了没有存在于 Secret 中的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。
类型
array
描述
将字符串键映射到卷内的路径。
类型
对象
必填
  • key
  • path
Expand
属性类型描述

key

字符串

项目的密钥。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

要将密钥映射到的文件的相对路径。可能不是绝对路径。可能不包含 path 元素 '..'。可能无法以字符串 '..' 开头。

描述
有关项目的 serviceAccountToken 数据的信息
类型
对象
必填
  • path
Expand
属性类型描述

Audience

字符串

Audience 是令牌的预期使用者。令牌的接收者必须使用令牌使用者中指定的标识符来识别自己,否则应拒绝令牌。使用者默认为 apiserver 的标识符。

expirationSeconds

整数

ExpirationSeconds 是服务帐户令牌的有效持续时间。当令牌方法过期时,kubelet 卷插件会主动轮转服务帐户令牌。如果令牌存在的时间超过这个值的 80%,或者超过 24 小时,则 kubelet 将开始尝试轮转令牌,且必须至少 10 分钟。

path

字符串

path 是相对于文件挂载点的路径,用于将令牌项目到其中。

14.6.1.350. .spec.volumes[].quobyte

描述
quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载
类型
对象
必填
  • registry
Expand
属性类型描述

group

字符串

将卷访问映射到 Default 的组

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。

registry

字符串

registry 代表单个或多个 Quobyte Registry 服务,指定为 host:port 对(多个条目用逗号分开),它充当卷的中央 registry

tenant

字符串

在带有动态置备的 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户,值由插件设置

user

字符串

将卷访问权限映射到 Defaults 到 serivceaccount 用户

字符串

卷是一个字符串,它按名称引用已创建 Quobyte 卷。

14.6.1.351. .spec.volumes[].rbd

描述
rbd 代表共享 pod 生命周期的主机上 Rados 块设备挂载。更多信息: https://examples.k8s.io/volumes/rbd/README.md
类型
对象
必填
  • image
  • monitor
Expand
属性类型描述

fsType

字符串

要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#rbd 114: 如何阻止文件系统中的错误破坏机器

image

字符串

rados 镜像名称。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

字符串

keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitor

数组(字符串)

Ceph 监视器的集合。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

字符串

rados 池名称。默认为 rbd。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

布尔值

此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

对象

secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供覆盖密钥环,则提供。默认为 nil。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

user

字符串

rados 用户名。默认为 admin。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

14.6.1.352. .spec.volumes[].rbd.secretRef

描述
secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供覆盖密钥环,则提供。默认为 nil。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.353. .spec.volumes[].scaleIO

描述
scaleIO 代表附加并挂载到 Kubernetes 节点上的 ScaleIO 持久性卷。
类型
对象
必填
  • gateway
  • secretRef
  • system
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs"。

gateway

字符串

ScaleIO API 网关的主机地址。

protectionDomain

字符串

配置存储的 ScaleIO 保护域的名称。

readOnly

布尔值

默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

secretRef

对象

secretRef 引用 ScaleIO 用户和其他敏感信息的机密。如果没有提供此功能,则登录操作将失败。

sslEnabled

布尔值

启用/禁用与网关的 SSL 通信的标志,默认为 false

storageMode

字符串

指明卷的存储是否应是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。

storagePool

字符串

与保护域关联的 ScaleIO 存储池。

system

字符串

存储系统的名称,如 ScaleIO 中配置的。

volumeName

字符串

已在与这个卷源关联的 ScaleIO 系统中创建的卷名称。

14.6.1.354. .spec.volumes[].scaleIO.secretRef

描述
secretRef 引用 ScaleIO 用户和其他敏感信息的机密。如果没有提供此功能,则登录操作将失败。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.355. .spec.volumes[].secret

描述
Secret 代表应填充此卷的 secret。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret
类型
对象
Expand
属性类型描述

defaultMode

整数

可选:默认在创建的文件中使用模式位。必须是 0 到 0777 之间的值。默认值为 0644。路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

items

array

如果未指定,引用的 Secret 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了没有存在于 Secret 中的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。

items[]

对象

将字符串键映射到卷内的路径。

optional

布尔值

指定是否必须定义 Secret 还是其密钥

secretName

字符串

要使用的 pod 命名空间中的 secret 名称。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret

14.6.1.356. .spec.volumes[].secret.items

描述
如果未指定,引用的 Secret 的 Data 字段中的每个键值对都将作为键为键的文件投射到卷中,内容是值。如果指定,列出的密钥将投射到指定路径中,并且不存在未列出的密钥。如果指定了没有存在于 Secret 中的键,则卷设置将出错,除非它被标记为可选。路径必须相对,且可能不包含 '..' 路径,或者以 '..' 开头。
类型
array

14.6.1.357. .spec.volumes[].secret.items[]

描述
将字符串键映射到卷内的路径。
类型
对象
必填
  • key
  • path
Expand
属性类型描述

key

字符串

项目的密钥。

模式

整数

可选: 在此文件中要使用的模式位,必须是 0 到 0777 之间的值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项冲突,如 fsGroup,结果可以是其他模式位集。

path

字符串

要将密钥映射到的文件的相对路径。可能不是绝对路径。可能不包含 path 元素 '..'。可能无法以字符串 '..' 开头。

14.6.1.358. .spec.volumes[].storageos

描述
Storageos 代表在 Kubernetes 节点上附加并挂载的 StorageOS 卷。
类型
对象
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

readOnly

布尔值

默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。

secretRef

对象

secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定,则会尝试默认值。

volumeName

字符串

volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中唯一。

volumeNamespace

字符串

VolumeNamespace 指定 StorageOS 中的卷范围。如果没有指定命名空间,则使用 Pod 的命名空间。这允许 Kubernetes 名称范围在 StorageOS 中进行镜像,以便更好地集成。将 VolumeName 设置为任何名称来覆盖默认行为。如果没有在 StorageOS 中使用命名空间,则设置为 "default"。将创建没有在 StorageOS 中预先存在的命名空间。

14.6.1.359. .spec.volumes[].storageos.secretRef

描述
secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定,则会尝试默认值。
类型
对象
Expand
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

14.6.1.360. .spec.volumes[].vsphereVolume

描述
vsphereVolume 代表附加并挂载到 kubelet 主机上的 vSphere 卷
类型
对象
必填
  • volumePath
Expand
属性类型描述

fsType

字符串

要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

storagePolicyID

字符串

与 StoragePolicyName 关联的基于存储策略的管理(SPBM)配置集 ID。

storagePolicyName

字符串

基于存储策略的管理(SPBM)配置集名称。

volumePath

字符串

标识 vSphere 卷 vmdk 的路径

14.6.1.361. .spec.web

描述
WebSpec 在启动 Prometheus 时定义 Web 命令行标志。
类型
对象
Expand
属性类型描述

pageTitle

字符串

prometheus 网页标题

tlsConfig

对象

WebTLSConfig 为 HTTPS 定义 TLS 参数。

14.6.1.362. .spec.web.tlsConfig

描述
WebTLSConfig 为 HTTPS 定义 TLS 参数。
类型
对象
必填
  • cert
  • keySecret
Expand
属性类型描述

cert

对象

包含服务器的 TLS 证书。

cipherSuites

数组(字符串)

TLS 版本支持的密码套件列表,最多为 TLS 1.2。如果为空,则使用 Go 默认密码套件。可用的密码套件记录在文档 :https://golang.org/pkg/crypto/tls/#pkg-constants

clientAuthType

字符串

用于客户端身份验证的服务器策略。映射到 ClientAuth 策略。有关 clientAuth 选项的详情: https://golang.org/pkg/crypto/tls/#ClientAuthType

client_ca

对象

包含向服务器进行客户端证书身份验证的 CA 证书。

curvePreferences

数组(字符串)

在 ECDHE 握手中使用的 elliptic curves 以首选顺序使用。可用的 curves 记录在 go 文档 :https://golang.org/pkg/crypto/tls/#CurveID

keySecret

对象

包含服务器的 TLS 密钥的 secret。

maxVersion

字符串

接受的最大 TLS 版本。默认为 TLS13。

minVersion

字符串

可接受的最小 TLS 版本。默认为 TLS12。

preferServerCipherSuites

布尔值

控制服务器是否选择客户端的最首选密码套件,还是服务器最首选密码套件。如果为 true,则使用服务器的首选项,如 cipherSuites 中的元素顺序表示。

14.6.1.363. .spec.web.tlsConfig.cert

描述
包含服务器的 TLS 证书。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.364. .spec.web.tlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.365. .spec.web.tlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.366. .spec.web.tlsConfig.client_ca

描述
包含向服务器进行客户端证书身份验证的 CA 证书。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.6.1.367. .spec.web.tlsConfig.client_ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.6.1.368. .spec.web.tlsConfig.client_ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.369. .spec.web.tlsConfig.keySecret

描述
包含服务器的 TLS 密钥的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.6.1.370. .status

描述
Prometheus 集群最近观察到的状态。只读。从 apiserver 请求时不包括,仅来自 Prometheus Operator API 本身。更多信息: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
类型
对象
必填
  • availableReplicas
  • paused
  • replicas
  • unavailableReplicas
  • updatedReplicas
Expand
属性类型描述

availableReplicas

整数

此 Prometheus 部署的目标可用 pod 的总数(至少为 minReadySeconds)。

paused

布尔值

代表是否在底层受管对象上执行任何操作。仅执行 delete 操作。

replicas

整数

此 Prometheus 部署的目标非终端 pod 的总数(标签与选择器匹配)。

unavailableReplicas

整数

此 Prometheus 部署的目标不可用 pod 总数。

updatedReplicas

整数

此 Prometheus 部署的目标非终端 pod 总数,该部署具有所需版本 spec。

14.6.2. API 端点

可用的 API 端点如下:

  • /apis/monitoring.coreos.com/v1/prometheuses

    • GET :列出 Prometheus 类型的对象
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses

    • DELETE :删除 Prometheus 的集合
    • GET :列出 Prometheus 类型的对象
    • POST :创建 Prometheus
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}

    • DELETE :删除 Prometheus
    • GET :读取指定的 Prometheus
    • PATCH :部分更新指定的 Prometheus
    • PUT :替换指定的 Prometheus

14.6.2.1. /apis/monitoring.coreos.com/v1/prometheuses

Expand
表 14.97. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出被用户友善。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

HTTP 方法
GET
描述
列出 Prometheus 类型的对象
Expand
表 14.98. HTTP 响应
HTTP 代码响应正文

200 - OK

PrometheusList 模式

401 - Unauthorized

Expand
表 14.99. 全局路径参数
参数类型描述

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 14.100. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除 Prometheus 集合
Expand
表 14.101. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 14.102. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 Prometheus 类型的对象
Expand
表 14.103. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 14.104. HTTP 响应
HTTP 代码响应正文

200 - OK

PrometheusList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 Prometheus
Expand
表 14.105. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.106. 主体参数
参数类型描述

正文(body)

Prometheus 模式

 
Expand
表 14.107. HTTP 响应
HTTP 代码响应正文

200 - OK

Prometheus 模式

201 - Created

Prometheus 模式

202 - Accepted

Prometheus 模式

401 - Unauthorized

Expand
表 14.108. 全局路径参数
参数类型描述

name

字符串

Prometheus 的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 14.109. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除 Prometheus
Expand
表 14.110. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 14.111. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 14.112. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 Prometheus
Expand
表 14.113. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 14.114. HTTP 响应
HTTP 代码响应正文

200 - OK

Prometheus 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 Prometheus
Expand
表 14.115. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.116. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 14.117. HTTP 响应
HTTP 代码响应正文

200 - OK

Prometheus 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 Prometheus
Expand
表 14.118. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.119. 主体参数
参数类型描述

正文(body)

Prometheus 模式

 
Expand
表 14.120. HTTP 响应
HTTP 代码响应正文

200 - OK

Prometheus 模式

201 - Created

Prometheus 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat