Skip to main content
版本:预览版

内置组件列表

本文档将按字典序展示所有内置组件的参数列表。

本文档由脚本自动生成,请勿手动修改,上次更新于 2022-11-24T12:21:19+08:00。

Cron-Task

描述

定义一个周期性运行代码或者脚本的任务。

底层 Kubernetes 资源 (cron-task)

  • cronjobs.batch

示例 (cron-task)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: cron-worker
spec:
components:
- name: mytask
type: cron-task
properties:
image: perl
count: 10
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
schedule: "*/1 * * * *"

参数说明 (cron-task)

名称描述类型是否必须默认值
labels工作负载的标签。map[string]:stringfalse
annotations工作负载的注解。map[string]:stringfalse
schedule执行规则 Cron 规范stringtrue
startingDeadlineSecondsSpecify deadline in seconds for starting the job if it misses scheduled。intfalse
suspend是否暂停执行。boolfalsefalse
concurrencyPolicy定义任务如何处理任务的重叠运行,可选值为 "Allow","Forbid" 或者 "Replace",默认值为 Allow。stringfalseAllow
successfulJobsHistoryLimit保留多少个已经成功完成的任务记录。intfalse3
failedJobsHistoryLimit保留多少个已经失败的任务记录。intfalse1
count每次任务执行的并行度。intfalse1
image容器使用的镜像。stringtrue
imagePullPolicy镜像拉取策略。stringfalse
imagePullSecrets容器的镜像拉取密钥。[]stringfalse
restart定义失败重启策略,可选值为 Never 或者 OnFailure,默认是 OnFailure。stringfalseNever
cmd容器的启动命令。[]stringfalse
env容器中的环境变量。[]envfalse
cpuCPU 核数 0.5 (0.5 CPU 核), 1 (1 CPU 核)。stringfalse
memory所需要的内存大小。stringfalse
volumesDeclare volumes and volumeMounts。[]volumesfalse
hostAliasesAn optional list of hosts and IPs that will be injected into the pod's hosts file。[]hostAliasesfalse
ttlSecondsAfterFinishedLimits the lifetime of a Job that has finished。intfalse
activeDeadlineSecondsThe duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it。intfalse
backoffLimitThe number of retries before marking this job failed。intfalse6
livenessProbe判断容器是否存活的探针。livenessProbefalse
readinessProbe判断容器是否就绪,能够接受用户流量的探针。readinessProbefalse

env (cron-task)

名称描述类型是否必须默认值
name环境变量名称。stringtrue
value环境变量的值。stringfalse
valueFrom从哪个资源中读取环境变量的定义。valueFromfalse
valueFrom (cron-task)
名称描述类型是否必须默认值
secretKeyRefsecret 键的引用。secretKeyReffalse
configMapKeyRefconfigmap 键的引用。configMapKeyReffalse
secretKeyRef (cron-task)
名称描述类型是否必须默认值
nameSecret 名称。stringtrue
key选择 Secret 中存在的 key。stringtrue
configMapKeyRef (cron-task)
名称描述类型是否必须默认值
name环境变量的名称。stringtrue
keyconfigmap 中的键名。stringtrue

volumes (cron-task)

名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mediumstringfalseempty
typeSpecify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir。stringfalseemptyDir

hostAliases (cron-task)

名称描述类型是否必须默认值
ipstringtrue
hostnames[]stringtrue

livenessProbe (cron-task)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (cron-task)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (cron-task)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
httpHeaders[]httpHeadersfalse
httpHeaders (cron-task)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (cron-task)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

readinessProbe (cron-task)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (cron-task)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (cron-task)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
httpHeaders[]httpHeadersfalse
httpHeaders (cron-task)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (cron-task)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

Daemon

描述

定义一个同 Kubernetes 每个机器 Node 都运行的服务。

底层 Kubernetes 资源 (daemon)

  • daemonsets.apps

