Version: v1.1

Dry Run

Dry run will help you to understand what are the real resources which will to be expanded and deployed to the Kubernetes cluster. In other words, it will mock to run the same logic as KubeVela’s controller and output the results locally.

For example, let’s dry-run the following application:

  1. # app.yaml
  2. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  4. metadata:
  5.   name: vela-app
  6. spec:
  7.   components:
  8.     - name: express-server
  9.       type: webservice
  10.       properties:
  11.         image: crccheck/hello-world
  12.         port: 8000
  13.       traits:
  14.         - type: ingress
  15.           properties:
  16.             domain: testsvc.example.com
  17.             http:
  18.               "/": 8000
  1. vela dry-run -f app.yaml
  2. ---
  3. # Application(vela-app) -- Comopnent(express-server)
  4. ---
  7. apiVersion: apps/v1
  8. kind: Deployment
  9. metadata:
  10.   labels:
  11.     app.oam.dev/appRevision: ""
  12.     app.oam.dev/component: express-server
  13.     app.oam.dev/name: vela-app
  14.     workload.oam.dev/type: webservice
  15. spec:
  16.   selector:
  17.     matchLabels:
  18.       app.oam.dev/component: express-server
  19.   template:
  20.     metadata:
  21.       labels:
  22.         app.oam.dev/component: express-server
  23.     spec:
  24.       containers:
  25.       - image: crccheck/hello-world
  26.         name: express-server
  27.         ports:
  28.         - containerPort: 8000
  31. ---
  32. apiVersion: v1
  33. kind: Service
  34. metadata:
  35.   labels:
  36.     app.oam.dev/appRevision: ""
  37.     app.oam.dev/component: express-server
  38.     app.oam.dev/name: vela-app
  39.     trait.oam.dev/resource: service
  40.     trait.oam.dev/type: ingress
  41.   name: express-server
  42. spec:
  43.   ports:
  44.   - port: 8000
  45.     targetPort: 8000
  46.   selector:
  47.     app.oam.dev/component: express-server
  50. ---
  51. apiVersion: networking.k8s.io/v1beta1
  52. kind: Ingress
  53. metadata:
  54.   labels:
  55.     app.oam.dev/appRevision: ""
  56.     app.oam.dev/component: express-server
  57.     app.oam.dev/name: vela-app
  58.     trait.oam.dev/resource: ingress
  59.     trait.oam.dev/type: ingress
  60.   name: express-server
  61. spec:
  62.   rules:
  63.   - host: testsvc.example.com
  64.     http:
  65.       paths:
  66.       - backend:
  67.           serviceName: express-server
  68.           servicePort: 8000
  69.         path: /
  72. ---

In this example, the definitions(webservice and ingress) which vela-app depends on are the built-in components and traits of KubeVela. You can also use -d or --definitions to specify your local definition files.

-d or --definitions permits users to provide capability definitions used in the application from local files. dry-run cmd will prioritize the provided capabilities than the living ones in the cluster.