执行器插件API¶

信息¶

版本¶

0.0.1

内容协商¶

URI 方案¶

• http

消费¶

• application/json

生成内容¶

• application/json

所有端点¶

操作¶

路径¶

执行模板 (executeTemplate)¶

POST /api/v1/template.execute

参数¶

所有响应¶

响应¶

200¶

状态：正常

架构¶

ExecuteTemplateReply

模型¶

AWSElasticBlockStoreVolumeSource¶

在挂载到容器之前，必须存在一个AWS EBS磁盘。该磁盘还必须与kubelet位于相同的AWS可用区。一个AWS EBS磁盘只能以读写方式挂载一次。AWS EBS卷支持所有权管理和SELinux重新标记。

属性

亲和性¶

属性

数量¶

+kubebuilder:validation:Type=number

interface{}

任意字符串¶

它会将int64、int32、float64、float32、布尔值以及纯字符串解组并表示为字符串。 它会重新组编回字符串 - 组编过程不是对称的。

AppArmor配置文件¶

+union

属性

AppArmorProfileType¶

+枚举

归档策略¶

ArchiveStrategy 描述了在保存工件时如何归档文件/目录

属性

参数¶

模板的参数

属性

工件¶

Artifact 表示要放置在指定路径的工件

属性

工件垃圾回收¶

ArtifactGC 描述了如何从已完成的 Workflows 中删除工件 - 这部分内容被嵌入到 WorkflowLevelArtifactGC 中，同时也可用于单个 Artifacts 以根据需要覆盖该设置

属性

ArtifactGC策略¶

工件位置¶

在输入/输出的上下文中，它被用作单一工件（例如 outputs.artifacts.artname）。 它也用于描述多个工件的位置，例如单个工作流步骤的归档位置，执行器将使用该位置作为存储其文件的默认位置。

属性

工件路径¶

ArtifactPaths 从一组工件中扩展出一个步骤

属性

ArtifactoryArtifact¶

ArtifactoryArtifact 表示一个 Artifactory 工件的存储位置

属性

工件¶

[]Artifact

AzureArtifact¶

AzureArtifact 是 Azure 存储工件的位置

属性

Azure数据磁盘缓存模式¶

+枚举

Azure数据磁盘类型¶

+枚举

AzureDiskVolumeSource¶

属性

AzureFileVolumeSource¶

属性

回退策略¶

Backoff是retryStrategy中使用的一种回退策略

属性

基础认证¶

BasicAuth 描述了基本身份验证所需的密钥选择器

属性

CSIVolumeSource¶

表示由外部CSI驱动程序管理的待挂载卷的源位置

属性

缓存¶

Cache 是用于指定缓存类型的配置

属性

功能¶

属性

功能¶

Capability 表示 POSIX 能力类型

CephFSVolumeSource¶

表示一个在Pod生命周期内持续存在的Ceph文件系统挂载 Cephfs卷不支持所有权管理或SELinux重新标记。

属性

CinderVolumeSource¶

在挂载到容器之前，必须存在一个Cinder卷。 该卷还必须与kubelet位于同一区域。 Cinder卷支持所有权管理和SELinux重新标记。

属性

客户端证书认证¶

ClientCertAuth 包含通过证书进行客户端认证的必要信息

属性

ClusterTrustBundleProjection¶

ClusterTrustBundleProjection 描述了如何选择一组 ClusterTrustBundle 对象并将其内容投射到 pod 文件系统中。

属性

ConfigMapEnvSource¶

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

属性

ConfigMapKeySelector¶

+structType=atomic

属性

ConfigMap投影¶

目标ConfigMap的Data字段内容将以文件形式呈现在投影卷中，使用Data字段中的键作为文件名，除非items元素中填充了键到路径的特定映射。请注意，这与没有默认模式的configmap卷源完全相同。

属性

ConfigMapVolumeSource¶

目标ConfigMap的Data字段内容将以文件形式挂载到卷中，使用Data字段中的键作为文件名，除非items元素中指定了键到路径的特定映射关系。ConfigMap卷支持所有权管理和SELinux重新标记。

属性

容器¶

属性

容器节点¶

属性

容器端口¶

属性

容器调整策略¶

属性

容器重启策略¶

该设置仅适用于初始化容器，且唯一允许的值为"Always"。

ContainerSet重试策略¶

ContainerSetRetryStrategy 提供了如何重试容器集的控制选项

属性

容器集模板¶

属性

继续执行条件¶

可以指定当Pod出现错误、失败或两者都发生时，工作流是否应继续执行。

属性

计数器¶

Counter 是一个 Prometheus 计数器指标

属性

创建S3存储桶选项¶