示例 (daemon)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: addon-node-exporter
namespace: vela-system
spec:
components:
- name: node-exporter
type: daemon
properties:
image: prom/node-exporter
imagePullPolicy: IfNotPresent
volumeMounts:
hostPath:
- mountPath: /host/sys
mountPropagation: HostToContainer
name: sys
path: /sys
readOnly: true
- mountPath: /host/root
mountPropagation: HostToContainer
name: root
path: /
readOnly: true
traits:
- properties:
args:
- --path.sysfs=/host/sys
- --path.rootfs=/host/root
- --no-collector.wifi
- --no-collector.hwmon
- --collector.filesystem.ignored-mount-points=^/(dev|proc|sys|var/lib/docker/.+|var/lib/kubelet/pods/.+)($|/)
- --collector.netclass.ignored-devices=^(veth.*)$
type: command
- properties:
annotations:
prometheus.io/path: /metrics
prometheus.io/port: "8080"
prometheus.io/scrape: "true"
port:
- 9100
type: expose
- properties:
cpu: 0.1
memory: 250Mi
type: resource

参数说明 (daemon)

名称描述类型是否必须默认值
labels工作负载的标签。map[string]:stringfalse
annotations工作负载的注解。map[string]:stringfalse
image容器使用的镜像。stringtrue
imagePullPolicy镜像拉取策略。stringfalse
imagePullSecrets容器的镜像拉取密钥。[]stringfalse
ports指定业务流量进入的端口(多个),默认为 80。[]portsfalse
cmd容器的启动命令。[]stringfalse
env容器中的环境变量。[]envfalse
cpuCPU 核数 0.5 (0.5 CPU 核), 1 (1 CPU 核)。stringfalse
memory所需要的内存大小。stringfalse
volumeMountsvolumeMountsfalse
volumesDeprecated field, use volumeMounts instead。[]volumesfalse
livenessProbe判断容器是否存活的探针。livenessProbefalse
readinessProbe判断容器是否就绪,能够接受用户流量的探针。readinessProbefalse
hostAliases定义容器内的 hostAliases。[]hostAliasesfalse

ports (daemon)

名称描述类型是否必须默认值
port要暴露的 IP 端口号。inttrue
name端口名称。stringfalse
protocol端口协议类型 UDP, TCP, 或者 SCTP。stringfalseTCP
expose端口是否需要暴露。boolfalsefalse

env (daemon)

名称描述类型是否必须默认值
name环境变量名称。stringtrue
value环境变量的值。stringfalse
valueFrom从哪个资源中读取环境变量的定义。valueFromfalse
valueFrom (daemon)
名称描述类型是否必须默认值
secretKeyRefsecret 键的引用。secretKeyReffalse
configMapKeyRefconfigmap 键的引用。configMapKeyReffalse
secretKeyRef (daemon)
名称描述类型是否必须默认值
nameSecret 名称。stringtrue
key选择 Secret 中存在的 key。stringtrue
configMapKeyRef (daemon)
名称描述类型是否必须默认值
name环境变量的名称。stringtrue
keyconfigmap 中的键名。stringtrue

volumeMounts (daemon)

名称描述类型是否必须默认值
pvc挂载一个 PVC 卷。[]pvcfalse
configMap挂载一个 configmap 卷。[]configMapfalse
secret挂载一个 secret 卷。[]secretfalse
emptyDir挂载一个 emptyDir 的卷。[]emptyDirfalse
hostPath挂载主机目录卷。[]hostPathfalse
pvc (daemon)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
claimNamePVC 名称。stringtrue
configMap (daemon)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
defaultModeintfalse420
cmNamestringtrue
items[]itemsfalse
items (daemon)
名称描述类型是否必须默认值
keystringtrue
pathstringtrue
modeintfalse511
secret (daemon)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
defaultModeintfalse420
secretNamestringtrue
items[]itemsfalse
items (daemon)
名称描述类型是否必须默认值
keystringtrue
pathstringtrue
modeintfalse511
emptyDir (daemon)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mediumstringfalseempty
hostPath (daemon)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mountPropagationstringfalse
pathstringtrue
readOnlyboolfalse

volumes (daemon)

名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mediumstringfalseempty
typeSpecify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir。stringfalseemptyDir

livenessProbe (daemon)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (daemon)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (daemon)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
hoststringfalse
schemestringfalseHTTP
httpHeaders[]httpHeadersfalse
httpHeaders (daemon)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (daemon)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

readinessProbe (daemon)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (daemon)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (daemon)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
hoststringfalse
schemestringfalseHTTP
httpHeaders[]httpHeadersfalse
httpHeaders (daemon)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (daemon)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

hostAliases (daemon)

