版本：v1.9

内置策略列表

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

本文档由脚本自动生成，请勿手动修改，上次更新于 2023-07-28T09:33:26+08:00。

Apply-Once

描述

只交付部署资源，不保证终态一致、允许配置漂移。适用于与其他控制器协作的轻量级交付场景。

示例 (apply-once)

It's generally used in one time delivery only without continuous management scenario.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: apply-once-app
spec:
  components:
    - name: hello-world
      type: webservice
      properties:
        image: oamdev/hello-world
      traits:
        - type: scaler
          properties:
            replicas: 1
  policies:
    - name: apply-once
      type: apply-once
      properties:
        enable: true

参数说明 (apply-once)

名称	描述	类型	是否必须	默认值
enable	当设置为 true 时，表示只交付部署、不保证终态一致、允许配置漂移。	bool	false	false
rules	指定交付一次的资源规则。	[]rules	false

rules (apply-once)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	false
strategy	Specify the strategy for configuring the resource level configuration drift behaviour。	strategy	true

selector (apply-once)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

strategy (apply-once)

名称	描述	类型	是否必须	默认值
affect	When the strategy takes effect,e.g. onUpdate、onStateKeep。	string	false
path	指定资源的路径。	[]string	true

Garbage-Collect

描述

为应用配置资源回收策略。如配置资源不回收。

示例 (garbage-collect)

It's used in garbage collection scenario. It can be used to configure the collection policy, e.g. don't delete the legacy resources when updating.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: first-vela-app
spec:
  components:
    - name: express-server
      type: webservice
      properties:
        image: oamdev/hello-world
        port: 8000
      traits:
        - type: ingress-1-20
          properties:
            domain: testsvc.example.com
            http:
              "/": 8000
  policies:
    - name: keep-legacy-resource
      type: garbage-collect
      properties:
        keepLegacyResource: true

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: garbage-collect-app
spec:
  components:
    - name: hello-world-new
      type: webservice
      properties:
        image: oamdev/hello-world
      traits:
        - type: expose
          properties:
            port: [8000]
  policies:
    - name: garbage-collect
      type: garbage-collect
      properties:
        rules:
          - selector:
              traitTypes:
                - expose
            strategy: onAppDelete

参数说明 (garbage-collect)

名称	描述	类型	是否必须	默认值
applicationRevisionLimit	If set, it will override the default revision limit number and customize this number for the current application。	int	false
keepLegacyResource	如果为 true，过时的版本化 resource tracker 将不会自动回收。过时的资源将被保留，直到手动删除 resource tracker。	bool	false	false
continueOnFailure	If is set, continue to execute gc when the workflow fails, by default gc will be executed only after the workflow succeeds。	bool	false	false
rules	在资源级别控制垃圾回收策略的规则列表，如果一个资源由多个规则控制，将使用第一个规则。	[]rules	false

rules (garbage-collect)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	true
strategy	目标资源循环利用的策略。可用值：never、onAppDelete、onAppUpdate。	"onAppUpdate" or "onAppDelete" or "never"	false	onAppUpdate
propagation	Specify the deletion propagation strategy for target resource to delete。	"orphan" or "cascading"	false

selector (garbage-collect)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

Override

描述

描述部署资源时要覆盖的配置，需要配合工作流的 deploy 步骤一起使用才能生效。

示例 (override)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: deploy-with-override
  namespace: examples
spec:
  components:
    - name: nginx-with-override
      type: webservice
      properties:
        image: nginx
  policies:
    - name: topology-hangzhou-clusters
      type: topology
      properties:
        clusterLabelSelector:
          region: hangzhou
    - name: topology-local
      type: topology
      properties:
        clusters: ["local"]
        namespace: examples-alternative
    - name: override-nginx-legacy-image
      type: override
      properties:
        components:
          - name: nginx-with-override
            properties:
              image: nginx:1.20
    - name: override-high-availability
      type: override
      properties:
        components:
          - type: webservice
            traits:
              - type: scaler
                properties:
                  replicas: 3
  workflow:
    steps:
      - type: deploy
        name: deploy-local
        properties:
          policies: ["topology-local"]
      - type: deploy
        name: deploy-hangzhou
        properties:
          policies: ["topology-hangzhou-clusters", "override-nginx-legacy-image", "override-high-availability"]

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: advance-override
  namespace: examples
