CheatPress

crictl CRI container debugging

Version 1.37 · source

crictl, Postcard, light preview Light · Postcard 102 × 152 mm · PDF crictl, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF crictl, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
crictl, A5, light preview Light · A5 148 × 210 mm · PDF crictl, A5, dark preview Dark · A5 148 × 210 mm · PDF crictl, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
crictl, A4, light preview Light · A4 210 × 297 mm · PDF crictl, A4, dark preview Dark · A4 210 × 297 mm · PDF crictl, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
crictl, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF crictl, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF crictl, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
crictl, A3, light preview Light · A3 297 × 420 mm · PDF crictl, A3, dark preview Dark · A3 297 × 420 mm · PDF crictl, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
crictl, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF crictl, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF crictl, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
crictl, Letter, light preview Light · Letter 8.5 × 11 in · PDF crictl, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF crictl, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
crictl, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF crictl, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF crictl, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

crictl pods
List pod sandboxes
crictl ps -a
List all containers
crictl logs <container>
Show container logs
crictl exec -it <container> sh
Shell into container
crictl inspect <container>
Container details
crictl images
List images
crictl stats
CPU and memory use
crictl info
Runtime status

Concepts

  1. crictl CRI client
  2. Runtime containerd / CRI-O
  3. Pod sandbox shared network
  4. Containers app + sidecars

Connect

crictl --runtime-endpoint <socket> ps
Use a specific runtime socket
crictl config --set runtime-endpoint=<socket>
Store the endpoint in the config
crictl config --list
Show client config values
crictl --timeout <seconds> ps
Raise the connection timeout
crictl --debug ps
Print debug output
CONTAINER_RUNTIME_ENDPOINT
Env var for the runtime socket
sudo -E crictl ps
Keep env vars under sudo
crictl --config <file> ps
Use another config file
crictl version
Client and runtime versions

Pods

crictl pods
List pod sandboxes
crictl pods --name <name>
Filter pods by name
crictl pods --label <key>=<value>
Filter pods by label
crictl pods --namespace <ns>
Filter pods by namespace
crictl pods --state Ready
Only ready pods
crictl pods -q
Print only pod IDs
crictl inspectp <pod>
Pod sandbox details
crictl stopp <pod>
Stop a pod sandbox
crictl rmp <pod>
Remove a stopped pod
crictl runp <pod.json>
Create and start a pod sandbox
crictl runp --runtime <handler> <pod.json>
Pod with a runtime handler
crictl statsp
Pod resource usage

Containers

crictl ps
List running containers
crictl ps -a
Include exited containers
crictl ps --name <name>
Filter containers by name
crictl ps --pod <pod>
Containers of one pod
crictl ps --state exited
Filter by state
crictl ps -q
Print only container IDs
crictl inspect <container>
Container details as JSON
crictl stop <container>
Stop a container
crictl rm <container>
Remove a container
crictl start <container>
Start a created container
crictl create <pod> <ctr.json> <pod.json>
Create a container in a pod
crictl run <ctr.json> <pod.json>
Create and start in one step
crictl update --memory <bytes> <container>
Change resource limits
crictl checkpoint --export=<file.tar> <container>
Checkpoint to an archive

Logs and exec

crictl logs <container>
Show container logs
crictl logs -f <container>
Follow the log
crictl logs --tail=<n> <container>
Last N lines
crictl logs --since=<duration> <container>
Logs from the last period
crictl logs --timestamps <container>
Prefix lines with time
crictl exec -it <container> sh
Interactive shell
crictl exec <container> <cmd>
Run one command
crictl attach <container>
Attach to the main process
crictl port-forward <pod> <local>:<remote>
Forward a port from a pod

Images

crictl images
List images
crictl images <repo>
Filter by repository
crictl images --digests
Show image digests
crictl images -q
Print only image IDs
crictl pull <image>
Pull an image
crictl rmi <image>
Remove an image
crictl rmi --prune
Remove unused images
crictl inspecti <image>
Image details
crictl imagefsinfo
Image filesystem usage

Node and metrics

crictl info
Runtime status and config
crictl stats
Container CPU and memory
crictl stats -a
Include stopped containers
crictl events
Stream runtime events
crictl runtime-config
Show runtime cgroup driver
crictl completion bash
Print shell completion script
crictl ps -o json
Machine-readable output
crictl help <command>
Help for one subcommand

Recipes

Configure containerd once
sudo tee /etc/crictl.yaml <<'EOF'runtime-endpoint: unix:///run/containerd/containerd.sockimage-endpoint: unix:///run/containerd/containerd.socktimeout: 10EOFsudo crictl info
Debug a crashing pod on the node
crictl pods --name <pod>crictl ps -a --pod <pod-id>crictl logs --tail=50 <container-id>crictl inspect <container-id>
Find a container's exit code
crictl ps -a --name <name>crictl inspect <container-id> | jq '.status.exitCode'
Clean up a node
crictl ps -a --state exited -q | xargs -r crictl rmcrictl rmi --prune