Sidecar container pattern in Kubernetes - Commands & Configuration

Introduction

Sometimes an application needs helper tasks like logging or data syncing that run alongside it. The sidecar container pattern solves this by running a small helper container inside the same pod as the main app, sharing resources and network.

When you want to add logging or monitoring to an app without changing its code

When you need to sync files or data between the app and external storage

When you want to inject configuration or secrets dynamically alongside the app

When you want to add a proxy or network helper to manage traffic for the app

When you want to share a cache or database connection helper with the main app

Config File - sidecar-pod.yaml

sidecar-pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: example-sidecar-pod
spec:
  containers:
  - name: main-app
    image: nginx:1.23.3
    ports:
    - containerPort: 80
    volumeMounts:
    - name: log-volume
      mountPath: /var/log/nginx
  - name: sidecar-logger
    image: busybox:1.36
    command: ["sh", "-c", "tail -f /var/log/nginx/access.log"]
    volumeMounts:
    - name: log-volume
      mountPath: /var/log/nginx
  volumes:
  - name: log-volume
    emptyDir: {}

This YAML defines a pod with two containers: main-app running nginx, and sidecar-logger running busybox to watch nginx logs.

They share a volume log-volume to exchange log files.

This setup lets the sidecar container help the main app without changing the app itself.

Commands

This command creates the pod with both the main app and the sidecar container running together.

Terminal

kubectl apply -f sidecar-pod.yaml

Expected Output

pod/example-sidecar-pod created

Check that the pod is running and both containers are ready.

Terminal

kubectl get pods

Expected Output

NAME                 READY   STATUS    RESTARTS   AGE

example-sidecar-pod   2/2     Running   0          10s

View the logs output from the sidecar container to verify it is working as expected.

Terminal

kubectl logs example-sidecar-pod -c sidecar-logger

Expected Output

No output (command runs silently)

→

-c - Specify the container name inside the pod to get logs from

Key Concept

If you remember nothing else from this pattern, remember: a sidecar container runs alongside your main app in the same pod to provide helper functions without changing the app.

Common Mistakes

Defining the sidecar container in a separate pod instead of the same pod

Sidecar containers must be in the same pod to share storage and network; separate pods cannot share these resources directly.

Always define the sidecar container inside the same pod spec as the main container.

Not sharing volumes between main and sidecar containers when they need to exchange files

Without shared volumes, containers cannot access each other's files, breaking the helper functionality.

Use shared volumes in the pod spec and mount them in both containers.

Trying to access sidecar container logs without specifying the container name

Pods with multiple containers require specifying which container's logs to view; otherwise, kubectl returns an error.

Use the -c flag with kubectl logs to specify the sidecar container.

Summary

Create a pod with both main and sidecar containers defined together.

Use shared volumes to let containers exchange files or data.

Use kubectl commands to deploy the pod and check logs from the sidecar container.

Practice

1. What is the main purpose of the sidecar container pattern in Kubernetes?

easy

A. To scale containers independently within a pod

B. To deploy multiple pods for load balancing

C. To run helper containers alongside the main app container in the same pod

D. To create separate namespaces for different applications

Solution

1. Step 1: Understand the sidecar pattern concept

   The sidecar pattern runs helper containers alongside the main app container inside the same pod to add extra features without changing the main app.

2. Step 2: Compare options with the concept

   Only To run helper containers alongside the main app container in the same pod correctly describes running helper containers alongside the main app in one pod, which is the sidecar pattern.

3. Final Answer:

   To run helper containers alongside the main app container in the same pod -> Option C

4. Quick Check:

   Sidecar pattern = helper containers in same pod [OK]

Hint: Sidecar means helper container runs with main app in one pod [OK]

Common Mistakes:

• Confusing sidecar with scaling pods
• Thinking sidecar creates separate namespaces
• Assuming sidecar runs in different pods

2. Which of the following is the correct way to define a sidecar container in a Kubernetes pod YAML?

easy

A. Define sidecar containers under spec.volumes