spec:
  components:
    - name: nginx-advance-override-legacy
      type: webservice
      properties:
        image: nginx:1.20
    - name: nginx-advance-override-latest
      type: webservice
      properties:
        image: nginx
  policies:
    - name: topology-hangzhou-clusters
      type: topology
      properties:
        clusterLabelSelector:
          region: hangzhou
    - name: topology-local
      type: topology
      properties:
        clusters: ["local"]
        namespace: examples-alternative
    - name: override-nginx-legacy
      type: override
      properties:
        selector: ["nginx-advance-override-legacy"]
    - name: override-nginx-latest
      type: override
      properties:
        selector: ["nginx-advance-override-latest", "nginx-advance-override-stable"]
        components:
          - name: nginx-advance-override-stable
            type: webservice
            properties:
              image: nginx:stable
  workflow:
    steps:
      - type: deploy
        name: deploy-local
        properties:
          policies: ["topology-local", "override-nginx-legacy"]
      - type: deploy
        name: deploy-hangzhou
        properties:
          policies: ["topology-hangzhou-clusters", "override-nginx-latest"]

参数说明 (override)

名称	描述	类型	是否必须	默认值
components	要覆盖的组件配置列表。	[]components	true
selector	要使用的组件名称列表。如果未设置，将使用所有组件。	[]string	false

components (override)

名称	描述	类型	是否必须
name	要覆盖的组件的名称。如果未设置，它将匹配具有指定类型的所有组件。可以与通配符 * 一起使用以进行模糊匹配。。	string	false
type	要覆盖的组件的类型。如果未设置，将匹配所有组件类型。	string	false
properties	要覆盖的配置属性，未填写配置会与原先的配置合并。	map[string]_	false
traits	要覆盖的 trait 配置列表。	[]traits	false

traits (override)

名称	描述	类型	是否必须	默认值
type	要做参数覆盖的 trait 类型。	string	true
properties	要覆盖的配置属性，未填写配置会与原先的配置合并。	map[string]_	false
disable	如果为 true，该 trait 将被删除，默认 false。	bool	false	false

Read-Only

描述

Configure the resources to be read-only in the application (no update / state-keep)。

示例 (read-only)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: read-only
spec:
  components:
    - name: busybox
      type: worker
      properties:
        image: busybox
        cmd:
          - sleep
          - '1000000'
  policies:
    - type: read-only
      name: read-only
      properties:
        rules:
          - selector:
              resourceTypes: ["Deployment"]

参数说明 (read-only)

名称	描述	类型	是否必须	默认值
rules	Specify the list of rules to control read only strategy at resource level。	[]rules	false

rules (read-only)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	true

selector (read-only)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

Replication

描述

Describe the configuration to replicate components when deploying resources, it only works with specified deploy step in workflow。

示例 (replication)

Background

In KubeVela, we can dispatch resources across the clusters. But projects like OpenYurt have finer-grained division like node pool. This requires to dispatch some similar resources to the same cluster. These resources are called replication. Back to the example of OpenYurt, it can integrate KubeVela and replicate the resources then dispatch them to the different node pool.

Usage

Replication is an internal policy. It can be only used with deploy workflow step. When using replication policy. A new field replicaKey will be added to context. User can use definitions that make use of context.replicaKey. For example, apply a replica-webservice ComponentDefinition.

In this ComponentDefinition, we can use context.replicaKey to distinguish the name of Deployment and Service.

NOTE: ComponentDefinition below is trimmed for brevity. See complete YAML in replication.yaml

apiVersion: core.oam.dev/v1beta1
kind: ComponentDefinition
metadata:
  annotations:
    definition.oam.dev/description: Webservice, but can be replicated
  name: replica-webservice
  namespace: vela-system
spec:
  workload:
    type: autodetects.core.oam.dev
  schematic:
    cue:
      template: |
        output: {
            apiVersion: "apps/v1"
            kind:       "Deployment"
            metadata: {
                if context.replicaKey != _|_ {
                    name: context.name + "-" + context.replicaKey
                }
                if context.replicaKey == _|_ {
                    name: context.name
                }
            }
            spec: {
                selector: matchLabels: {
                    "app.oam.dev/component": context.name
                    if context.replicaKey != _|_ {
                        "app.oam.dev/replicaKey": context.replicaKey
                    }
                }

                template: {
                    metadata: {
                        labels: {
                            if parameter.labels != _|_ {
                                parameter.labels
                            }
                            if parameter.addRevisionLabel {
                                "app.oam.dev/revision": context.revision
                            }
                            "app.oam.dev/name":      context.appName
                            "app.oam.dev/component": context.name
                            if context.replicaKey != _|_ {
                                "app.oam.dev/replicaKey": context.replicaKey
                            }

                        }
                        if parameter.annotations != _|_ {
                            annotations: parameter.annotations
                        }
                    }
                }
            }
        }
        outputs: {
            if len(exposePorts) != 0 {
                webserviceExpose: {
                    apiVersion: "v1"
                    kind:       "Service"
                    metadata: {
                        if context.replicaKey != _|_ {
                            name: context.name + "-" + context.replicaKey
                        }
                        if context.replicaKey == _|_ {
                            name: context.name
                        }
                    }
                    spec: {
                        selector: {
                            "app.oam.dev/component": context.name
                            if context.replicaKey != _|_ {
                                "app.oam.dev/replicaKey": context.replicaKey
                            }
                        }
                        ports: exposePorts
                        type:  parameter.exposeType
                    }
                }
            }
        }