名称描述类型是否必须默认值
ipstringtrue
hostnames[]stringtrue

K8s-Objects

描述

列表中的元素为完整的 Kubernetes 资源结构体。

示例 (k8s-objects)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-raw
spec:
components:
- name: myjob
type: k8s-objects
properties:
objects:
- apiVersion: batch/v1
kind: Job
metadata:
name: pi
spec:
template:
spec:
containers:
- name: pi
image: perl
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
backoffLimit: 4

参数说明 (k8s-objects)

NAMEDESCRIPTIONTYPEREQUIREDDEFAULT
objectsA slice of Kubernetes resource manifests[][Kubernetes-Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/)true

Task

描述

定义一个只执行一次代码或者脚本的任务。

底层 Kubernetes 资源 (task)

  • jobs.batch

示例 (task)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-worker
spec:
components:
- name: mytask
type: task
properties:
image: perl
count: 10
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]

参数说明 (task)

名称描述类型是否必须默认值
labels工作负载的标签。map[string]:stringfalse
annotations工作负载的注解。map[string]:stringfalse
count每次任务执行的并行度。intfalse1
image容器使用的镜像。stringtrue
imagePullPolicy镜像拉取策略。stringfalse
imagePullSecrets容器的镜像拉取密钥。[]stringfalse
restart定义失败重启策略,可选值为 Never 或者 OnFailure,默认是 OnFailure。stringfalseNever
cmd容器的启动命令。[]stringfalse
env容器中的环境变量。[]envfalse
cpuCPU 核数 0.5 (0.5 CPU 核), 1 (1 CPU 核)。stringfalse
memory所需要的内存大小。stringfalse
volumesDeclare volumes and volumeMounts。[]volumesfalse
livenessProbe判断容器是否存活的探针。livenessProbefalse
readinessProbe判断容器是否就绪,能够接受用户流量的探针。readinessProbefalse

env (task)

名称描述类型是否必须默认值
name环境变量名称。stringtrue
value环境变量的值。stringfalse
valueFrom从哪个资源中读取环境变量的定义。valueFromfalse
valueFrom (task)
名称描述类型是否必须默认值
secretKeyRefsecret 键的引用。secretKeyReffalse
configMapKeyRefconfigmap 键的引用。configMapKeyReffalse
secretKeyRef (task)
名称描述类型是否必须默认值
nameSecret 名称。stringtrue
key选择 Secret 中存在的 key。stringtrue
configMapKeyRef (task)
名称描述类型是否必须默认值
name环境变量的名称。stringtrue
keyconfigmap 中的键名。stringtrue

volumes (task)

名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mediumstringfalseempty
typeSpecify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir。stringfalseemptyDir

livenessProbe (task)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (task)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (task)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
httpHeaders[]httpHeadersfalse
httpHeaders (task)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (task)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

readinessProbe (task)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (task)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (task)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
httpHeaders[]httpHeadersfalse
httpHeaders (task)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (task)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

Webservice

描述

定义一个长期运行的,可伸缩的容器化的服务,并且会暴露一个服务端点用来接受来自客户的外部流量。

底层 Kubernetes 资源 (webservice)

  • deployments.apps

示例 (webservice)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: website
spec:
components:
- name: frontend
type: webservice
properties:
image: oamdev/testapp:v1
cmd: ["node", "server.js"]
ports:
- port: 8080
expose: true
cpu: "0.1"
env:
- name: FOO
value: bar
- name: FOO
valueFrom:
secretKeyRef:
name: bar
key: bar

参数说明 (webservice)

名称描述类型是否必须默认值
labels工作负载的标签。map[string]:stringfalse
annotations工作负载的注解。map[string]:stringfalse
image容器使用的镜像。stringtrue
imagePullPolicy镜像拉取策略。stringfalse
imagePullSecrets容器的镜像拉取密钥。[]stringfalse
ports指定业务流量进入的端口(多个),默认为 80。[]portsfalse
cmd容器的启动命令。[]stringfalse
env容器中的环境变量。[]envfalse
cpuCPU 核数 0.5 (0.5 CPU 核), 1 (1 CPU 核)。stringfalse
memory所需要的内存大小。stringfalse
volumeMountsvolumeMountsfalse
volumesDeprecated field, use volumeMounts instead。[]volumesfalse
livenessProbe判断容器是否存活的探针。livenessProbefalse
readinessProbe判断容器是否就绪,能够接受用户流量的探针。readinessProbefalse
hostAliases定义容器内的 hostAliases。[]hostAliasesfalse

