top of page
Writer's picturevP

Understanding YAML - Day 51

Hello readers! Welcome back to our #90DaysOfDevOps series! Today, we'll be exploring the YAML, a configuration language used in Kubernetes to define resources and configurations.


YAML: The Heart of Kubernetes Configurations

In Kubernetes, everything is about defining resources like pods, services, and deployments. These resource configurations are written in YAML (YAML Ain't Markup Language) format. YAML is a human-readable, data serialization format, and it's the language of choice for writing Kubernetes manifests.


YAML syntax

YAML files use a .yml or .yaml extension, and follow specific syntax rules.


YAML has features that come from Perl, C, XML, HTML, and other programming languages. YAML is also a superset of JSON, so JSON files are valid in YAML.


There are no usual format symbols, such as braces, square brackets, closing tags, or quotation marks. And YAML files are simpler to read as they use Python-style indentation to determine the structure and indicate nesting. Tab characters are not allowed by design, to maintain portability across systems, so whitespaces—literal space characters—are used instead.


Comments can be identified with a pound or hash symbol (#). It’s always a best practice to use comments, as they describe the intention of the code. YAML does not support multi-line comment, each line needs to be suffixed with the pound character.


A common question for YAML beginners is “What do the 3 dashes mean?” 3 dashes (---) are used to signal the start of a document, while each document ends with three dots (...).


Why YAML?

YAML was chosen for its simplicity and readability. It's designed to be easily understood by both humans and machines, making it an ideal choice for configuring Kubernetes resources.


Here's a basic example of a YAML manifest file that defines a Kubernetes Pod:

apiVersion: v1
kind: Pod
metadata:
  name: my-pod
spec:
  containers:
    - name: my-container
      image: nginx

This YAML manifest describes a Pod named my-pod with a single container running the Nginx web server. Let's break down its structure:

  • apiVersion: Specifies the Kubernetes API version being used.

  • kind: Identifies the type of resource being defined (e.g., Pod, Service, Deployment).

  • metadata: Contains information about the resource, such as its name and labels.

  • spec: Defines the desired state of the resource. In this case, it specifies a container named my-container based on the Nginx image.


Writing Kubernetes Manifests

Writing YAML manifests can seem intimidating at first, but you'll get the hang of it with practice. Here are a few tips to help you get started:

  1. Indentation: YAML relies heavily on indentation to represent hierarchical data. Ensure consistent and proper indentation to avoid syntax errors.

  2. Use Spaces: YAML is space-sensitive, so it's recommended to use spaces over tabs for indentation.

  3. Comments: You can add comments to your YAML files by using the # symbol.

  4. Keep It Organized: Organize your manifests neatly with comments and sections for metadata, spec, and any other relevant details.


Understanding YAML is a crucial step in your Kubernetes journey. It's the language that empowers you to define, deploy, and manage resources within a Kubernetes cluster. Don't worry if you find it challenging at first; practice makes perfect.


Stay tuned for more exciting DevOps insights in the days ahead.


Thank you for reading!


*** Explore | Share | Grow ***

7 views0 comments

Comments

Rated 0 out of 5 stars.
No ratings yet

Add a rating
bottom of page