Manage X-Definition

    In KubeVela CLI (>= v1.1.0), command group provides a series of convenient definition writing tools. With these commands, users only need to write CUE files to generate and edit definitions, instead of composing Kubernetes YAML object with mixed CUE string.

    vela def init is a command that helps users bootstrap new definitions. To create an empty trait definition, run vela def init my-trait -t trait --desc "My trait description."

    Or you can use vela def init my-comp --interactive to initiate definitions interactively.

    1. $ vela def init my-comp --interactive
    3. Please choose one definition type from the following values: component, trait, policy, workload, scope, workflow-step
    5. > Definition type: component
    7. > Definition description: My component definition.
    9. Please enter the location the template YAML file to build definition. Leave it empty to generate default template.
    11. > Definition template filename: 
    13. Please enter the output location of the generated definition. Leave it empty to print definition to stdout.
    15. > Definition output filename: my-component.cue
    17. Definition written to my-component.cue
    1. apiVersion: apps/v1
    3. kind: Deployment
    5. metadata:
    7.   name: hello-world
    9. spec:
    11.   replicas: 1
    13.   selector:
    15.     matchLabels:
    17.       app.kubernetes.io/name: hello-world
    19.   template:
    21.     metadata:
    23.       labels:
    25.         app.kubernetes.io/name: hello-world
    27.     spec:
    29.       containers:
    31.       - name: hello-world
    33.         image: somefive/hello-world
    35.         ports: 
    37.         - name: http
    39.           containerPort: 80
    41.           protocol: TCP
    43. ---
    45. apiVersion: v1
    47. kind: Service
    49. metadata:
    50.   name: hello-world-service
    52. spec:
    54.   selector:
    56.     app: hello-world
    58.   ports:
    60.   - name: http
    62.     protocol: TCP
    64.     port: 80
    66.     targetPort: 8080
    68.   type: LoadBalancer

    Running vela def init my-comp -t component --desc "My component." --template-yaml ./my-deployment.yaml to get the CUE-format ComponentDefinition

    Then the user can make further modifications based on the definition file above, like removing \<change me> in workload.definition。

    After initializing definition files, run vela def vet my-comp.cue to validate if there are any syntax error in the definition file. It can be used to detect some simple errors such as missing brackets.

    1. $ vela def vet my-comp.cue
    3. Validation succeed.
    1. apiVersion: core.oam.dev/v1beta1
    3. kind: ComponentDefinition
    5. metadata:
    7.   annotations:
    9.     definition.oam.dev/description: My component.
    11.   labels: {}
    13.   name: my-comp
    15.   namespace: vela-system
    17. spec:
    19.   schematic:
    21.     cue:
    23.       template: |
    25.         output: {
    27.                 metadata: name: "hello-world"
    29.                 spec: {
    31.                         replicas: 1
    33.                         selector: matchLabels: "app.kubernetes.io/name": "hello-world"
    35.                         template: {
    37.                                 metadata: labels: "app.kubernetes.io/name": "hello-world"
    39.                                 spec: containers: [{
    41.                                         name:  "hello-world"
    43.                                         image: "somefive/hello-world"
    45.                                         ports: [{
    47.                                                 name:          "http"
    52.                                         }]
    54.                                 }]
    56.                         }
    58.                 }
    60.                 apiVersion: "apps/v11"
    62.                 kind:       "Deployment"
    64.         }
    66.         outputs: "hello-world-service": {
    68.                 metadata: name: "hello-world-service"
    70.                 spec: {
    72.                         ports: [{
    74.                                 name:       "http"
    76.                                 protocol:   "TCP"
    78.                                 port:       80
    80.                                 targetPort: 8080
    82.                         }]
    84.                         selector: app: "hello-world"
    86.                         type: "LoadBalancer"
    88.                 }
    90.                 apiVersion: "v1"
    92.                 kind:       "Service"
    94.         }
    96.         parameter: {}
    98.   workload:
    100.     definition:
    102.       apiVersion: apps/v1
    104.       kind: Deployment

    While you can use native kubectl tools to confirm the results of the apply command, as mentioned above, the YAML object mixed with raw CUE template string is complex. Using vela def get will automatically convert the YAML object into the CUE-format definition.

    1. $ vela def get my-comp -t component

    Or you can list all defintions installed through vela def list

    1. $ vela def list -n my-namespace -t component
    3. NAME                    TYPE                    NAMESPACE       DESCRIPTION  
    5. my-comp                 ComponentDefinition     my-namespace    My component.

    Similarly, using vela def edit to edit definitions in pure CUE-format. The transformation between CUE-format definition and YAML object is done by the command. Besides, you can specify the EDITOR environment variable to use your favourate editor.

    1. $ vela def del my-comp -n my-namespace  
    3. Are you sure to delete the following definition in namespace my-namespace?
    5. ComponentDefinition my-comp: My component.
    7. [yes|no] > yes