Then user can apply application below. Replication policy is declared in application.spec.policies. These policies are used in deploy-with-rep workflow step. They work together to influence the deploy step.

override: select hello-rep component to deploy.
topology: select cluster local to deploy.
replication: select hello-rep component to replicate.

As a result, there will be two Deployments and two Services:

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: app-replication-policy
spec:
  components:
    - name: hello-rep
      type: replica-webservice
      properties:
        image: crccheck/hello-world
        ports:
          - port: 80
            expose: true
  policies:
    - name: comp-to-replicate
      type: override
      properties:
        selector: [ "hello-rep" ]
    - name: target-default
      type: topology
      properties:
        clusters: [ "local" ]
    - name: replication-default
      type: replication
      properties:
        keys: ["beijing","hangzhou"]
        selector: ["hello-rep"]

  workflow:
    steps:
      - name: deploy-with-rep
        type: deploy
        properties:
          policies: ["comp-to-replicate","target-default","replication-default"]

kubectl get deploy -n default
NAME                 READY   UP-TO-DATE   AVAILABLE   AGE
hello-rep-beijing    1/1     1            1           5s
hello-rep-hangzhou   1/1     1            1           5s

kubectl get service -n default
NAME                 TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)   AGE
hello-rep-hangzhou   ClusterIP   10.43.23.200   <none>        80/TCP    41s
hello-rep-beijing    ClusterIP   10.43.24.116   <none>        80/TCP    12s

参数说明 (replication)

名称	描述	类型	是否必须	默认值
keys	Spicify the keys of replication. Every key coresponds to a replication components。	[]string	true
selector	Specify the components which will be replicated。	[]string	false

Resource-Update

描述

Configure the update strategy for selected resources。

示例 (resource-update)

resource-update policy can allow users to customize the update behavior for selected resources.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: recreate
spec:
  components:
    - type: k8s-objects
      name: recreate
      properties:
        objects:
          - apiVersion: v1
            kind: Secret
            metadata:
              name: recreate
            data:
              key: dgo=
            immutable: true
  policies:
    - type: resource-update
      name: resource-update
      properties:
        rules:
          - selector:
              resourceTypes: ["Secret"]
            strategy:
              recreateFields: ["data.key"]

By specifying recreateFields, the application will recreate the target resource (Secret here) when the field changes (data.key here). If the field is not changed, the application will use the normal update (patch here).

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: recreate
spec:
  components:
    - type: k8s-objects
      name: recreate
      properties:
        objects:
          - apiVersion: v1
            kind: ConfigMap
            metadata:
              name: recreate
            data:
              key: val
  policies:
    - type: resource-update
      name: resource-update
      properties:
        rules:
          - selector:
              resourceTypes: ["ConfigMap"]
            strategy:
              op: replace

By specifying op to replace, the application will update the given resource (ConfigMap here) by replace. Compared to patch, which leverages three-way merge patch to only modify the fields managed by KubeVela application, "replace" will update the object as a whole and wipe out other fields even if it is not managed by the KubeVela application. It can be seen as an "application-level" ApplyResourceByReplace.

参数说明 (resource-update)

名称	描述	类型	是否必须	默认值
rules	Specify the list of rules to control resource update strategy at resource level。	[]rules	false

rules (resource-update)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	true
strategy	The update strategy for the target resources。	strategy	true

selector (resource-update)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

strategy (resource-update)

名称	描述	类型	是否必须	默认值
op	Specify the op for updating target resources。	"patch" or "replace"	false	patch
recreateFields	Specify which fields would trigger recreation when updated。	[]string	false

Shared-Resource

描述

Configure the resources to be sharable across applications。

示例 (shared-resource)