ports (webservice)

名称描述类型是否必须默认值
port要暴露的 IP 端口号。inttrue
name端口名称。stringfalse
protocol端口协议类型 UDP, TCP, 或者 SCTP。stringfalseTCP
expose端口是否需要暴露。boolfalsefalse
nodePortexposed node port. Only Valid when exposeType is NodePort。intfalse

env (webservice)

名称描述类型是否必须默认值
name环境变量名称。stringtrue
value环境变量的值。stringfalse
valueFrom从哪个资源中读取环境变量的定义。valueFromfalse
valueFrom (webservice)
名称描述类型是否必须默认值
secretKeyRefsecret 键的引用。secretKeyReffalse
configMapKeyRefconfigmap 键的引用。configMapKeyReffalse
secretKeyRef (webservice)
名称描述类型是否必须默认值
nameSecret 名称。stringtrue
key选择 Secret 中存在的 key。stringtrue
configMapKeyRef (webservice)
名称描述类型是否必须默认值
name环境变量的名称。stringtrue
keyconfigmap 中的键名。stringtrue

volumeMounts (webservice)

名称描述类型是否必须默认值
pvc挂载一个 PVC 卷。[]pvcfalse
configMap挂载一个 configmap 卷。[]configMapfalse
secret挂载一个 secret 卷。[]secretfalse
emptyDir挂载一个 emptyDir 的卷。[]emptyDirfalse
hostPath挂载主机目录卷。[]hostPathfalse
pvc (webservice)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
subPathstringfalse
claimNamePVC 名称。stringtrue
configMap (webservice)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
subPathstringfalse
defaultModeintfalse420
cmNamestringtrue
items[]itemsfalse
items (webservice)
名称描述类型是否必须默认值
keystringtrue
pathstringtrue
modeintfalse511
secret (webservice)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
subPathstringfalse
defaultModeintfalse420
secretNamestringtrue
items[]itemsfalse
items (webservice)
名称描述类型是否必须默认值
keystringtrue
pathstringtrue
modeintfalse511
emptyDir (webservice)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
subPathstringfalse
mediumstringfalseempty
hostPath (webservice)
名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
subPathstringfalse
pathstringtrue

volumes (webservice)

名称描述类型是否必须默认值
namestringtrue
mountPathstringtrue
mediumstringfalseempty
typeSpecify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir。stringfalseemptyDir

livenessProbe (webservice)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (webservice)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (webservice)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
hoststringfalse
schemestringfalseHTTP
httpHeaders[]httpHeadersfalse
httpHeaders (webservice)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (webservice)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

readinessProbe (webservice)

名称描述类型是否必须默认值
exec通过在容器中执行一条命令判断是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。execfalse
httpGet通过发送 httpGet 请求判断容器是否就绪。 请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。httpGetfalse
tcpSocket通过 tcpSocket 是否开启判断容器是否就绪。请注意就绪性检查必须并且也只能定义 httpGet,tcpSocket 或者 exec 中的一个。tcpSocketfalse
initialDelaySeconds定义容器启动多少秒之后开始第一次检查。intfalse0
periodSeconds定义每次检查之间的时间间隔。intfalse10
timeoutSeconds定义检查的超时时间。intfalse1
successThreshold定义检查成功多少次之后判断容器已经就绪。intfalse1
failureThreshold定义检查失败多少次之后判断容器已经不健康。intfalse3
exec (webservice)
名称描述类型是否必须默认值
command容器中执行的命令,命令返回 0 则为正常,否则则为失败。[]stringtrue
httpGet (webservice)
名称描述类型是否必须默认值
path定义服务端点请求的路径。stringtrue
port定义服务端点的端口号。inttrue
hoststringfalse
schemestringfalseHTTP
httpHeaders[]httpHeadersfalse
httpHeaders (webservice)
名称描述类型是否必须默认值
namestringtrue
valuestringtrue
tcpSocket (webservice)
名称描述类型是否必须默认值
port指定健康检查的 TCP socket。inttrue

hostAliases (webservice)

名称描述类型是否必须默认值
ipstringtrue
hostnames[]stringtrue