Version: v1.0

状态回写

本文档将说明如何通过在定义对象中使用 CUE 模板来实现状态回写。

健康检查

在 Workload 和 Trait 中健康检查字段都是 spec.status.healthPolicy。

如果没有定义该字段，健康检查结果默认为 true。

CUE 中关键字为 isHealth，CUE 表达式结果必须是 bool 类型。 KubeVela 运行时将定期评估 CUE 表达式直到状态为健康。控制器每次都会获取所有 Kubernetes 资源，同时将结果填充到 context 字段中。

所以 context 字段将包含以下信息：

  1. context:{
  2.   name: <component name>
  3.   appName: <app name>
  4.   output: <K8s workload resource>
  5.   outputs: {
  6.     <resource1>: <K8s trait resource1>
  7.     <resource2>: <K8s trait resource2>
  8.   }
  9. }

Trait 并不包含 context.output 字段，其他字段都是相同。

以下为健康检查的示例：

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: ComponentDefinition
  3. spec:
  4.   status:
  5.     healthPolicy: |
  6.       isHealth: (context.output.status.readyReplicas > 0) && (context.output.status.readyReplicas == context.output.status.replicas)
  7.    ...
  1. apiVersion: core.oam.dev/v1beta1
  2. kind: TraitDefinition
  3. spec:
  4.   status:
  5.     healthPolicy: |
  6.       isHealth: len(context.outputs.service.spec.clusterIP) > 0
  7.    ...

Component 健康检查示例请参考 这篇文章 。

该健康检查结果将被记录在组件对应的 Application 资源中。

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. spec:
  4.   components:
  5.   - name: myweb
  6.     type: worker    
  7.     properties:
  8.       cmd:
  9.       - sleep
  10.       - "1000"
  11.       enemies: alien
  12.       image: busybox
  13.       lives: "3"
  14.     traits:
  15.     - type: ingress
  16.       properties:
  17.         domain: www.example.com
  18.         http:
  19.           /: 80
  20. status:
  21.   ...
  22.   services:
  23.   - healthy: true
  24.     message: "type: busybox,\t enemies:alien"
  25.     name: myweb
  26.     traits:
  27.     - healthy: true
  28.       message: 'Visiting URL: www.example.com, IP: 47.111.233.220'
  29.       type: ingress
  30.   status: running

自定义状态

自定义状态配置项为 spec.status.customStatus，Workload 和 Trait 中都是该字段。

自定义状态 CUE 中关键词为 message，CUE 表达式的结果必须是 string 类型。

自定义状态的内部机制类似上面介绍的健康检查。Application CRD 控制器将评估 CUE 表达式直到检查成功。

context 字段将包含以下信息：

  1. context:{
  2.   name: <component name>
  3.   appName: <app name>
  4.   output: <K8s workload resource>
  5.   outputs: {
  6.     <resource1>: <K8s trait resource1>
  7.     <resource2>: <K8s trait resource2>
  8.   }
  9. }

Trait 并不包含 context.output 字段，其他字段都是相同。

Component 健康检查示例请参考 这篇文章 。

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: ComponentDefinition
  3. spec:
  4.   status:
  5.     customStatus: |-
  6.       message: "type: " + context.output.spec.template.spec.containers[0].image + ",\t enemies:" + context.outputs.gameconfig.data.enemies
  7.    ...
  1. apiVersion: core.oam.dev/v1beta1
  2. kind: TraitDefinition
  3. spec:
  4.   status:
  5.     customStatus: |-
  6.       message: "type: "+ context.outputs.service.spec.type +",\t clusterIP:"+ context.outputs.service.spec.clusterIP+",\t ports:"+ "\(context.outputs.service.spec.ports[0].port)"+",\t domain"+context.outputs.ingress.spec.rules[0].host
  7.    ...