awesome-kubernetes/docs/yaml.md

Templating YAML with YAML Processors. Static Checking of Kubernetes YAML Files

• Templating YAML Files
  • YAML anchors and aliases
  • YAML Processors
  • Other YAML Tools. How to create Kubernetes YAML files
  • Kubernetes examples
  • Helm and Kustomize
• Templating JSON Files
  • JSON in Ansible
  • JSON formatting with jq
  • Kubernetes JSON Schemas
• Static Checking of Kubernetes YAML Files. Kubernetes YAML Validation Tools
• Alternatives

Templating YAML Files

• wikipedia: YAML
• redhat.com: YAML for beginners YAML is an easy, expressive, data-oriented language that distinguishes itself from document markup languages.
• thoughtworks.com: Templating in YAML As infrastructures grow in complexity, so do the configuration files that define them. Tools such as AWS CloudFormation, Kubernetes and Helm expect configuration files in JSON or YAML syntax, presumably in an attempt to make them easy to write and process. However, in most cases, teams quickly reach the point where they have some parts that are similar but not quite the same, for example, when the same service must be deployed in different regions with a slightly different setup. For such cases tools offer templating in YAML (or JSON), which has caused a huge amount of frustration with practitioners. The problem is that the syntax of JSON and YAML requires all sorts of awkward compromises to graft templating features such as conditionals and loops into the files. We recommend using an API from a programming language instead or, when this is not an option, a templating system in a programming language, either a general-purpose language such as Python or something specialized such as Jsonnet.
• Steve Horsfield: DevOps tricks - Templating YAML files Basic text tools fall foul of YAML’s indentation sensitivity. On the other hand, YAML tools like ytt are pretty difficult to interpret. In my case, I opted for a small jq program executed via yq.
• redhat.com: Understanding YAML for Ansible. Validating YAML files with YAMLlint 🌟 Ansible playbooks are written in YAML, YAML Ain't Markup Language. Understanding YAML syntax is a key to success with Ansible.
• linuxhandbook.com: YAML Basics Every DevOps Engineer Must Know 🌟
• developers.redhat.com: How to configure YAML schema to make editing files easier
• kubernetestutorials.com: Kubernetes : Introduction to YAML 🌟
• betterprogramming.pub: YAML Tutorial: Get Started With YAML in 5 Minutes Syntax, salient features, and advanced features.
• abhisheksaini.hashnode.dev: YAML For Data Representation? YAML is a better option than JSON when comes to representation of Data
• boxunix.com: A Better Way of Organizing Your Kubernetes Manifest Files 🌟
• opensource.com: Make YAML as easy as it looks YAML looks simple so why is it so hard to write? Learn the two secrets to YAML success.
• javascript.plainenglish.io: Everything You Need To Know About YAML Files Learning about YAML gives you an advantage over your peers since it literally makes programming and configuring cloud computing resources easier.

YAML anchors and aliases

• yaml.org: Anchors and Aliases
• support.atlassian.com: YAML anchors and aliases
• medium: Don’t Repeat Yourself with Anchors, Aliases and Extensions in Docker Compose Files
• docs.ansible.com: YAML anchors and aliases: sharing variable values

YAML Processors

• github.com/topics/yaml-processor
• ytt is a templating tool that understands YAML structure allowing you to focus on your data instead of how to properly escape it.
• You should use tools such as yq and kustomize to template YAML resources instead of relying on tools that interpolate strings such as Helm.
• yq 🌟 is a lightweight and portable command-line YAML processor. The aim of the project is to be the jq or sed of yaml files. yq allows to query the yaml tree and highlights it:
  • k get svc a -o yaml | yq r -
  • dev.to: yq : A command line tool that will help you handle your YAML resources better 🌟
  • towardsdatascience.com: yq: Mastering YAML Processing in Command Line 🌟 Learn to parse and manipulate YAML files more efficiently using yq command-line utility and this simple cheat sheet
• Kapitan Generic templated configuration management for Kubernetes, Terraform and other things.
• yaml.sh A YAML parser completely in bash. Yaml.sh — YAML Sans Helm
• yh - YAML Highlighter is YAML syntax highlighter that works nicely with kubectl output
• Kubectl output options 🌟

Other YAML Tools. How to create Kubernetes YAML files

• avencera/yamine A simple CLI for combining json and yaml files
• k8syaml.com 🌟 Kubernetes YAML Generator - Powered by Octopus
• itnext.io: How to create Kubernetes YAML files 🌟 - ref2 at hackernoon.com

Kubernetes examples

• Kubernetes examples 🌟 A series of YAML references with canonical and as-simple-as-possible demonstrations of kubernetes functionality and features.

Helm and Kustomize

• dex.dev: YAML Templating Solutions: Helm & Kustomize Writing config files by hand is like coding with Notepad instead of an IDE. Let's find a better way, and take an overview of the popular solutions Helm & Kustomize.

Templating JSON Files

• wikipedia: JSON
• json.org: Introducing JSON
• Jsonnet A data templating language for app and tool developers
• Building a high performance JSON parser
• json-schema.org: Understanding JSON Schema 🌟
• dzone.com: The Ultimate JSON Library: JSON.simple vs. GSON vs. Jackson vs. JSONP We ran a benchmark test in 2017 and again in 2021 to see how fast four of the most popular JSON libraries for Java parse different sizes of files.

JSON in Ansible

• opensource.com: 5 ways to process JSON data in Ansible 🌟 Structured data is friendly for automation, and you can take full advantage of it with Ansible.

JSON formatting with jq

• about.gitlab.com: Tips for productive DevOps workflows: JSON formatting with jq and CI/CD linting automation
• jq -C '.' data.json | less -R Use jq to pretty print some JSON data with ANSI color coded syntax and use -R in less to process the color.
• github.com/ilyash/show-struct Shows possible jq paths in a JSON file

Kubernetes JSON Schemas

• github: Kubernetes JSON Schemas 🌟 Schemas for every version of every object in every version of Kubernetes

Static Checking of Kubernetes YAML Files. Kubernetes YAML Validation Tools

• The ecosystem of static checking of Kubernetes YAML files can be grouped in the following categories:
  • API validators: Tools in this category validate a given YAML manifest against the Kubernetes API server.
  • Built-in checkers: Tools in this category bundle opinionated checks for security, best practices, etc.
  • Custom validators: Tools in this category allow writing custom checks in several languages such as Rego and Javascript.
• Validating Kubernetes YAML for best practice and policies 🌟 In this article, you will learn and compare six different tools:
  • Kubeval
  • Kube-score
  • Config-lint
  • Copper
  • Conftest
  • Polaris
• kubevious.io: Top Kubernetes YAML Validation Tools

Alternatives

• ketch - civo.com: Deployments without YAML using Ketch
  • ketch: Getting Started
  • github.com/shipa-corp/ketch Ketch is an application delivery framework that facilitates the deployment and management of applications on Kubernetes using a simple command line interface.
  • dzone.com: Use Ketch to Deploy Apps on Kubernetes Without YAML An open-source project for deploying and managing applications on Kubernetes with a command-line interface.
• shipa.io: DevOps Challenge – Kubernetes Deployment: Ketch vs YAML
• naml: Not another markup language Framework for replacing Kubernetes YAML with Go.