B. Create separate pod definitions for each container

C. Use initContainers only for sidecars

D. Add multiple containers under the spec.containers list in the pod definition

Solution

1. Step 1: Review pod YAML structure

   In Kubernetes, multiple containers running together in one pod are listed under spec.containers.

2. Step 2: Match sidecar container placement

   Sidecar containers are defined as additional entries in the spec.containers array, not as separate pods or under volumes.

3. Final Answer:

   Add multiple containers under the spec.containers list in the pod definition -> Option D

4. Quick Check:

   Sidecar containers go in spec.containers [OK]

Hint: Sidecars are just extra containers in spec.containers list [OK]

Common Mistakes:

• Defining sidecars as separate pods
• Putting sidecars under volumes or initContainers
• Confusing initContainers with sidecars

3. Given this pod YAML snippet, what will happen when the pod starts?

spec:
  containers:
  - name: app
    image: myapp:latest
  - name: logger
    image: log-collector:latest
    volumeMounts:
    - name: shared-logs
      mountPath: /var/log/app
  volumes:
  - name: shared-logs
    emptyDir: {}

medium

A. Both containers start; logger collects logs from app via shared volume

B. Only the app container starts; logger container fails due to missing volume

C. Pod fails to start because volumes are not defined correctly

D. Logger container starts but cannot access app logs

Solution

1. Step 1: Analyze pod containers and volumes

   There are two containers: app and logger. Logger mounts a shared volume shared-logs at /var/log/app. The volume is defined as emptyDir, which is a temporary shared storage.

2. Step 2: Understand sidecar volume sharing

   Both containers share the emptyDir volume, so logger can access logs written by app in that path.

3. Final Answer:

   Both containers start; logger collects logs from app via shared volume -> Option A

4. Quick Check:

   Shared emptyDir volume enables log sharing [OK]

Hint: Shared emptyDir volume means containers share files [OK]

Common Mistakes:

• Assuming volume is missing or misconfigured
• Thinking containers run independently without shared storage
• Confusing emptyDir with persistent volume

4. You have a pod with a sidecar container for syncing files, but the sidecar is not starting. Which of these is the most likely cause?

medium

A. The sidecar container image name is misspelled in the pod spec

B. The main container is using too much CPU

C. The pod has no labels defined

D. The pod is missing a service account

Solution

1. Step 1: Identify common sidecar startup issues

   A common reason a container does not start is an incorrect image name causing image pull failure.

2. Step 2: Evaluate other options

   CPU usage by main container, missing labels, or service accounts usually do not prevent sidecar container startup directly.

3. Final Answer:

   The sidecar container image name is misspelled in the pod spec -> Option A

4. Quick Check:

   Image name typo causes container start failure [OK]

Hint: Check image name spelling if sidecar won't start [OK]

Common Mistakes:

• Blaming CPU usage for container start failure
• Assuming labels affect container startup
• Thinking service accounts block container start

5. You want to add a sidecar container to your pod that automatically refreshes configuration files every minute without restarting the main app. Which approach best fits this requirement?

hard

A. Add an initContainer to update config files before the main app starts

B. Use a sidecar container that watches config files and updates a shared volume mounted by the main app

C. Restart the main app container every minute using a Kubernetes cron job

D. Use a separate pod to update config files and restart the main app pod

Solution

1. Step 1: Understand sidecar role for live config updates

   A sidecar container can run alongside the main app and update shared config files dynamically without restarting the main app.

2. Step 2: Evaluate other options for live updates

   InitContainers run only once before the main app starts, so they can't refresh configs continuously. Restarting the main app or using separate pods is less efficient and disrupts availability.

3. Final Answer:

   Use a sidecar container that watches config files and updates a shared volume mounted by the main app -> Option B

4. Quick Check:

   Sidecar updates shared config live without app restart [OK]

Hint: Sidecar can update shared files live; initContainers run once [OK]

Common Mistakes:

• Using initContainers for continuous updates
• Restarting main app unnecessarily
• Using separate pods causing complexity