noyaml
tanka
noyaml | tanka | |
---|---|---|
9 | 25 | |
416 | 2,240 | |
- | 2.3% | |
5.3 | 8.3 | |
2 months ago | 6 days ago | |
CSS | Go | |
GNU Affero General Public License v3.0 | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
noyaml
-
Kubernetes Through the Developer's Perspective
Most commonly written in YAML, these files are large and complex to read and understand. And being written in YAML comes with its challenges (and quirks) since it is an additional programming language that devs need to learn.
-
JSON Canvas – An open file format for infinite canvas data
YAML is kind of like C++:
> You like C++ because you're only using 20% of it. And that's fine, everyone only uses 20% of C++, the problem is that everyone uses a different 20% :)
https://eli.thegreenplace.net/2009/10/17/the-c-bashing-seaso...
The YAML footguns are too numerous to reproduce here, so here are some sources:
https://stackoverflow.com/questions/3790454/how-do-i-break-a...
https://www.arp242.net/yaml-config.html
https://noyaml.com/
-
Why the fuck are we templating YAML? (2019)
Relevant: https://noyaml.com/
YAML and its ecosystem is full of footguns and ergonomics problems, especially when the length of the document extends beyond the height of a user's editor or viewport. Loss of context with indentation, non-compliant or unsafe parsers, and strange boolean handling to name a few.
It becomes even worse when people decide that static YAML data files should have variable substitution or control flow via templating. "Stringly-typed programming" if you will. If we all started writing JSON text templates I think a lot of people would rightly argue we should write small stdlib-only programs in Python, Typescript, or Ruby to emit this JSON instead of using templated text files. Then it becomes apparent that the YAML template isn't a static data file at all, but part of a program which emits YAML as output. We're already exposing people to basic programming if we're using YAML templates. People brew a special kind of YAML-templated devops hell using tools like Kustomize and Helm, each of which are "just YAML" but are full of idiosyncracies and tool-specific behaviour which make the use of YAML almost coincidental rather than a necessity.
Yes, sometimes people would prefer to look at YAML instead of JSON, in which case I suggest you use a YAML serialization library, or pipe output into a tool like `yq` so you can view the pretty output. In a pinch you could even output JSON and then feed it through a YAML formatter.
The Kubernetes community seems to have this penetrating "oh, it's just YAML" philosophy which means we get mediocre DSLs in "just YAML" which actually encode a lot of nuanced and unintuitive behaviour which varies from tool to tool.
Look at kyverno, for examle: it uses _parentheses_ in YAML key names to change the semantics of security policies! https://kyverno.io/docs/writing-policies/validate/ . This is different to what I think is the (much better ideas of) something like kubewarden, gatekeeper, or jspolicy, which allow engineers to write their policies in anything that compiles to WASM, OPA, and Typescript/Javascript respectively.
We engineers, as a discipline, have decades of know-how building and using general purpose programming languages with type checkers, linters, packaging systems, and other tools, but we throw them all away as soon as YAML comes along. It's time to put the stringified YAML templates away and engage in the ecosystem of mature tools we already to use to perform one simple task they are already good at: dumping JSON on stdout.
Let's move the control flow back into the tool and out of the YAML.
-
YAML's homepage is displayed in YAML
The webpage documenting some of the sharp edges of yaml is also displayed as an editable yaml document
https://noyaml.com/
-
stopDoingJson
It’s the least secure config format, even worse than XML IMO since it’s unsafe even with trusted inputs. https://noyaml.com/
- That's a Lot of YAML
tanka
-
Why the fuck are we templating YAML? (2019)
I would recommend implementing a similar API to Grafana Tanka: https://tanka.dev
When you "synthesise", the returned value should be an array or an object.
1. If it's an object, check if it has an `apiVersion` and `kind` key. If it does, yield that as a kubernetes object and do not recurse.
-
What Is Wrong with TOML?
Maybe you'd like jsonnet: https://jsonnet.org/
I find it particularly useful for configurations that often have repeated boilerplate, like ansible playbooks or deploying a bunch of "similar-but" services to kubernetes (with https://tanka.dev).
Dhall is also quite interesting, with some tradeoffs: https://dhall-lang.org/
A few years ago I did a small comparison by re-implementing one of my simpler ansible playbooks: https://github.com/retzkek/ansible-dhall-jsonnet
-
Show HN: Keep – GitHub Actions for your monitoring tools
- validation is often impractical (at least identifying exactly where the error is… I’m looking at you Helm!)
Unrelated to OP, but you can leverage Tanka to extend helm charts with functionality not provided by upstream.
https://tanka.dev/
-
Alternatives to Helm?
Although jsonette might be considered more complex Tanka is a great alternative for k8s config management.
- Helm makes it overly complex, or is it just me?
-
The YAML Document from Hell
At Grafana Labs we're using jsonnet at scale, while being a powerful functional language it is also excellent for rendering JSON/YAML config. We have developed Tanka[0] to work with Kubernetes, for other purposes I can recommend this course[1] (authored by me).
[0] https://tanka.dev/
[1] https://jsonnet-libs.github.io/jsonnet-training-course/
-
Should i migrate from Kustomize to Helm?
If you're hitting the limits of Kustomize, maybe look at Tanka as well.
-
Is it possible to wrap Kustomize yaml with jinja2?
Yes, try Tanka.
-
Using Docker – Compose in Development and Production
yes. basically. and this is a path that multiple people are trying to solve. e.g. AWS CDK8s, https://tanka.dev/, etc
Compose would be awesome.
-
Google Kubernetes clusters config checker tool
http://tanka.dev
(Note I work for Grafana Labs who fund Tanka and use it for all production config)
What are some alternatives?
yj - CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.
helm-charts - Prometheus community Helm charts
hjson - Hjson, a user interface for JSON
kustomize - Customization of kubernetes YAML configurations
doximus - static, smart and developer friendly API documentation generator
kapitan - Generic templated configuration management for Kubernetes, Terraform and other things
json2jsii - Generates jsii-compatible structs from JSON schemas
ytt - YAML templating tool that works on YAML structure instead of text
PyYAML
kpt - Automate Kubernetes Configuration Editing
crd-to-sample-yaml - Generate a sample YAML file from a CRD
Pulumi - Pulumi - Infrastructure as Code in any programming language. Build infrastructure intuitively on any cloud using familiar languages 🚀