Version: v1.2

补丁型特征

在自定义运维特征中，使用补丁型特征是一种比较常用的形式。

它让我们可以修改、补丁某些属性给组件对象（一般是工作负载）来完成特定操作，比如更新 sidecar 和节点亲和性（node affinity）的规则（并且，这个操作一定是在资源往集群部署前就已经生效）。

当我们的组件是从第三方提供并自定义而来的时候，由于它们的模版往往是固定不可变的，所以能使用补丁型特征就显得尤为有用了。

尽管运维特征是由 CUE 来定义，它能打补丁的组件类型并不限，不管是来自 CUE、Helm 还是其余支持的模版格式

下面，我们通过一个节点亲和性（node affinity）的例子，讲解如何使用补丁型特征：

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "affinity specify node affinity and toleration"
  11.   name: node-affinity
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {
  29.             spec: template: spec: {
  31.                 if parameter.affinity != _|_ {
  33.                     affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: [{
  35.                         matchExpressions: [
  37.                             for k, v in parameter.affinity {
  39.                                 key:      k
  41.                                 operator: "In"
  43.                                 values:   v
  45.                             },
  47.                         ]}]
  49.                 }
  51.                 if parameter.tolerations != _|_ {
  53.                     tolerations: [
  55.                         for k, v in parameter.tolerations {
  57.                             effect:   "NoSchedule"
  59.                             key:      k
  61.                             operator: "Equal"
  63.                             value:    v
  65.                         }]
  67.                 }
  69.             }
  71.         }
  76.         parameter: {
  78.             affinity?: [string]: [...string]
  80.             tolerations?: [string]: string
  82.         }

具体来说，我们上面的这个补丁型特征，假定了使用它的组件对象将会使用 spec.template.spec.affinity 这个字段。因此，我们需要用 appliesToWorkloads 来指明，让当前运维特征被应用到拥有这个字段的对应工作负载实例上。

另一个重要的字段是 podDisruptive，这个补丁型特征将修改 Pod 模板字段，因此对该运维特征的任何字段进行更改，都会导致 Pod 重启。我们应该增加 podDisruptive 并且设置它的值为 true，以此告诉用户这个运维特征生效后将导致 Pod 重新启动。

现在用户只需要，声明他们希望增加一个节点亲和性的规则到组件实例当中：

  1. apiVersion: core.oam.dev/v1alpha2
  3. kind: Application
  5. metadata:
  7.   name: testapp
  9. spec:
  11.   components:
  13.     - name: express-server
  15.       type: webservice
  17.       properties:
  19.         image: oamdev/testapp:v1
  21.       traits:
  23.         - type: "node-affinity"
  25.           properties:
  27.             affinity:
  29.               server-owner: ["owner1","owner2"]
  31.               resource-pool: ["pool1","pool2","pool3"]
  33.             tolerations:
  35.               resource-pool: "broken-pool1"
  37.               server-owner: "old-owner"

待解决的短板

默认来说，补丁型特征是通过 CUE 的 merge 操作来实现的。它有以下限制：

  • 不能处理有冲突的字段名
    • 比方说，在一个组件实例中已经设置过这样的值 replicas=5，那一旦有运维特征实例，尝试给 replicas 字段的值打补丁就会失败。所以我们建议你提前规划好，不要在组件和运维特征之间使用重复的字段名。
  • 数组列表被补丁时，会按索引顺序进行合并。如果数组里出现了重复的值，将导致问题。为了规避这个风险，请查询后面的解决方案。

策略补丁

策略补丁，通过增加注解（annotation）而生效，并支持如下两种模式。

请注意，这里开始并不是 CUE 官方提供的功能, 而是 KubeVela 扩展开发而来

1. 使用 +patchKey=<key_name> 注解

这个注解，是给数组列表打补丁用的。它的执行方式也不遵循 CUE 官方的方式，而是将每一个数组列表视作对象，并执行如下的策略：

  • 如果发现重复的键名，补丁数据会直接替换掉它的值
  • 如果没有重复键名，补丁则会自动附加这些数据

下面来看看，一个使用 ‘patchKey’ 的策略补丁：

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "add sidecar to the app"
  11.   name: sidecar
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {
  29.             // +patchKey=name
  31.             spec: template: spec: containers: [parameter]
  33.         }
  35.         parameter: {
  37.             name:  string
  39.             image: string
  41.             command?: [...string]
  43.         }