It's used in shared-resource scenario. It can be used to configure which resources can be shared between applications. The target resource will allow multiple application to read it but only the first one to be able to write it.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: app1
spec:
  components:
    - name: ns1
      type: k8s-objects
      properties:
        objects:
          - apiVersion: v1
            kind: Namespace
            metadata:
              name: example
    - name: cm1
      type: k8s-objects
      properties:
        objects:
          - apiVersion: v1
            kind: ConfigMap
            metadata:
              name: cm1
              namespace: example
            data:
              key: value1
  policies:
    - name: shared-resource
      type: shared-resource
      properties:
        rules:
          - selector:
              resourceTypes: ["Namespace"]

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: app2
spec:
  components:
    - name: ns2
      type: k8s-objects
      properties:
        objects:
          - apiVersion: v1
            kind: Namespace
            metadata:
              name: example
    - name: cm2
      type: k8s-objects
      properties:
        objects:
          - apiVersion: v1
            kind: ConfigMap
            metadata:
              name: cm2
              namespace: example
            data:
              key: value2
  policies:
    - name: shared-resource
      type: shared-resource
      properties:
        rules:
          - selector:
              resourceTypes: ["Namespace"]

参数说明 (shared-resource)

名称	描述	类型	是否必须	默认值
rules	Specify the list of rules to control shared-resource strategy at resource level。	[]rules	false

rules (shared-resource)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	true

selector (shared-resource)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

Take-Over

描述

Configure the resources to be able to take over when it belongs to no application。

示例 (take-over)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: take-over
spec:
  components:
    - name: busybox
      type: k8s-objects
      properties:
        objects:
          - apiVersion: apps/v1
            kind: Deployment
            metadata:
              name: busybox-ref
  policies:
    - type: take-over
      name: take-over
      properties:
        rules:
          - selector:
              resourceTypes: ["Deployment"]

参数说明 (take-over)

名称	描述	类型	是否必须	默认值
rules	Specify the list of rules to control take over strategy at resource level。	[]rules	false

rules (take-over)

名称	描述	类型	是否必须	默认值
selector	指定资源筛选目标规则。	selector	true

selector (take-over)

名称	描述	类型	是否必须
componentNames	按组件名称选择目标资源。	[]string	false
componentTypes	按组件类型选择目标资源。	[]string	false
oamTypes	按 OAM 概念，组件(COMPONENT) 或运维特征(TRAIT) 筛选。	[]string	false
traitTypes	按 trait 类型选择目标资源。	[]string	false
resourceTypes	按资源类型选择。	[]string	false
resourceNames	按资源名称选择。	[]string	false

Topology

描述

描述组件应该部署到的集群环境。

示例 (topology)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: basic-topology
  namespace: examples
spec:
  components:
    - name: nginx-basic
      type: webservice
      properties:
        image: nginx
  policies:
    - name: topology-hangzhou-clusters
      type: topology
      properties:
        clusters: ["hangzhou-1", "hangzhou-2"]

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: label-selector-topology
  namespace: examples
spec:
  components:
    - name: nginx-label-selector
      type: webservice
      properties:
        image: nginx
  policies:
    - name: topology-hangzhou-clusters
      type: topology
      properties:
        clusterLabelSelector:
          region: hangzhou

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: local-ns-topology
  namespace: examples
spec:
  components:
    - name: nginx-local-ns
      type: webservice
      properties:
        image: nginx
  policies:
    - name: topology-local
      type: topology
      properties:
        clusters: ["local"]
        namespace: examples-alternative

参数说明 (topology)

名称	描述	类型	是否必须
clusters	要选择的集群的名称。	[]string	false
clusterLabelSelector	根据集群标签选择。	map[string]string	false
allowEmpty	Ignore empty cluster error。	bool	false
clusterSelector	Deprecated: Use clusterLabelSelector instead。	map[string]string	false
namespace	要在选定集群中部署的目标命名空间。如果未设置，组件将继承原始命名空间。	string	false

Apply-Once​

描述​

示例 (apply-once)​

参数说明 (apply-once)​

rules (apply-once)​

selector (apply-once)​

strategy (apply-once)​

Garbage-Collect​

描述​

示例 (garbage-collect)​

参数说明 (garbage-collect)​

rules (garbage-collect)​

selector (garbage-collect)​

Override​

描述​

示例 (override)​

参数说明 (override)​

components (override)​

traits (override)​

Read-Only​

描述​

示例 (read-only)​

参数说明 (read-only)​

rules (read-only)​

selector (read-only)​

Replication​

描述​

示例 (replication)​

Background​

Usage​

参数说明 (replication)​

Resource-Update​

描述​

示例 (resource-update)​

参数说明 (resource-update)​

rules (resource-update)​

selector (resource-update)​

strategy (resource-update)​

Shared-Resource​

描述​

示例 (shared-resource)​

参数说明 (shared-resource)​

rules (shared-resource)​

selector (shared-resource)​

Take-Over​

描述​

示例 (take-over)​

参数说明 (take-over)​

rules (take-over)​

selector (take-over)​

Topology​

描述​

示例 (topology)​

参数说明 (topology)​