内置运维特征列表

为 pod 添加 affinity 和 toleration，它遵循路径“spec.template”中的 pod 规范。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

参数说明 (affinity)

podAffinity (affinity)

required (affinity)

labelSelector (affinity)

matchExpressions (affinity)

namespaceSelector (affinity)

matchExpressions (affinity)

preferred (affinity)

podAffinityTerm (affinity)

labelSelector (affinity)

matchExpressions (affinity)

namespaceSelector (affinity)

matchExpressions (affinity)

podAntiAffinity (affinity)

required (affinity)

labelSelector (affinity)

matchExpressions (affinity)

namespaceSelector (affinity)

matchExpressions (affinity)

preferred (affinity)

podAffinityTerm (affinity)

labelSelector (affinity)

matchExpressions (affinity)

namespaceSelector (affinity)

matchExpressions (affinity)

nodeAffinity (affinity)

required (affinity)

nodeSelectorTerms (affinity)

matchExpressions (affinity)

matchFields (affinity)

preferred (affinity)

preference (affinity)

matchExpressions (affinity)

matchFields (affinity)

tolerations (affinity)

Annotations

描述

Add annotations on your workload. if it generates pod, add same annotations for generated pods。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

所有组件类型。

示例 (annotations)

参数说明 (annotations)

Command

描述

为 pod 添加命令，它遵循路径“spec.template”中的 pod 规范。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (command)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: busybox
spec:
  components:
    - name: busybox
      type: webservice
      properties:
        image: busybox
        cmd: ["sleep", "86400"]
      traits:
        - type: sidecar
          properties:
            name: sidecar-nginx
        - type: command
          properties:
            # you can use command to control multiple containers by filling `containers`
            # NOTE: in containers, you must set the container name for each container
            containers:
              - containerName: busybox
                command: ["sleep", "8640000"]
              - containerName: sidecar-nginx
                args: ["-q"]

参数说明 (command)

Container-Image

描述

Set the image of the container。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (container-image)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: busybox
spec:
  components:
    - name: busybox
      type: webservice
      properties:
        image: busybox
        cmd: ["sleep", "86400"]
      traits:
        - type: sidecar
          properties:
            name: sidecar-nginx
            image: nginx
        - type: container-image
          properties:
            # you can use container-image to control multiple containers by filling `containers`
            # NOTE: in containers, you must set the container name for each container
            containers:
              - containerName: busybox
                image: busybox-1.34.0
                imagePullPolicy: IfNotPresent
              - containerName: sidecar-nginx
                image: nginx-1.20

参数说明 (container-image)

Cpuscaler

描述

Automatically scale the component based on CPU usage。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps

示例 (cpuscaler)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: website
spec:
  components:
    - name: frontend
      type: webservice
      properties:
        image: nginx
      traits:
        - type: cpuscaler
          properties:
            min: 1
            max: 10
            cpuPercent: 60

参数说明 (cpuscaler)

Env

描述

Add env on K8s pod for your workload which follows the pod spec in path ‘spec.template’。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (env)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: busybox
spec:
  components:
    - name: busybox
      type: webservice
      properties:
        image: busybox
        cmd: ["sleep", "86400"]
      traits:
        - type: sidecar
          properties:
            name: sidecar-nginx
            image: nginx
        - type: env
          properties:
            # you can use env to control multiple containers by filling `containers`
            # NOTE: in containers, you must set the container name for each container
            containers:
              - containerName: busybox
                env:
                  key_for_busybox_first: value_first
                  key_for_busybox_second: value_second
              - containerName: sidecar-nginx
                env:
                  key_for_nginx_first: value_first
                  key_for_nginx_second: value_second

参数说明 (env)

Expose

描述

为组件暴露端口，以便能够通过 web 进行访问。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps

示例 (expose)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: test-app
spec:
  components:
    - name: hello-world
      type: webservice
      properties:
        image: crccheck/hello-world
      traits:
        - type: expose
          properties:
            port: [8000]

参数说明 (expose)

描述

为组件启用公网访问，使用 K8s v1.20+ 的 Ingress API。

• deployments.apps
• statefulsets.apps

示例 (gateway)

# vela-app.yaml
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: gateway
          properties:
            domain: testsvc.example.com
            http:
              "/": 8000

参数说明 (gateway)

Hostalias

描述

Add host aliases on K8s pod for your workload which follows the pod spec in path ‘spec.template’。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (hostalias)

参数说明 (hostalias)

hostAliases (hostalias)

Import-Grafana-Dashboard

描述

导入 Grafana 仪表盘。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

参数说明 (import-grafana-dashboard)

Init-Container

描述

