- TechOps Examples
- Posts
- pod.yaml File Structure Breakdown
pod.yaml File Structure Breakdown
Govardhana M K
November 19, 2024
TechOps Examples
Hey — It's Govardhana MK 👋
Along with a use case deep dive, we identify the remote job opportunities, top news, tools, and articles in the TechOps industry.
IN TODAY'S EDITION
🧠 Use Case
pod.yaml File Structure Breakdown
🚀 Top News
Amazon EKS now offers a direct integration between EKS add-ons and EKS Pod Identity
👀 Remote Jobs
Testlio is hiring a Senior DevOps Engineer
Remote Location: APAC
Sporty Group is hiring a Platform Engineer
Remote Location: Worldwide
Canonical is hiring a Cloud Engineering Manager
Remote Location: Worldwide
📚️ Resources
Terraform Stacks, explained
The Complete Guide to CircleCI Pipelines for Kubernetes
👇️Join me to not miss daily updates
🛠️ TOOL OF THE DAY
RepoTree - A tool that generates a clean ASCII representation of a GitHub repository structure.
Visualize Your GitHub Repos.
Perfect for documentation and sharing.
🧠 USE CASE
pod.yaml File Structure Breakdown
In Kubernetes, the pod.yaml file is the backbone of your pod deployment.
It’s a declarative configuration file that defines how your application containers should run and interact with the cluster.
What does it control?
Container images, ports, environment variables, and resource limits.
Mounting volumes and handling pod-level security.
Scheduling, tolerations, and advanced probes for health checks.
Where is it located?
While pod.yaml is typically custom-created for applications, these files are often versioned in repositories alongside Helm charts or GitOps workflows.
Let’s start with the basic structure of a pod.yaml and break down its key elements.
pod.yaml basic structure
Metadata: Defines the pod name and organizational labels like app and tier. These labels help selectors identify and target pods effectively.
Spec Section:
Containers: Specifies container images, ports, and environment variables.
Volumes and VolumeMounts: Handle data persistence and configuration through external ConfigMaps or Secrets.
Restart Policy: Dictates how Kubernetes handles pod restarts (
Always,OnFailure,Never).
Crucial Elements and Red Flags
🚩 Misaligned Labels: Labels (app, tier) must align with services or deployments targeting this pod.
🚩 Missing Resource Limits: Not defining resources.requests and resources.limits can lead to cluster instability.
This basic structure forms the foundation of any pod.yaml file.
Now, let’s explore more advanced configurations.
Probes
Probes ensure that Kubernetes knows whether your container is healthy and ready to serve traffic.
Liveness Probe: Checks if the container is still running (e.g.,
/healthzendpoint).Readiness Probe: Ensures the container is ready to accept traffic (e.g.,
/readyendpoint).
pod.yaml probes section sample
Why they’re crucial:
Without probes, Kubernetes might assume a pod is healthy and route traffic to it even when it’s not ready, leading to downtime or errors.
Pro Tip: Define probes tailored to your application endpoints, and test their configurations in staging before deploying to production.
Affinity
Node and pod affinity control where your pods are scheduled, improving resource utilization and workload performance.
pod.yaml affinity section sample
Hard rules:
requiredDuringSchedulingIgnoredDuringExecutionenforces pod placement on specific nodes (e.g.,zone=us-west-1a).Soft preferences:
preferredDuringSchedulingIgnoredDuringExecutionprioritizes placement but doesn’t enforce it strictly.
Use it for workloads that benefit from proximity, such as a frontend service colocating with its backend.
Learn more about:
Whether you’re deploying simple pods or orchestrating complex workloads, the way you handle pod.yaml has a significant impact.
You may even like: