Modern Guide to YAML Validation for Kubernetes & Docker

TL;DR

YAML is the standard for Kubernetes and Docker configs, but indentation errors cause 90% of deployment failures. Key rules: use 2 spaces (never tabs), separate documents with ---, and always validate before kubectl apply. Use our YAML Validator to catch errors instantly. Key Facts:

• YAML strictly forbids tabs—must use spaces (2-space indent is standard)
• yes/no are interpreted as booleans in some YAML versions
• Single indentation error can break entire Kubernetes deployment
• 35K+ monthly searches for "yaml validator online"

---

YAML (YAML Ain't Markup Language) has become the de-facto standard for configuration in the cloud-native ecosystem. From Kubernetes manifests to Docker Compose files and GitHub Actions workflows, YAML is everywhere.

However, its reliance on whitespace and indentation makes it notoriously prone to human error. In this guide, we'll explore how to master YAML and avoid common pitfalls.

Why YAML is Popular (and Frustrating)

YAML's popularity stems from its readability. Unlike JSON, it doesn't require curly braces or quotes for most strings, and it supports comments. But this simplicity comes with a cost: strict indentation rules.

Common YAML Syntax Pitfalls

1. Tabs vs. Spaces: YAML strictly forbids tabs for indentation. You must use spaces (usually 2).
2. Inconsistent Indentation: Mixed indentation levels will break your configuration.
3. Missing Colons: Forgetting the colon after a key or the space after the colon.
4. List Formatting: Incorrectly placing the hyphen (-) for list items.
5. Booleans and Strings: Forgetting that yes/no can be interpreted as booleans in some YAML versions.

YAML in Kubernetes

In Kubernetes, a single indentation error in a Deployment manifest can lead to frustrating error: error parsing... messages during kubectl apply.

Best Practices for Kubernetes YAML

• Use 2-space indentation: This is the standard in the Kubernetes community.
• Separate documents with ---: If you have multiple resources in one file, use the triple-dash separator.
• Validate before applying: Use a YAML validator tool or kubectl --dry-run=client to catch errors early.

YAML in Docker Compose

Docker Compose files use YAML to define multi-container applications. Indentation errors here often lead to services not starting or being misconfigured.

services:
  web:
    image: nginx:latest
    ports:
"80:80"
  db:
    image: postgres:15
    environment:
      POSTGRES_PASSWORD: example # Indentation matters here!

How to Validate YAML Effectively

1. Use an Online YAML Validator

Tools like our YAML Validator provide real-time feedback and highlight the exact line where a syntax error occurs. This is much faster than repeatedly running CLI commands.

2. Linters and IDE Plugins

VS Code, IntelliJ, and other editors have excellent YAML plugins that provide linting and schema validation for Kubernetes and Docker.

3. Schema Validation

Go beyond syntax and check if your YAML matches a specific schema (like a Kubernetes Resource definition) using tools like kube-linter or datree.

Conclusion

YAML is a powerful tool when handled correctly. By using consistent indentation, avoiding tabs, and leveraging validation tools, you can significantly reduce configuration errors and improve your DevOps workflow.

Check out our YAML Validator & Formatter to ensure your Kubernetes and Docker configs are always perfect.