为 pod 添加初始化容器，并使用共享卷。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (init-container)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: busybox
spec:
  components:
    - name: busybox
      type: webservice
      properties:
        image: busybox
        cmd: ["sleep", "86400"]
        - type: init-container
          properties:
            name: init-busybox
            image: busybox
            cmd: ["echo", "hello"]
            initMountPath: /data
            appMountPath: /data-initialized

参数说明 (init-container)

env (init-container)

valueFrom (init-container)

secretKeyRef (init-container)

configMapKeyRef (init-container)

extraVolumeMounts (init-container)

Json-Merge-Patch

描述

使用 JSON Merge Patch 策略，遵循 RFC 7396。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

所有组件类型。

参数说明 (json-merge-patch)

Json-Patch

描述

使用 JSON Patch 策略，遵循 RFC 6902。

适用于组件类型

所有组件类型。

参数说明 (json-patch)

operations (json-patch)

Labels

描述

Add labels on your workload. if it generates pod, add same label for generated pods。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

所有组件类型。

示例 (labels)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: myapp
spec:
  components:
    - name: express-server
      type: webservice
      properties:
        image: crccheck/hello-world
        port: 8000
      traits:
        - type: labels
          properties:
            "release": "stable"
        - type: annotations
          properties:
            "description": "web application"

参数说明 (labels)

描述

为 pod 添加生命周期钩子，它遵循路径“spec.template”中的 pod 规范。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (lifecycle)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: application-with-lifecycle
spec:
  components:
    - name: busybox-runner
      type: worker
      properties:
        image: busybox
        cmd:
          - sleep
          - '1000'
      traits:
        - type: lifecycle
          properties:
            postStart:
              exec:
                command:
                  - echo
                  - 'hello world'
            preStop:
              httpGet:
                host: "www.aliyun.com"
                scheme: "HTTPS"
                port: 443

参数说明 (lifecycle)

postStart (lifecycle)

exec (lifecycle)

httpGet (lifecycle)

httpHeaders (lifecycle)

tcpSocket (lifecycle)

preStop (lifecycle)

exec (lifecycle)

httpGet (lifecycle)

httpHeaders (lifecycle)

tcpSocket (lifecycle)

Nocalhost

使用 nocalhost 作为开发环境的配置。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (nocalhost)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: bookinfo
spec:
  components:
    - name: productpage
      type: webservice
      properties:
        image: nocalhost-docker.pkg.coding.net/nocalhost/bookinfo/productpage:latest
        port: 9080
      traits:
        - type: nocalhost
          properties:
            port: 9080
            gitUrl: https://github.com/nocalhost/bookinfo-productpage.git
            image: nocalhost-docker.pkg.coding.net/nocalhost/dev-images/python:3.7.7-slim-productpage-with-pydevd
            shell: "bash"
            workDir: "/opt/work"
              limits:
                memory: 1Gi
                cpu: "1"
              requests:
                memory: 512Mi
                cpu: "0.5"
            debug:
              remoteDebugPort: 9009
            hotReload: true
            sync:
              type: send
              filePattern:
                - ./
              ignoreFilePattern:
                - .git
                - .idea
            command:
              run:
                - sh
                - run.sh
              debug:
                - sh
                - debug.sh
            env:
              - name: "foo"
                value: "bar"
            portForward:
              - 39080:9080

参数说明 (nocalhost)

env (nocalhost)

resources (nocalhost)

limits (nocalhost)

requests (nocalhost)

persistentVolumeDirs (nocalhost)

command (nocalhost)

debug (nocalhost)

sync (nocalhost)

Resource

描述

为 pod 添加资源请求和限制，它遵循路径“spec.template”中的 pod 规范。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (resource)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: resource-app
spec:
  components:
    - name: express-server
      type: webservice
      properties:
        image: crccheck/hello-world
        ports:
          - port: 8000
      traits:
        - type: resource
          properties:
            cpu: 2
            memory: 2Gi
            requests:
              cpu: 2
              memory: 2Gi
            limits:
              cpu: 4
              memory: 4Gi

参数说明 (resource)

requests (resource)

limits (resource)

Scaler

描述

调整 pod 的副本数，它遵循路径“spec.template”中的 pod 规范。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps

示例 (scaler)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: website
spec:
  components:
    - name: frontend
      type: webservice
      properties:
        image: nginx
      traits:
        - type: scaler
          properties:
            replicas: 2
        - type: sidecar
          properties:
            name: "sidecar-test"
            image: "fluentd"
    - name: backend
      type: worker
      properties:
        image: busybox
          - sleep
          - '1000'

参数说明 (scaler)

Service-Account

描述

为 pod 指定 serviceAccount，它遵循路径“spec.template”中的 pod 规范。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (service-account)

参数说明 (service-account)

privileges (service-account)

Service-Binding

描述

绑定云资源的密钥到组件环境变量中，该定义已废弃，请使用 ‘storage’ 定义。