CreateS3BucketOptions 选项用于确定自动创建存储桶的过程

属性

DAG任务¶

DAGTask 表示 DAG 执行过程中图中的一个节点

属性

DAG模板¶

DAGTemplate 是用于有向无环图模板的模板子类型

属性

数据¶

数据是一个数据模板

属性

数据源¶

DataSource 将外部数据导入数据模板

属性

DownwardAPIProjection¶

请注意，这与没有默认模式的downwardAPI卷源完全相同。

属性

DownwardAPIVolumeFile¶

DownwardAPIVolumeFile 表示用于创建包含 Pod 字段文件的信息

属性

DownwardAPIVolumeSource¶

Downward API卷支持所有权管理和SELinux重新标记。

属性

持续时间¶

Duration 是 time.Duration 的封装器，支持正确序列化为 YAML 和 JSON。特别地，它会序列化为字符串格式，这种格式可作为 json 中的映射键使用。

interface{}

EmptyDirVolumeSource¶

空目录卷支持所有权管理和SELinux重新标记。

属性

环境变量来源¶

EnvFromSource 表示一组 ConfigMaps 的来源

属性

环境变量¶

属性

环境变量来源¶

属性

临时卷来源¶

属性

执行动作¶

属性

ExecuteTemplateArgs 参数¶

属性

ExecuteTemplateReply 执行模板回复¶

属性

ExecutorConfig¶

属性

FCVolumeSource¶

光纤通道卷只能以读写一次的方式挂载。 光纤通道卷支持所有权管理和SELinux重新标记。

属性

FieldsV1¶

每个键要么是一个代表字段本身的'.'（始终映射到一个空集），要么是表示子字段或项目的字符串。该字符串将遵循以下四种格式之一： 'f:'，其中是结构体中的字段名或映射中的键名 'v:'，其中是列表项的确切JSON格式值 'i:'，其中是列表中项目的位置 'k:'，其中是列表项的键字段到其唯一值的映射 如果某个键映射到一个空的Fields值，则表示该键所代表的字段属于该集合。

确切格式定义在 sigs.k8s.io/structured-merge-diff +protobuf.options.(gogoproto.goproto_stringer)=false

interface{}

FlexVolumeSource¶

FlexVolume 表示一种通用的卷资源，它通过基于 exec 的插件进行配置/挂载。

属性

Flocker卷源¶

datasetName 和 datasetUUID 中必须且只能设置其中一个。 Flocker 卷不支持所有权管理或 SELinux 重新标记。

属性

GCEPersistentDiskVolumeSource¶

在挂载到容器之前，GCE PD必须已存在。该磁盘还必须与kubelet位于相同的GCE项目和区域中。GCE PD只能以读写模式挂载一次或以只读模式挂载多次。GCE PD支持所有权管理和SELinux重新标记。

属性

GCSArtifact¶

GCSArtifact 是 GCS 存储产物的位置

属性

GRPCAction¶

属性

仪表盘¶

Gauge 是一种 Prometheus 指标类型

属性

GaugeOperation¶

Git代码库工件¶

GitArtifact 是一个 git 工件的位置

属性

GitRepo卷来源¶

已弃用：GitRepo 已被弃用。如需在容器中提供 git 仓库，请将 EmptyDir 挂载到 InitContainer 中，该 InitContainer 会使用 git 克隆仓库，然后将 EmptyDir 挂载到 Pod 的容器中。

属性

GlusterfsVolumeSource¶

Glusterfs卷不支持所有权管理或SELinux重新标记。

属性

HDFSArtifact¶

HDFSArtifact 是 HDFS 存储文件的位置

属性

HTTP¶

属性

HTTPArtifact¶

HTTPArtifact 允许将 HTTP 服务器上的文件作为输入工件放置在容器中

属性

HTTP认证¶

属性

HTTPBodySource¶

属性

HTTPGet操作¶

属性

HTTP头部¶

属性

HTTPHeaderSource¶

属性

HTTP请求头¶

[]HTTPHeader

标题¶

Header 表示在通过 HTTP 获取工件时要使用的键值请求头

属性

直方图¶

直方图是一种Histogram类型的Prometheus指标

属性

主机别名¶

HostAlias 保存了 IP 和主机名之间的映射关系，这些映射将作为条目注入到 pod 的 hosts 文件中。

属性

HostPath类型¶

+枚举

HostPathVolumeSource¶

主机路径卷不支持所有权管理或SELinux重新标记。

属性

ISCSIVolumeSource¶

ISCSI卷只能以读写方式挂载一次。 ISCSI卷支持所有权管理和SELinux重新标记。

属性

