Sidecar container pattern in Kubernetes - Mini Project: Build & Apply

Sidecar Container Pattern in Kubernetes

📖 Scenario: You are deploying a web application in Kubernetes. You want to add a sidecar container that helps with logging. The sidecar container will run alongside the main web app container in the same pod.

🎯 Goal: Create a Kubernetes pod manifest with two containers: a main container named webapp running the nginx image, and a sidecar container named log-agent running the busybox image. The sidecar container will simulate log collection by running a simple command.

📋 What You'll Learn

Create a pod manifest with metadata name webapp-pod

Add a container named webapp using the nginx image

Add a sidecar container named log-agent using the busybox image

Configure the sidecar container to run the command sh -c "while true; do echo collecting logs; sleep 5; done"

Output the complete pod manifest YAML

💡 Why This Matters

🌍 Real World

Sidecar containers are used in Kubernetes to add supporting features like logging, monitoring, or proxying without changing the main application container.

💼 Career

Understanding the sidecar pattern is important for DevOps roles working with Kubernetes to build scalable and maintainable applications.

1

Create the basic pod manifest with the main container

Create a Kubernetes pod manifest YAML with apiVersion set to v1, kind set to Pod, and metadata.name set to webapp-pod. Add a single container named webapp using the nginx image under spec.containers.

Kubernetes

apiVersion: v1
kind: Pod
metadata:
  name: webapp-pod
spec:
  containers:
  - name: webapp
    image: nginx
    # Your code here

Hint

Start with the pod basics: apiVersion, kind, metadata, and spec. Then add the containers list with one container named webapp using the nginx image.

2

Add the sidecar container configuration

Add a second container to the spec.containers list. Name this container log-agent and use the busybox image.

Kubernetes

apiVersion: v1
kind: Pod
metadata:
  name: webapp-pod
spec:
  containers:
  - name: webapp
    image: nginx
  # Add the sidecar container named log-agent with busybox image below
  # Your code here

Hint

Remember to add the sidecar container as a second item in the containers list under spec.

3

Configure the sidecar container command

Add the command field to the log-agent container. Set it to run sh -c "while true; do echo collecting logs; sleep 5; done" to simulate continuous log collection.

Kubernetes

apiVersion: v1
kind: Pod
metadata:
  name: webapp-pod
spec:
  containers:
  - name: webapp
    image: nginx
  - name: log-agent
    image: busybox
    # Add the command to run the log collection loop below
    # Your code here

Hint

Use the YAML list syntax for the command field with sh, -c, and the loop string.

4

Output the complete pod manifest

Print the complete pod manifest YAML to display the final configuration with both containers and the sidecar command.

Kubernetes

# Print the pod manifest YAML below
# Your code here

Hint

Just output the full YAML manifest as text. This is the final pod configuration.

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