附录：CUE 操作符

Version: v1.2

附录：CUE 操作符

这个文档介绍 step 定义过程中，可以使用的 CUE 操作类型。这些操作均由 vela/op 包提供。

可以阅读 CUE 基础文档来学习 CUE 基础语法。

Apply

在 Kubernetes 集群中创建或者更新资源。

操作参数

value: 将被 apply 的资源的定义。操作成功执行后，会用集群中资源的状态重新渲染 value。
patch: 对 value 的内容打补丁，支持策略性合并，比如可以通过注释 // +patchKey 实现数组的按主键合并。

#Apply: {
  value: {...}
  patch: {
    // patchKey=$key
    ...
  }
}

用法示例

import "vela/op"
stepName: op.#Apply & {
  value: {
    kind: "Deployment"
    apiVersion: "apps/v1"
    metadata: name: "test-app"
    spec: { 
      replicas: 2
      ...
    }
  }
  patch: {
   spec: template: spec: {
      // patchKey=name
      containers: [{name: "sidecar"}]
   }
  }
}

ConditionalWait

会让 workflow step 处于等待状态，直到条件被满足。

操作参数

continue: 当该字段为 true 时，workflow step 才会恢复继续执行。

#ConditionalWait: {
  continue: bool
}

用法示例

import "vela/op"
apply: op.#Apply
wait: op.#ConditionalWait & {
  continue: apply.value.status.phase=="running"
}

Load

获取 Application 中所有组件对应的资源数据。

操作参数

无需指定参数。

#Load: {}

用法示例

import "vela/op"
// 该操作完成后，你可以使用 `load.value.[componentName]` 来获取到对应组件的资源数据
load: op.#Load & {}

Read

读取 Kubernetes 集群中的资源。

操作参数

value: 需要用户描述读取资源的元数据，比如 kind、name 等，操作完成后，集群中资源的数据会被填充到 value 上。
err: 如果读取操作发生错误，这里会以字符串的方式指示错误信息。

#Read: {
  value: {}
  err?: string
}

用法示例

// 操作完成后，你可以通过 configmap.value.data 使用 configmap 里面的数据
configmap: op.#Read & {
   value: {
      kind: "ConfigMap"
      apiVersion: "v1"
      metadata: {
        name: "configmap-name"
        namespace: "configmap-ns"
      }
   }
}

ApplyApplication

在 Kubernetes 集群中创建或者更新应用对应的所有资源。

操作参数

无需指定参数。

#ApplyApplication: {}

用法示例

apply: op.#ApplyApplication & {}

ApplyComponent

在 Kubernetes 集群中创建或者更新组件对应的所有资源。注意，在使用该操作前需要先用 Load 加载资源。

操作参数

value: 指定需要 apply 的资源定义。
patch: 指定需要 patch 的资源定义

#ApplyComponent: {
  value: {...}
  patch: {...}
}

用法示例

load: op.#Load & {}
apply: op.#ApplyComponent & {
  value: load.value[parameter.component]
}

ApplyRemaining

在 Kubernetes 集群中创建或者更新 Application 中所有组件对应的资源,并可以通过 exceptions 指明哪些组件或者组件中的某些资源跳过创建和更新。

操作参数

exceptions: 指明该操作需要排除掉的组件。

#ApplyRemaining: {
 exceptions?: [...string]
}

用法示例

apply: op.#ApplyRemaining & {
  exceptions: ["applied-component-name"]
}

Slack

向 Slack 发送消息通知。

操作参数

url: Slack 的 Webhook 地址。
message: 需要发送的 Slack 消息，需要符合 Slack 信息规范。

#Slack: {
  url: string
  message: {...}
}

用法示例

apply: op.#Slack & {
  url: webhook url
  message:
    text: Hello KubeVela
}

DingTalk

向钉钉发送消息通知。

操作参数

url: 钉钉的 Webhook 地址。
message: 需要发送的钉钉消息，需要符合钉钉信息规范。

#DingTalk: {
  url: string
  message: {...}
}

用法示例

apply: op.#DingTalk & {
  url: webhook url
  message:
    msgtype: text
    text:
      context: Hello KubeVela
}

Steps

用来封装一组操作。

操作参数

steps 里面需要通过 tag 的方式指定执行顺序，数字越小执行越靠前。

用法示例

app: op.#Steps & {
  load: op.#Load & {
    component: "component-name"
  } @step(1)
  apply: op.#Apply & {
    value: load.value.workload
  } @step(2)
}

DoVar

用来在workflow的上下文中保存或者读取用户定义的数据

操作参数

method: 值为Get或者Put，用于表示该动作是从 workflow 中读取还是保存数据
path: 数据保存或者读取的路径
value: 数据内容(格式为 cue )，当 method 为 Get 表示读取到的数据，当 method 为 Put 时表示要保存的数据

用法示例

put: op.ws.#DoVar & {
  method: "Put"
  path: "foo.score"
  value: 100
}
// 用户可以通过get.value拿到上面保存的数据(100)
get: op.ws.#DoVar & {
  method: "Get"
  path: "foo.score"
}