ImageVolumeSource¶

属性

输入¶

输入是将参数、工件、卷从一个模板传递到另一个模板的机制

属性

IntOrString¶

+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true

属性

项目¶

+protobuf.options.(gogoproto.goproto_stringer)=false +kubebuilder:validation:Type=object

interface{}

KeyToPath¶

属性

标签选择器¶

标签选择器是对一组资源的标签查询。matchLabels和matchExpressions的结果会进行逻辑与运算。空标签选择器会匹配所有对象。而null标签选择器不会匹配任何对象。 +structType=atomic

属性

LabelSelectorOperator¶

LabelSelectorRequirement¶

标签选择器要求是一个包含值、键以及将键与值关联起来的运算符的选择器。

属性

生命周期¶

生命周期描述了管理系统应对容器生命周期事件所采取的操作。对于PostStart和PreStop生命周期钩子，容器管理会阻塞直到操作完成，除非容器进程失败，此时钩子会被中止。

属性

生命周期处理器¶

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

属性

生命周期钩子¶

属性

生命周期钩子¶

LifecycleHooks

LocalObjectReference¶

不建议使用此类型的新用途，因为当嵌入API时难以描述其用法。 1. 无效的用法帮助。无法为个别用法添加具体帮助。在大多数嵌入式用法中，存在特定限制，例如"只能引用类型A和B"或"不识别UID"或"名称必须受限"。 这些限制在嵌入时无法很好地描述。 2. 不一致的验证。由于用法不同，验证规则也因用法而异，这使得用户难以预测会发生什么。 3. 我们无法轻易更改它。由于此类型嵌入在许多位置，对此类型的更新将影响众多模式。不要让新的API嵌入它们无法控制的未充分指定的API类型。

与其使用此类型，不如创建一个本地提供和使用的类型，该类型应专注于您的引用。 例如，准入注册的ServiceReferences：https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 。 +structType=atomic

属性

ManagedFields条目¶

ManagedFieldsEntry 是一个工作流ID、一个字段集以及该字段集所应用的资源的组版本。

属性

ManagedFields操作类型¶

从清单生成¶

属性

记忆化¶

记忆化功能可缓存模板的输出结果

属性

元数据¶

Pod元数据

属性

指标标签¶

MetricLabel是Prometheus指标的单个标签

属性

指标¶

指标是从工作流/模板发出的一系列指标

属性

挂载传播模式¶

+枚举

互斥锁¶

Mutex 持有互斥锁配置

属性

NFSVolumeSource¶

NFS卷不支持所有权管理或SELinux重新标记。

属性

节点亲和性(NodeAffinity)¶

属性

节点阶段¶

节点结果¶

属性

节点选择器¶

节点选择器表示对一组节点执行一个或多个标签查询结果的并集；也就是说，它代表了由节点选择器条件所表示的选择器的逻辑或关系。 +structType=atomic

属性

NodeSelectorOperator¶

节点选择器运算符是可以在节点选择器要求中使用的一组运算符。 +enum

NodeSelectorRequirement¶

节点选择器要求是一个包含值、键以及将键与值关联起来的运算符的选择器。

属性

节点选择器条件¶

空或空的节点选择器条件不匹配任何对象。它们的要求是逻辑与关系。 TopologySelectorTerm 类型实现了 NodeSelectorTerm 的一个子集。 +structType=atomic

属性

NoneStrategy¶

NoneStrategy表示跳过tar处理过程，直接将文件或目录树作为独立文件上传。请注意，如果工件是一个目录，工件驱动必须支持正确保存/加载目录的能力。

interface{}

OAuth2认证¶

OAuth2Auth 包含通过 OAuth2 令牌进行客户端认证的所有信息

属性

OAuth2端点参数¶

EndpointParam 用于请求在oauth请求中应发送的可选字段

属性

OSSArtifact¶

OSSArtifact 是阿里云 OSS 存储对象的位置

属性

OSS生命周期规则¶

OSSLifecycleRule 规定了如何管理存储桶的生命周期

属性

ObjectFieldSelector¶

+structType=atomic

属性

ObjectMeta¶

属性

输出¶

输出包含步骤中的参数、工件和结果

属性

OwnerReference¶

OwnerReference包含足够的信息用于识别所属对象。所属对象必须与依赖项位于同一命名空间内，或者是集群范围的，因此没有命名空间字段。 +structType=atomic

属性

并行步骤¶

+kubebuilder:validation:Type=array

interface{}

参数¶

参数表示传递给服务模板的字符串参数，可包含一个可选的默认值

属性

PersistentVolume访问模式¶

+枚举

PersistentVolumeClaimSpec 规范¶