在上述的这个例子中，我们定义了要 patchKey 的字段 name，是来自容器的参数键名。如果工作负载中并没有同名的容器，那么一个 sidecar 容器就会被加到 spec.template.spec.containers 数组列表中。如果工作负载中有重名的 sidecar 运维特征，则会执行 merge 操作而不是附加。

如果 patch 和 outputs 同时存在于一个运维特征定义中，patch 会率先被执行然后再渲染 outputs。

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "expose the app"
  11.   name: expose
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {spec: template: metadata: labels: app: context.name}
  29.         outputs: service: {
  31.             apiVersion: "v1"
  33.             kind:       "Service"
  35.             metadata: name: context.name
  37.             spec: {
  39.                 selector: app: context.name
  41.                 ports: [
  43.                     for k, v in parameter.http {
  45.                         port:       v
  47.                         targetPort: v
  49.                     },
  51.                 ]
  53.             }
  55.         }
  57.         parameter: {
  59.             http: [string]: int
  61.         }

在上面这个运维特征定义中，我们将会把一个 Service 添加到给定的组件实例上。同时会先去给工作负载类型打上补丁数据，然后基于模版里的 outputs 渲染余下的资源。

2. 使用 +patchStrategy=retainkeys 注解

这个注解的策略，与 Kubernetes 官方的 retainkeys 策略类似。

在一些场景下，整个对象需要被一起替换掉，使用 retainkeys 就是最适合的办法。

假定一个 Deployment 对象是这样编写的：

  1. apiVersion: apps/v1
  3. kind: Deployment
  5. metadata:
  7.   name: retainkeys-demo
  9. spec:
  11.   selector:
  13.     matchLabels:
  15.       app: nginx
  17.   strategy:
  19.     type: rollingUpdate
  21.     rollingUpdate:
  23.       maxSurge: 30%
  25.   template:
  27.     metadata:
  29.       labels:
  31.         app: nginx
  33.     spec:
  35.       containers:
  37.       - name: retainkeys-demo-ctr
  39.         image: nginx

现在如果我们想替换掉 rollingUpdate 策略，你可以这样写：

  1. apiVersion: core.oam.dev/v1alpha2
  3. kind: TraitDefinition
  5. metadata:
  7.   name: recreate
  9. spec:
  11.   appliesToWorkloads:
  13.     - deployments.apps
  15.   extension:
  17.     template: |-
  19.       patch: {
  21.          spec: {
  23.               // +patchStrategy=retainKeys
  25.               strategy: type: "Recreate"
  27.            }
  29.       }

这个 YAML 资源将变更为：

  1. apiVersion: apps/v1
  3. kind: Deployment
  5. metadata:
  7.   name: retainkeys-demo
  9. spec:
  11.   selector:
  13.     matchLabels:
  15.       app: nginx
  17.   strategy:
  19.     type: Recreate
  21.   template:
  23.     metadata:
  25.       labels:
  27.         app: nginx
  29.     spec:
  31.       containers:
  33.       - name: retainkeys-demo-ctr
  35.         image: nginx

更多补丁型特征的使用场景

补丁型特征，针对组件层面做些整体操作时，非常有用。我们看看还可以满足哪些需求：

增加标签

比如说，我们要给组件实例打上 virtualgroup 的通用标签。

  1. apiVersion: core.oam.dev/v1alpha2
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "Add virtual group labels"
  11.   name: virtualgroup
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {
  29.             spec: template: {
  31.                 metadata: labels: {
  33.                     if parameter.scope == "namespace" {
  35.                         "app.namespace.virtual.group": parameter.group
  37.                     }
  39.                     if parameter.scope == "cluster" {
  41.                         "app.cluster.virtual.group": parameter.group
  43.                     }
  45.                 }
  47.             }
  49.         }
  51.         parameter: {
  53.             group: *"default" | string
  55.             scope:  *"namespace" | string
  57.         }

然后这样用就可以了:

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. spec:
  7.   ...
  9.       traits:
  11.       - type: virtualgroup
  13.         properties:
  15.           group: "my-group1"
  17.           scope: "cluster"

增加注解