目前这个运维特征默认在 VelaUX 处隐藏，你可以在 CLI 侧使用。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (service-binding)

1. Prepare a Kubernetes Secret

The secret can be manually created, or generated by other component or external system.

For example, we have a secret db-conn-example whose data is as below:

endpoint: https://xxx.com
password: 123
username: myname

1. Bind the Secret into your component by service-binding trait

For example, we have a webservice component who needs to consume a database. The database connection string should be set to Pod environments: endpoint, username and DB_PASSWORD.

We can set the properties for envMappings as below. For each environment, secret represents the secret name, and key represents the key of the secret.

Here is the complete properties for the trait.

traits:
- type: service-binding
  properties:
    envMappings:
      DB_PASSWORD:
        secret: db-conn-example
        key: password            
      endpoint:
        secret: db-conn-example
        key: endpoint
      username:
        secret: db-conn-example
        key: username

In particular, if the environment name, like endpoint, is same to the key of the secret, we can omit the key. So we can simplify the properties as below.

traits:
- type: service-binding
  properties:
    envMappings:
      DB_PASSWORD:
        secret: db-conn-example
        key: password            
      endpoint:
        secret: db-conn-example
      username:
        secret: db-conn-example

We can finally prepare an Application for the business component binding-test-comp to consume the secret, which is a representative of a database cloud resource.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: webapp
spec:
  components:
    - name: binding-test-comp
      type: webservice
      properties:
        image: zzxwill/flask-web-application:v0.3.1-crossplane
        ports: 80
      traits:
        - type: service-binding
          properties:
            envMappings:
              # environments refer to db-conn secret
              DB_PASSWORD:
                secret: db-conn-example
                key: password            
              endpoint:
                secret: db-conn-example
              username:
                secret: db-conn-example

Deploy this YAML and the Secret db-conn-example will be binding into environment of workload.

参数说明 (service-binding)

Sidecar

描述

为 pod 添加 sidecar 容器，它遵循路径“spec.template”中的 pod 规范。

适用于组件类型

基于以下资源的组件：

示例 (sidecar)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: vela-app-with-sidecar
spec:
  components:
    - name: log-gen-worker
      type: worker
      properties:
        image: busybox
        cmd:
          - /bin/sh
          - -c
          - >
            i=0;
            while true;
            do
              echo "$i: $(date)" >> /var/log/date.log;
              i=$((i+1));
              sleep 1;
            done
        volumes:
          - name: varlog
            mountPath: /var/log
            type: emptyDir
      traits:
        - type: sidecar
          properties:
            name: count-log
            image: busybox
            cmd: [ /bin/sh, -c, 'tail -n+1 -f /var/log/date.log']
            volumes:
              - name: varlog
                path: /var/log

参数说明 (sidecar)

env (sidecar)

valueFrom (sidecar)

secretKeyRef (sidecar)

configMapKeyRef (sidecar)

fieldRef (sidecar)

volumes (sidecar)

livenessProbe (sidecar)

exec (sidecar)

httpGet (sidecar)

httpHeaders (sidecar)

tcpSocket (sidecar)

readinessProbe (sidecar)

exec (sidecar)

httpGet (sidecar)

httpHeaders (sidecar)

tcpSocket (sidecar)

描述

Add storages on K8s pod for your workload which follows the pod spec in path ‘spec.template’。

适用于组件类型

基于以下资源的组件：

• deployments.apps
• statefulsets.apps
• daemonsets.apps
• jobs.batch

示例 (storage)

# sample.yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
  name: storage-app
spec:
  components:
    - name: express-server
      type: webservice
      properties:
        image: oamdev/hello-world
        ports:
          - port: 8000
      traits:
        - type: storage
          properties:
            # PVC type storage
            pvc:
              - name: test1
                mountPath: /test/mount/pvc
            # EmptyDir type storage
            emptyDir:
              - name: test1
                mountPath: /test/mount/emptydir
            # ConfigMap type storage
            configMap:
              - name: test1
                mountPath: /test/mount/cm
                # Mount ConfigMap to Env
                mountToEnv:
                  envName: TEST_ENV
                  configMapKey: key1
                data:
                  key1: value1
                  key2: value2
            # Secret type storage
            secret:
              - name: test1
                mountPath: /test/mount/secret
                # Mount Secret to Env
                mountToEnv:
                  envName: TEST_SECRET
                  secretKey: key1
                data:
                  key2: dmFsdWUy

参数说明 (storage)

pvc (storage)

resources (storage)

requests (storage)

limits (storage)

dataSourceRef (storage)

dataSource (storage)

selector (storage)

matchExpressions (storage)

configMap (storage)

items (storage)

mountToEnv (storage)

mountToEnvs (storage)

secret (storage)

items (storage)

mountToEnv (storage)

mountToEnvs (storage)

emptyDir (storage)