This documentation is for not yet released version of ytt. For the documentation of the latest release version, see the latest version.
ytt vs x
ytt vs Go text/template (and other text templating tools) ¶
Most generic templating tools do not understand content that they are templating and consider it just plain text. ytt operates on YAML structures, hence typical escaping and formatting problems common to text templating tools are eliminated. Additionally, ytt provides a very easy way to make structures reusable in a much more readable way that’s possible with some text templating tools.
ytt vs jsonnet ¶
ytt conceptually is very close to jsonnet. Both operate on data structures instead of text, hence are able to provide a better way to construct, compose and reuse structures. jsonnet introduces a custom language to help perform structure operations. ytt on the other hand, builds upon a Python-like language, which we think will be more familiar to the larger community.
We also believe that transitioning from plain YAML to templated YAML with
ytt is very easy and natural.
ytt vs Dhall ¶
Dhall language is a configuration language that can output YAML, and JSON. One of its strong points is ability to provide scripting environment that is “hermetically sealed” and safe, even against malicious templates.
ytt also embraces same goal (and builds upon the great work of Starlark community) by exposing small API in the template context. For example, there is no way to make network calls, read from file system, or currently, even get time.
ytt vs Kustomize (and CF BOSH ops files) ¶
Configuration customization tools are unique in a sense that they don’t allow templating but rather build upon “base” configuration.
ytt offers its own take on configuration customization via the ‘overlay’ feature. Unlike other tools, overlay operations (remove, replace, merge) in
ytt mimic structure of the base configuration. For example in Kustomize to remove a particular map key, one has to use JSON patch syntax which is quite different from the normal document structure. On the other hand,
ytt uses its ability to annotate YAML structures, hence it can mark map key that should be deleted. All in all, we think that
ytt’s approach is superior.
Here are a few more detailed differences:
- are not Kubernetes-specific so various types of configurations are covered that kustomize cannot deal with.
- cover all CRUD operations in one consistent style whereas kustomize needs varied syntaxes for varied types of modification (SMP vs jsonPatch, etc.).
- do not care about native kinds, CRDs vs something else since they are generic.
yttis not just an overlay tool; it supports overlaying and templating. We see configuration writing split into two categories: configuration authors, and configuration consumers. Configuration authors are best supported by templating; however, configuration consumers typically need more than just templating inputs. Overlaying provides the rest. Having one tool with consistent functionality across templating and overlays is powerful.
yttis more explicit about missing map keys, etc (avoids a lot of unnecessary typos early on).
yttallows you to define variables.
ytthas facilties to inject data into overlays from a variety of inputs including command line arguments, environment variables, and files.
ytt vs Orchestration Tools (Pulumi / HELM) ¶
Orchestration tools like Pulumi, and HELM, have combined configuration management and workflow management into the same tool. There are advantages and disadvantages to that.
ytt is designed specifically to only focus on configuration management. Though, YAML output can be used with HELM, Pulumi, or other tools.
ytt vs plain Ruby/Python/etc ¶
Key advantages for
- provides an easy way to operate on structures (maps, lists, etc.). One can definitely use a regular language to do data manipulation. However, this is not what the language is optimized for, especially if data is heavily nested, typically leading to very verbose and less readable code.
- provides an easy and safe way to execute templates without worrying that template code may be malicious. One can Dockerize execution of regular language templates but of course that brings in pretty heavy dependency.
- provides an easy way to customize any part of configuration via overlays. This is not possible to do with a regular language without parameterizing everything (a general anti-pattern) or bringing in an additional tool (e.g. BOSH ops files).
(Help improve our docs: edit this page on GitHub)