Skip to content
Weik.ioUniversity
Try Weik.io

How the YAML files look

Getting started 4 · 3:08

An integration's folder has several YAML files, from Camel's route file to Weik.io's deployment documents, and each has its own shape. The video goes through keys, indentation, lists and comments, and weikio validate finds a misspelled field before anything reaches the hub.

Download the mp4Recorded on 2026.2

What it covers

  • The folder of files that weikio init hello writes
  • Keys, indentation and list dashes in the route file hello.camel.yaml
  • Comments in integration.yaml that show the fields it may declare
  • How Camel's route file, the flat integration.yaml and Weik.io's documents differ
  • apiVersion, kind, metadata and spec in a deployment document
  • A misspelled field caught by weikio validate, with its file and line

Commands in this video

Terminal
$ weikio init hello
$ weikio validate -f ./hello
$ weikio validate -f .
Transcript
  1. 0:01This video reads the YAML files in an integration's folder.
  2. 0:05Files are text you can read and keep in Git.
  3. 0:09Your working folder is empty.
  4. 0:11The Weik.io CLI is signed in with its context.
  5. 0:14The context line runs to the hub.
  6. 0:21The command weikio init hello writes a folder of files.
  7. 0:25The answer lists the three files it wrote.
  8. 0:28The next line names the project and the environment from the context.
  9. 0:36The panel shows hello.camel.yaml, where id and hello are one key and its value.
  10. 0:43A key holds more keys indented under it. Indentation is the structure.
  11. 0:49A dash starts each item of a list, here the two steps of the route.
  12. 0:57The panel shows integration.yaml with its name line.
  13. 1:01A hash starts a comment, a line the tools do not read.
  14. 1:05Each comment shows a field the file may declare.
  15. 1:11The third file is not YAML.
  16. 1:13One line holds a key, an equals sign and a value.
  17. 1:21The route file is Camel's own YAML. The platform runs it as Camel does.
  18. 1:27integration.yaml is optional, and it is the flat form.
  19. 1:31A document describes one thing the hub store keeps.
  20. 1:34Document files can hold several documents.
  21. 1:39application.properties is none of these three shapes.
  22. 1:47Deployment documents start with apiVersion, kind, metadata and spec.
  23. 1:53The kind reads deployment, in lower case.
  24. 1:57metadata names the integration, spec gives the version.
  25. 2:04The panel shows three lines of integration.yaml.
  26. 2:08An edit uncommented the version field on line 3 and misspelled its name.
  27. 2:13The command weikio validate checks the folder hello.
  28. 2:18The finding names the file, the line and the field.
  29. 2:21The check reads each file before anything reaches the hub store.
  30. 2:27Correct the field name to version, and the panel shows the fixed file.
  31. 2:32The same command now checks the whole working folder.
  32. 2:35The answer counts one document and one integration and finds nothing to fix.
  33. 2:40A checked outline stands around both folder boxes.
  34. 2:47The route file is Camel's own YAML.
  35. 2:50integration.yaml is optional, in the flat form.
  36. 2:54A document describes one thing the hub store keeps.
  37. 2:58The check found nothing to fix.