Depends_on for service ordering in Docker - Commands & Configuration

Introduction

When running multiple services together, some services need to start before others. Depends_on helps control the order so services start in the right sequence.

When you want a database service to start before your web app connects to it.

When a cache service must be ready before your application uses it.

When you have multiple microservices that depend on each other starting in order.

When you want to avoid errors caused by services trying to connect before others are ready.

Config File - docker-compose.yml

docker-compose.yml

version: '3.8'
services:
  db:
    image: postgres:15
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: password
  web:
    image: nginx:stable
    depends_on:
      - db

This file defines two services: db and web.

The depends_on key under web tells Docker Compose to start the db service before starting web.

This helps ensure the database is running before the web server tries to use it.

Commands

This command starts all services defined in the docker-compose.yml file in detached mode, respecting the depends_on order.

Terminal

docker-compose up -d

Expected Output

Creating network "default" with the default driver

Creating volume "default_db_data" with default driver

Creating default_db_1 ... done

Creating default_web_1 ... done

→

-d - Run containers in the background (detached mode)

This command lists all running services and their current status to verify they started correctly.

Terminal

docker-compose ps

Expected Output

    Name                  Command               State           Ports

--------------------------------------------------------------------------------

default_db_1    docker-entrypoint.sh postgres    Up      5432/tcp

default_web_1   nginx -g 'daemon off;'           Up      80/tcp

This command shows the logs of the web service to check if it started without errors and connected to the db.

Terminal

docker-compose logs web

Expected Output

[default_web_1] 2024/06/01 12:00:00 [notice] 1#1: using the "epoll" event method

[default_web_1] 2024/06/01 12:00:00 [notice] 1#1: nginx started

Key Concept

depends_on controls the start order of services but does not wait for a service to be fully ready.

Common Mistakes

Assuming depends_on waits for the service to be fully ready before starting the next.

depends_on only waits for the container to start, not for the service inside to be ready, which can cause connection errors.

Use healthchecks with depends_on condition or add retry logic in your application to handle service readiness.

Not specifying depends_on when one service needs another to be running first.

Services may start in any order, causing failures if dependencies are not ready.

Always use depends_on to define service start order when dependencies exist.

Summary

depends_on in docker-compose.yml sets the order services start.

docker-compose up -d starts services respecting depends_on.

Check service status with docker-compose ps and logs to confirm proper startup.

Practice

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

easy

A. To specify the image version for services

B. To set environment variables for services

C. To define network settings for services

D. To control the order in which services start

Solution

1. Step 1: Understand the role of depends_on

   depends_on is used to specify which services must start before others in Docker Compose.

2. Step 2: Differentiate from other settings

   It does not set environment variables, network settings, or image versions; it only controls start order.

3. Final Answer:

   To control the order in which services start -> Option D

4. Quick Check:

   Service start order = depends_on [OK]

Hint: Depends_on controls start order, not readiness or config [OK]

Common Mistakes:

• Thinking depends_on waits for full service readiness
• Confusing depends_on with environment or network settings
• Assuming depends_on sets image versions

2. Which of the following is the correct syntax to make service web depend on service db in a Docker Compose file?

easy

A. web:
depends:
db

B. web:
depends:
- db

C. web:
depends_on:
- db

D. web:
depends_on: db

Solution

1. Step 1: Recall correct depends_on syntax

   The correct syntax uses depends_on as a key with a list of service names under it.

2. Step 2: Check each option

   web: depends_on: - db correctly uses depends_on: followed by a list with - db. Others have wrong keys or missing list format.

3. Final Answer:

   web: depends_on: - db -> Option C

4. Quick Check:

   depends_on needs a list under it [OK]

Hint: depends_on requires a list of services under it [OK]

Common Mistakes:

• Using 'depends' instead of 'depends_on'
• Not using a list for dependent services
• Writing depends_on as a single string

3. Given this Docker Compose snippet:

services:
  db:
    image: postgres
  web:
    image: nginx
    depends_on:
      - db

What happens when you run docker-compose up?

medium

A. The web service starts only after the db service has fully initialized

B. The db service starts before the web service, but web may start before db is ready

C. Both services start simultaneously without any order

D. The web service starts first, then the db service

Solution

1. Step 1: Understand depends_on behavior

   depends_on ensures the db service starts before web, but does not wait for db to be ready.

2. Step 2: Analyze the startup sequence

   db container starts first, then web starts immediately after, even if db is not fully ready.

3. Final Answer:

   The db service starts before the web service, but web may start before db is ready -> Option B

4. Quick Check:

   depends_on controls start order, not readiness [OK]

Hint: depends_on orders start but doesn't wait for readiness [OK]

Common Mistakes:

• Assuming depends_on waits for full service readiness
• Thinking services start simultaneously
• Believing web starts before db

4. You wrote this Docker Compose snippet:

services:
  web:
    image: nginx
    depends_on: db
  db:
    image: postgres

But it fails to start with an error. What is the problem?

medium

A. depends_on should be a list, not a single string

B. The db service must be defined before web

C. Image names are incorrect

D. depends_on cannot be used with nginx

Solution

1. Step 1: Check depends_on syntax

   depends_on expects a list of services, but here it is given as a single string.

2. Step 2: Identify correct format

   It should be:

   depends_on:
     - db

   not depends_on: db.

3. Final Answer:

   depends_on should be a list, not a single string -> Option A

4. Quick Check:

   depends_on requires a list [OK]

Hint: depends_on must list services with dash (-) [OK]

Common Mistakes:

• Using a string instead of a list for depends_on
• Assuming service order depends on definition order
• Blaming image names for depends_on errors

5. You have three services: db, cache, and web. The web service needs both db and cache to start first. Also, cache must start after db. How should you write the depends_on section for web and cache to enforce this order?

hard

A. web:
depends_on:
- db
- cache
cache:
depends_on:
- db

B. web:
depends_on:
- cache
cache:
depends_on:
- web
- db

C. web:
depends_on:
- db
cache:
depends_on:
- web

D. web:
depends_on:
- db
cache:
depends_on:
- web
- db

Solution

1. Step 1: Define cache dependency on db

   cache must start after db, so cache depends_on db.

2. Step 2: Define web dependency on both db and cache

   web needs both db and cache started first, so web depends_on both db and cache.

3. Final Answer:

   web: depends_on: - db - cache cache: depends_on: - db -> Option A

4. Quick Check:

   Order: db -> cache -> web [OK]

Hint: Chain depends_on to enforce multi-step start order [OK]

Common Mistakes:

• Making cache depend on web incorrectly
• Not listing both dependencies for web
• Assuming depends_on waits for readiness