> ## Documentation Index
> Fetch the complete documentation index at: https://notes.kodekloud.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Pods with YAML
> How to write and apply a Kubernetes Pod YAML manifest, covering required fields, example Pod, indentation pitfalls, and kubectl commands to create and inspect Pods
In this lesson you'll learn how to define and create a Kubernetes Pod using a YAML manifest. Kubernetes manifests are declarative configuration files that describe the desired state of cluster objects (like Pods). This page covers the required top-level fields, a practical Pod example, common YAML pitfalls, and the kubectl commands you use to apply and inspect the Pod.
## Kubernetes manifest basics
Kubernetes objects are typically defined using YAML files. Most manifests include four top-level fields: `apiVersion`, `kind`, `metadata`, and `spec`. The exact structure of `spec` depends on the resource `kind` (for example, a Pod's `spec` looks different from a Deployment's `spec`).
| Field | Purpose | Typical example |
| - | - | - |
| `apiVersion` | API group and version for the object | `v1`, `apps/v1` |
| `kind` | The resource type to create | `Pod`, `Deployment`, `Service` |
| `metadata` | Object identity and metadata such as `name`, `labels`, `namespace`, `annotations` | `name: myapp-pod` |
| `spec` | Desired state of the object; structure varies by `kind` | For Pods: a `containers` list with `name` and `image` |
Some resources may omit `spec` or include additional required fields. For core objects like Pods use `apiVersion: v1`; other resources often use `apps/v1`.
Always use consistent spaces (not tabs) for indentation in YAML. Incorrect indentation can change structure or make the file invalid.
## Example: Single-container Pod manifest
This minimal Pod manifest creates a Pod named `myapp-pod` that runs an `nginx` container:
```yaml theme={null}
apiVersion: v1
kind: Pod
metadata:
name: myapp-pod
labels:
app: myapp
type: front-end
spec:
containers:
- name: nginx-container
image: nginx
```
Key points:
* `metadata.name` is the unique name for the Pod (`myapp-pod`).
* `metadata.labels` is a key/value map used for grouping and selecting objects later (for example with `kubectl get pods -l app=myapp`).
* `spec.containers` is a list because a Pod can include multiple containers. Each container item must include at least `name` and `image`.
## Common YAML indentation mistake
Incorrect indentation can change the document structure. In the example below `labels` is incorrectly indented under `name`, which is invalid:
```yaml theme={null}
metadata:
name: myapp-pod
labels:
app: myapp
```
Both `name` and `labels` must be siblings under `metadata` (same indentation level):
```yaml theme={null}
metadata:
name: myapp-pod
labels:
app: myapp
```
## Create and inspect the Pod
Save the manifest to a file, for example `pod-definition.yaml`, and apply it with:
```bash theme={null}
kubectl create -f pod-definition.yaml
```
Useful inspection commands:
* List Pods:
```bash theme={null}
kubectl get pods
```
* View detailed Pod information:
```bash theme={null}
kubectl describe pod myapp-pod
```
* Get the Pod manifest as stored in the API server (YAML output):
```bash theme={null}
kubectl get pod myapp-pod -o yaml
```
## Summary
* Kubernetes manifests are YAML files that commonly include the four top-level fields: `apiVersion`, `kind`, `metadata`, and `spec`.
* For a Pod, `spec` must include a `containers` array with at least `name` and `image` for each container.
* YAML is indentation-sensitive — use consistent spacing and verify sibling relationships (e.g., `name` and `labels` under `metadata`).
* Use `kubectl create -f` to create the Pod and `kubectl get` / `kubectl describe` / `kubectl get -o yaml` to inspect it.
Links and references:
* [Kubernetes API concepts](https://kubernetes.io/docs/concepts/overview/working-with-objects/api-overview/)
* [kubectl documentation](https://kubernetes.io/docs/reference/kubectl/overview/)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.