As omnifests can become quite large here are some best practices to organise. We are trying to provide examples in our repository that adhere to these.
Since otk can produce outputs for different image build tools our best practices are organised.
Some best practices that apply to omnifest files in general.
Keep variable definitions in the entrypoint as much as possible. This gives a single unified place to read which variables affect the build.
When an osbuild target is defined it is a good plan to follow these specific practices.
otk makes it easy to inline or include files. This makes it appealing to use it for configuration files. It is however generally a better idea to use a domain specific stage to write these sorts of files.
Using a stage to write configuration files comes with the benefit that the inputs can be verified at validation or build time. This allows osbuild to try and guarantee that the configuration file will work.