Compose profiles for selective services in Docker - Mini Project: Build & Apply

Compose profiles for selective services

📖 Scenario: You are managing a small web application with multiple services. You want to run only specific services depending on the environment, like development or production, using Docker Compose profiles.

🎯 Goal: Learn how to create a docker-compose.yml file with profiles to selectively start services. You will define services and assign them to profiles, then run only the services for a chosen profile.

📋 What You'll Learn

Create a docker-compose.yml file with three services: web, db, and cache

Assign the web and db services to the prod profile

Assign the web and cache services to the dev profile

Use the profiles key in the compose file to specify profiles

Run docker compose --profile dev up to start only the dev profile services

💡 Why This Matters

🌍 Real World

In real projects, you often want to run only some services depending on the environment, like running a cache only in development but not in production.

💼 Career

Knowing how to use Docker Compose profiles helps you manage complex applications efficiently and is a valuable skill for DevOps and software engineers.

1

Create the base Docker Compose file with three services

Create a docker-compose.yml file with three services: web, db, and cache. Use the image nginx:alpine for web, postgres:alpine for db, and redis:alpine for cache. Do not add profiles yet.

Docker

# Create services web, db, and cache with specified images
# Your code here

Hint

Use the services key and list each service with its image.

2

Add profiles to the services

Add the profiles key to assign services to profiles. Assign web and db to the prod profile. Assign web and cache to the dev profile.

Docker

version: '3.9'
services:
  web:
    image: nginx:alpine
    # Add profiles key here
  db:
    image: postgres:alpine
    # Add profiles key here
  cache:
    image: redis:alpine
    # Add profiles key here
# Your code here

Hint

Use the profiles key under each service with a list of profile names.

3

Run Docker Compose with the dev profile

Write the exact command to start only the services in the dev profile using Docker Compose.

Docker

# Write the command to run docker compose with the dev profile
# Your code here

Hint

Use docker compose --profile dev up to start only the dev profile services.

4

Display which services start with the dev profile

Write a command to list the running containers after starting the dev profile to confirm only web and cache are running.

Docker

# Write the command to list running containers
# Your code here

Hint

Use docker ps to check running containers by name.

Practice

1. What is the main purpose of using profiles in a Docker Compose file?

easy

A. To define environment variables for all services

B. To specify the Docker image version for services

C. To selectively start specific services based on the active profile

D. To set network configurations for containers

Solution

1. Step 1: Understand the role of profiles in Docker Compose

   Profiles allow you to group services so you can start only those you want by activating a profile.

2. Step 2: Compare with other options

   Environment variables, image versions, and network settings are configured differently, not via profiles.

3. Final Answer:

   To selectively start specific services based on the active profile -> Option C

4. Quick Check:

   Profiles control which services run [OK]

Hint: Profiles control service startup groups in Compose [OK]

Common Mistakes:

• Confusing profiles with environment variables
• Thinking profiles set image versions
• Assuming profiles configure networks

2. Which of the following is the correct syntax to assign a service to a profile named debug in a Docker Compose file?

easy

A. profile: [debug]

B. profiles: [debug]

C. profiles: debug

D. profile: debug

Solution

1. Step 1: Recall the correct key and format for profiles

   The key is profiles (plural) and it expects a list of profile names.

2. Step 2: Validate the syntax

   Using YAML list syntax, profiles: [debug] is correct. Other options use singular or wrong types.

3. Final Answer:

   profiles: [debug] -> Option B

4. Quick Check:

   Profiles key is plural and uses list syntax [OK]

Hint: Use plural 'profiles' with a list for service assignment [OK]

Common Mistakes:

• Using singular 'profile' instead of 'profiles'
• Not using list syntax for profiles
• Assigning profile as a string without brackets

3. Given this Compose snippet:

services:
  web:
    image: nginx
  debug:
    image: busybox
    profiles: [debug]

What happens when you run docker compose up without any profile?

medium

A. Only the web service starts

B. Both web and debug services start

C. Only the debug service starts

D. No services start

Solution

1. Step 1: Identify which services have profiles

   The debug service is assigned to the profile 'debug', web has no profile.

2. Step 2: Understand default behavior without profile

   Without specifying a profile, only services without profiles start.

3. Final Answer:

   Only the web service starts -> Option A

4. Quick Check:

   Services without profiles start by default [OK]

Hint: Without profile flag, only services without profiles run [OK]

Common Mistakes:

• Assuming all services start by default
• Thinking profile services start without activation
• Confusing service names with profile names

4. You have this Compose file snippet:

services:
  app:
    image: myapp
    profiles: [prod]
  test:
    image: mytest
    profiles: [test]

You run docker compose --profile prod up but the app service does not start. What is the likely issue?

medium

A. The profile name is misspelled in the command

B. The app service must not have any profile to start

C. You must run docker compose up without profiles to start services

D. The Compose file syntax is invalid

Solution

1. Step 1: Check profile names in Compose and command

   The service uses profile 'prod'. If the command misspells it, the service won't start.

2. Step 2: Understand profile activation

   Only services matching the activated profile start. If the profile name is wrong, no matching service starts.

3. Final Answer:

   The profile name is misspelled in the command -> Option A

4. Quick Check:

   Profile names must match exactly [OK]

Hint: Check exact profile spelling in command and Compose file [OK]

Common Mistakes:

• Assuming services without profiles start with any profile
• Thinking Compose file syntax error causes this
• Believing profiles are optional for service start

5. You want to start only the db and cache services using profiles. Your Compose file has:

services:
  db:
    image: postgres
    profiles: [backend]
  cache:
    image: redis
    profiles: [backend]
  frontend:
    image: nginx
    profiles: [frontend]

Which command will start only the db and cache services?

hard

A. docker compose up

B. docker compose --profile frontend up

C. docker compose --profile db cache up

D. docker compose --profile backend up

Solution

1. Step 1: Identify profiles assigned to db and cache

   Both db and cache are under the 'backend' profile.

2. Step 2: Use the correct command to activate the backend profile

   Running docker compose --profile backend up starts only services in 'backend'.

3. Final Answer:

   docker compose --profile backend up -> Option D

4. Quick Check:

   Activate profile matching services to start them [OK]

Hint: Use --profile with the shared profile name to start grouped services [OK]

Common Mistakes:

• Using profile name not assigned to services
• Running without profile starts no profile services only
• Trying to list services in command instead of profile