Shounak Khulape

Kubernetes Concepts - Introduction to YAML

Shounak Khulape's photo
Shounak Khulape
·

4 min read

Kubernetes Concepts - Introduction to YAML

Table of contents

  1. What is YAML?

    • YAML is a data serialization language that is human-friendly. Its primary goals are simplicity and readability.

    • Think of YAML as JSON without the ugly parts. It’s like JSON’s more elegant cousin.

    • YAML is being widely adopted for storing configuration files and other types of structured data that are meant to be edited by hand

  2. Key Characteristics of YAML:

    • Human-Friendly: YAML is designed to be easy for humans to read and write.

    • Whitespace Matters: Spaces and indentation play a crucial role in defining the structure of YAML data.

    • Case Sensitivity: YAML is case-sensitive.

    • Language Independence: Once defined, a YAML file can be invoked in various programming languages like Python, Ruby, and more.

    • Unicode Support: YAML uses Unicode printable characters.

    • Basic Primitives: YAML leverages three fundamental primitives:

      • Mapping: Key-value pairs (similar to dictionaries or objects).

      • Sequences: Lists or arrays.

      • Scalars: Single values (strings, numbers, Booleans, etc.).

  3. Common Use Cases for YAML:

    • Cross-Language Data Sharing: YAML is used for sharing data across different programming languages.

    • Log Files: It’s handy for structured log files.

    • Debugging Complex Data Structures: When you need to inspect intricate data, YAML provides clarity.

    • Interprocess Messaging: YAML facilitates communication between processes.

    • Object Persistence: Storing and retrieving objects.

    • Configuration Files: YAML is perfect for configuration settings.

  4. Example:

    • Consider the following text: “Javatpoint is the best website.”

    • The equivalent YAML representation of this text is:

        Javatpoint is the best website.

    • In YAML, we use spaces, colons, and indentation to convey meaning and structure.

What are some common YAML libraries in different programming languages?

Here are some common YAML libraries in different languages:

  1. Python:

    • PyYAML: A popular choice for YAML parsing and serialization in Python. It supports both pure Python and libyaml bindings.

    • ruamel.yaml: An updated version of PyYAML with additional features, including comments round-trip.

    • PySyck: Provides YAML 1.0 support via the syck binding.

    • strictyaml: A restricted YAML subset for enhanced safety.

  2. Ruby:

    • psych: A libyaml wrapper included in Ruby core for Ruby 1.9.2 and later.

    • RbYaml: Implements YAML 1.1 (a PyYAML port).

    • yaml4r: A standard library syck binding for YAML 1.0.

  3. Java:

    • SnakeYAML Engine: Supports Java 8+ and YAML 1.2.

    • SnakeYAML: For Java 5 and YAML 1.1.

    • YamlBeans: Handles JavaBeans with YAML 1.0/1.1.

    • eo-yaml: Provides YAML 1.2 for Java 8 (packaged as a module for Java 9+).

  4. JavaScript:

    • yaml: A JavaScript parser/stringifier supporting YAML 1.2 and 1.1.

    • js-yaml: A native PyYAML port to JavaScript.

  5. C++:

    • yaml-cpp: Implements YAML 1.2 in C++.

    • libcyaml: Enables YAML de/serialization of C data using libyaml.

  6. Other Languages:

    • Swift: Yams (libyaml wrapper).

    • Go: Go-yaml (YAML support for Go) and Go-gypsy (simplified YAML parser in Go).

    • Haskell: HsYAML (pure Haskell implementation of YAML 1.2).

    • Rust: yaml-rust (pure Rust YAML 1.2 implementation) and serde-yaml (YAML de/serialization of structs).

    • Shell: shyaml (read YAML files) and jq (YAML style).

What are some best practices for writing clean and readable YAML?

  1. Indentation and Spaces:

    • Never use TAB characters for indentation; only use SPACE characters.

    • Choose a consistent number of spaces for indentation (recommended: 2 spaces).

    • Avoid mixing different indentation styles within the same YAML document.

    • For sequences, consider using “zero-indented” sequences for readability.

  2. Layout and Formatting:

    • Nested sequences: Use compact formatting for simple nested sequences.

        sequence:
    - level one
    - - level two

    • For more complex nested sequences, consider flow style:

        dice rolls:
    - [2, 5]
    - [3, 4]

    • Avoid starting a sequence or mapping on the same line as a mapping key.

        # Invalid:
  key: inner: map
  key: - sequence

  # Valid:
  sequence:
    - a: b
      c: d

  3. File Extension:

    • Use the recommended file extension: .yaml.

    • Some applications also accept .yml, but .yaml is preferred.

  4. Quoting Scalars:

    • You generally don’t need to quote scalars.

    • Quote scalars if:

      • They could be a special type, but you want a string.

      • They start with a non-alphanumeric character.

      • They contain control characters, tabs, or specific characters like :, {, [, etc.

That's great if you have make till here you have covered Kubernetes Concept Introduction to YAML.

If you liked what you read, do follow and any feedback for further improvement will be highly appreciated!

Thank you and Happy Learning!👏

Kubernetesk8sYAMLDevops