PersistentVolumeClaimSpec 描述了存储设备的通用属性，并允许提供特定于供应商属性的来源

属性

持久卷声明模板¶

PersistentVolumeClaimTemplate 用于生成 PersistentVolumeClaim 对象，作为 EphemeralVolumeSource 的一部分。

属性

PersistentVolumeClaimVolumeSource¶

该卷会查找绑定的PV并将该卷挂载到Pod上。PersistentVolumeClaimVolumeSource本质上是一个对其他类型卷（由系统所有）的封装。

属性

持久卷模式¶

+枚举

PhotonPersistentDiskVolumeSource¶

属性

插件¶

插件是一个仅包含一个键的对象

interface{}

Pod亲和性¶

属性

Pod亲和性条件¶

定义了一组Pod（即与给定命名空间下labelSelector匹配的Pod），当前Pod应与这组Pod位于同一位置（亲和性）或不应位于同一位置（反亲和性）。其中"位于同一位置"的定义是：运行在具有特定拓扑键（topologykey）标签的节点上，且该标签值与运行该组Pod中任一Pod的节点标签值相匹配。

属性

Pod反亲和性¶

属性

PodFSGroup变更策略¶

PodFSGroupChangePolicy 定义了在卷挂载时应用 fsGroup 到卷的策略 +enum

PodSELinux变更策略¶

Pod安全上下文¶

部分字段也存在于container.securityContext中。container.securityContext的字段值优先级高于PodSecurityContext的字段值。

属性

PortworxVolumeSource¶

属性

PreferredSchedulingTerm¶

一个空的偏好调度条件会隐式匹配所有对象，权重为0（即无操作）。一个空的偏好调度条件不匹配任何对象（同样是无操作）。

属性

探针¶

Probe 描述了对容器执行的健康检查，用于确定容器是否存活或准备好接收流量。

属性

ProcMountType¶

+枚举

进度¶

ProjectedVolumeSource¶

表示一个投影卷源

属性

Prometheus¶

Prometheus 是一个要发送的 prometheus 指标

属性

协议¶

+枚举

拉取策略(PullPolicy)¶

PullPolicy 描述了拉取容器镜像的策略条件 +enum

数量¶

序列化格式为：

<quantity>        ::= <signedNumber><suffix>

(Note that <suffix> may be empty, from the "" case in <decimalSI>.)

<digit>           ::= 0 | 1 | ... | 9
<digits>          ::= <digit> | <digit><digits>
<number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits>
<sign>            ::= "+" | "-"
<signedNumber>    ::= <number> | <sign><number>
<suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI>
<binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

<decimalSI>       ::= m | "" | k | M | G | T | P | E

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>

无论使用三种指数形式中的哪一种，任何数值的大小都不能超过2^63-1，也不能超过3位小数。更大或更精确的数字将被限制或向上取整。（例如：0.1m将被向上取整为1m。）如果将来我们需要更大或更小的数值范围，可能会对此进行扩展。

当从字符串解析Quantity时，它会记住其拥有的后缀类型，并在序列化时再次使用相同的类型。

在序列化之前，Quantity将被转换为"规范形式"。 这意味着指数/后缀会相应调高或调低（同时尾数也会相应增加或减少），以确保：

不会丢失精度 不会输出小数位 指数（或后缀）尽可能大。

除非数字为负数，否则符号将被省略。

示例：

1.5将被序列化为"1500m" 1.5Gi将被序列化为"1536Mi"

请注意，该数量绝不会在内部以浮点数形式表示。这正是本次练习的核心目的。

非规范值只要格式正确仍可解析，但会以规范形式重新输出。（因此请始终使用规范形式，或不要进行差异比较。）

这种格式旨在让使用者难以直接利用这些数值，除非编写特定的处理代码，目的是促使实现者也采用定点数实现方案。

+protobuf=true +protobuf.embed=string +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:deepcopy-gen=true +k8s:openapi-gen=true

interface{}

QuobyteVolumeSource¶

Quobyte卷不支持所有权管理或SELinux重新标记。

属性

RBD卷源¶

RBD卷支持所有权管理和SELinux重新标记。

属性

原始工件¶

RawArtifact 允许将原始字符串内容作为工件放置在容器中

属性

递归只读模式¶

资源声明¶

属性

ResourceFieldSelector¶

ResourceFieldSelector 表示容器资源（CPU、内存）及其输出格式 +structType=atomic

属性

资源列表¶

ResourceList

资源名称¶

资源需求¶

属性

ResourceResizeRestartPolicy¶

资源模板¶

ResourceTemplate 是一种用于操作 Kubernetes 资源的模板子类型

属性