Master Kubernetes YAML with kubectl: help, dry‑run, and explain tricks

Introduction

In today’s fast‑paced tech landscape, Kubernetes (K8s) is a key platform for modern application development and deployment, but writing K8s YAML manifests can be intimidating for newcomers.

Three Powerful kubectl Tools

The kubectl command offers three useful features to ease YAML authoring:

help : Shows command usage, options, and examples.

dry‑run : Simulates command execution without affecting the cluster; combined with

-o yaml

it outputs the generated YAML.

explain : Displays the structure, fields, default values, and examples of a resource type.

Hands‑On Example: Creating a Deployment

We create a Deployment named

web

to illustrate the three tools.

First, use

kubectl help

to view usage:

<code>kubectl help</code>
<code>kubectl create deployment --help</code>

Next, generate the YAML with a dry‑run:

<code>kubectl create deployment web --image=nginx --port=80 -r 3 -n default --dry-run=client -o yaml</code>

The command outputs a YAML manifest similar to:

<code>apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: web
  name: web
  namespace: default
spec:
  replicas: 3
  selector:
    matchLabels:
      app: web
  template:
    metadata:
      labels:
        app: web
    spec:
      containers:
      - name: web
        image: nginx
        ports:
        - containerPort: 80</code>

Using explain to Understand Resources

To explore a resource definition, run:

<code>kubectl explain pods</code>

The command lists fields such as pod name, ID, IP address, container details, ports, status, and more, helping you debug and comprehend the pod’s behavior.

Conclusion

Whether you are a beginner or an experienced practitioner, mastering

help

,

dry‑run

, and

explain

dramatically improves the speed and accuracy of writing Kubernetes YAML files.