与通用标签类似，你也可以给组件实例打补丁，增加一些注解。注解的格式，必须是 JSON。

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "Specify auto scale by annotation"
  11.   name: kautoscale
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: false
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         import "encoding/json"
  32.         patch: {
  34.             metadata: annotations: {
  36.                 "my.custom.autoscale.annotation": json.Marshal({
  38.                     "minReplicas": parameter.min
  40.                     "maxReplicas": parameter.max
  42.                 })
  44.             }
  46.         }
  48.         parameter: {
  50.             min: *1 | int
  52.             max: *3 | int
  54.         }

增加 Pod 环境变量

给 Pod 去注入环境变量也是非常常见的操作。

这种使用方式依赖策略补丁而生效, 所以记得加上 +patchKey=name

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "add env into your pods"
  11.   name: env
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {
  29.             spec: template: spec: {
  31.                 // +patchKey=name
  33.                 containers: [{
  35.                     name: context.name
  37.                     // +patchKey=name
  39.                     env: [
  41.                         for k, v in parameter.env {
  43.                             name:  k
  45.                             value: v
  47.                         },
  49.                     ]
  51.                 }]
  53.             }
  55.         }
  60.         parameter: {
  62.             env: [string]: string
  64.         }

基于外部鉴权服务注入 ServiceAccount

在这个场景下，service-account 是从一个鉴权服务中动态获取、再通过打补丁给到应用的。

我们这里展示的是，将 UID token 放进 HTTP header 的例子。你也可以用 HTTP body 来完成需求。

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "dynamically specify service account"
  11.   name: service-account
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         processing: {
  29.             output: {
  31.                 credentials?: string
  33.             }
  35.             http: {
  37.                 method: *"GET" | string
  39.                 url:    parameter.serviceURL
  41.                 request: {
  43.                     header: {
  45.                         "authorization.token": parameter.uidtoken
  47.                     }
  49.                 }
  51.             }
  53.         }
  55.         patch: {
  57.             spec: template: spec: serviceAccountName: processing.output.credentials
  59.         }
  64.         parameter: {
  66.             uidtoken:   string
  68.             serviceURL: string
  70.         }

增加 InitContainer

InitContainer 常用于预定义镜像内的操作，并且在承载应用的容器运行前就跑起来。

看看示例:

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: TraitDefinition
  5. metadata:
  7.   annotations:
  9.     definition.oam.dev/description: "add an init container and use shared volume with pod"
  11.   name: init-container
  13. spec:
  15.   appliesToWorkloads:
  17.     - deployments.apps
  19.   podDisruptive: true
  21.   schematic:
  23.     cue:
  25.       template: |
  27.         patch: {
  29.             spec: template: spec: {
  31.                 // +patchKey=name
  33.                 containers: [{
  35.                     name: context.name
  37.                     // +patchKey=name
  39.                     volumeMounts: [{
  41.                         name:      parameter.mountName
  43.                         mountPath: parameter.appMountPath
  45.                     }]
  47.                 }]
  49.                 initContainers: [{
  51.                     name:  parameter.name
  53.                     image: parameter.image
  55.                     if parameter.command != _|_ {
  57.                         command: parameter.command
  59.                     }
  64.                     // +patchKey=name
  66.                     volumeMounts: [{
  68.                         name:      parameter.mountName
  70.                         mountPath: parameter.initMountPath
  72.                     }]
  74.                 }]
  76.                 // +patchKey=name
  78.                 volumes: [{
  80.                     name: parameter.mountName
  82.                     emptyDir: {}
  84.                 }]
  86.             }
  88.         }
  93.         parameter: {
  95.             name:  string
  97.             image: string
  99.             command?: [...string]
  101.             mountName:     *"workdir" | string
  103.             appMountPath:  string
  105.             initMountPath: string
  107.         }

用法像这样:

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. metadata:
  7.   name: testapp
  9. spec:
  11.   components:
  13.     - name: express-server
  15.       type: webservice
  17.       properties:
  19.         image: oamdev/testapp:v1
  21.       traits:
  23.         - type: "init-container"
  25.           properties:
  27.             name:  "install-container"
  29.             image: "busybox"
  31.             command:
  33.             - wget
  35.             - "-O"
  37.             - "/work-dir/index.html"
  39.             - http://info.cern.ch
  41.             mountName: "workdir"
  43.             appMountPath:  "/usr/share/nginx/html"
  45.             initMountPath: "/work-dir"