Docker compose in pipelines in Jenkins - Commands & Configuration

Introduction

Running multiple containers together can be tricky. Docker Compose helps by defining and running multi-container Docker apps easily. Using Docker Compose inside Jenkins pipelines automates testing and deployment of these container groups.

When you want to start a database and an app container together during automated tests.

When your app depends on multiple services and you want to run them all in Jenkins before deployment.

When you need to build and test a multi-container app automatically on every code change.

When you want to cleanly start and stop related containers as part of your CI/CD pipeline.

When you want to ensure your app works with its dependencies in a consistent environment during Jenkins runs.

Config File - docker-compose.yml

docker-compose.yml

version: '3.8'
services:
  web:
    image: nginx:1.23
    ports:
      - "8080:80"
  redis:
    image: redis:7.0
    ports:
      - "6379:6379"

This file defines two services: web running Nginx and redis running Redis server.

Ports are mapped so Jenkins can access the web server on port 8080 and Redis on 6379.

Version 3.8 is used for compatibility with modern Docker Compose features.

Commands

Starts all services defined in docker-compose.yml in detached mode so Jenkins can continue running other steps.

Terminal

docker-compose up -d

Expected Output

Creating network "default" with the default driver

Creating redis ... done

Creating web   ... done

→

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

Shows the status of all running containers started by Docker Compose to verify they are up.

Terminal

docker-compose ps

Expected Output

    Name                  Command               State           Ports         

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

example_redis_1   docker-entrypoint.sh redis ...   Up      0.0.0.0:6379->6379/tcp

example_web_1     nginx -g 'daemon off;'          Up      0.0.0.0:8080->80/tcp

Stops and removes all containers, networks, and volumes created by docker-compose up to clean up after the pipeline.

Terminal

docker-compose down

Expected Output

Stopping example_web_1   ... done

Stopping example_redis_1 ... done

Removing example_web_1   ... done

Removing example_redis_1 ... done

Removing network default

Key Concept

If you remember nothing else from this pattern, remember: Docker Compose lets you start and stop multiple related containers together easily inside Jenkins pipelines.

Common Mistakes

Running 'docker-compose up' without the -d flag in Jenkins pipeline

This blocks the pipeline because containers run in the foreground and Jenkins waits indefinitely.

Always use 'docker-compose up -d' to run containers in detached mode so the pipeline can continue.

Not running 'docker-compose down' after tests

Containers and networks remain running, consuming resources and causing conflicts in future pipeline runs.

Always run 'docker-compose down' at the end of the pipeline to clean up resources.

Not mapping ports in docker-compose.yml

Jenkins or test scripts cannot access the services inside containers if ports are not exposed.

Map necessary ports in the docker-compose.yml file under each service.

Summary

Use 'docker-compose up -d' to start all services in the background during Jenkins pipeline runs.

Check running containers with 'docker-compose ps' to verify services are up.

Clean up all resources with 'docker-compose down' after pipeline steps finish.

Practice

1. What is the main purpose of using docker-compose in Jenkins pipelines?

easy

A. To manage multiple containers together easily

B. To write Jenkins pipeline scripts

C. To build Java applications

D. To deploy Jenkins itself

Solution

1. Step 1: Understand Docker Compose role

   Docker Compose is designed to manage multiple containers as a group, making it easier to start, stop, and configure them together.

2. Step 2: Relate to Jenkins pipelines

   In Jenkins pipelines, Docker Compose helps run multiple related containers needed for testing or deployment in one step.

3. Final Answer:

   To manage multiple containers together easily -> Option A

4. Quick Check:

   Docker Compose = Manage multiple containers [OK]

Hint: Docker Compose groups containers for easy control [OK]

Common Mistakes:

• Confusing Docker Compose with Jenkins scripting
• Thinking it builds applications
• Assuming it deploys Jenkins itself

2. Which command correctly starts services defined in a docker-compose.yml file in detached mode within a Jenkins pipeline?

easy

A. docker-compose start -d

B. docker-compose up -d

C. docker-compose run -d

D. docker-compose exec -d

Solution

1. Step 1: Identify the command to start services

   The correct command to start all services in detached mode is docker-compose up -d. The -d flag runs containers in the background.

2. Step 2: Check other options

   docker-compose start starts existing containers but does not create new ones. docker-compose run runs a one-off container, not the whole set. docker-compose exec runs commands inside running containers, not start them.

3. Final Answer:

   docker-compose up -d -> Option B

4. Quick Check:

   Start services detached = up -d [OK]

Hint: Use 'up -d' to start all services in background [OK]

Common Mistakes:

• Using 'start -d' which is invalid
• Confusing 'run' with 'up'
• Using 'exec' to start containers

3. Given this Jenkins pipeline snippet, what will be the output of the sh step?

stage('Test') {
  steps {
    sh 'docker-compose up -d'
    sh 'docker-compose exec web curl -s http://localhost'
    sh 'docker-compose down'
  }
}

medium

A. Starts containers, runs curl inside 'web' container, then stops containers

B. Only starts containers, no curl command runs

C. Runs curl on host machine, then stops containers

D. Fails because 'docker-compose exec' cannot run in pipeline

Solution

1. Step 1: Analyze each command in the pipeline

   docker-compose up -d starts all services in background. docker-compose exec web curl -s http://localhost runs curl inside the 'web' container. docker-compose down stops and removes containers.

2. Step 2: Understand the sequence and output

   The commands run in order: start containers, execute curl inside 'web', then stop containers. This is the expected behavior in a pipeline.

3. Final Answer:

   Starts containers, runs curl inside 'web' container, then stops containers -> Option A

4. Quick Check:

   Up, exec inside container, down = Starts containers, runs curl inside 'web' container, then stops containers [OK]

Hint: Exec runs commands inside containers after 'up' [OK]

Common Mistakes:

• Thinking exec runs on host, not inside container
• Assuming curl won't run
• Believing exec can't run in pipeline

4. You wrote this Jenkins pipeline step:

sh 'docker-compose exec web curl http://localhost'

But it fails with "No such container: web" error. What is the most likely cause?

medium

A. The docker-compose.yml file is missing

B. The curl command is incorrect

C. docker-compose exec cannot run curl

D. The 'web' container is not running yet

Solution

1. Step 1: Understand the error message

   "No such container: web" means the container named 'web' is not running or does not exist at the time of the command.

2. Step 2: Identify the cause in pipeline context

   If the container is not started before the exec command, this error occurs. The curl command or docker-compose.yml presence is unrelated to this specific error.

3. Final Answer:

   The 'web' container is not running yet -> Option D

4. Quick Check:

   Exec needs running container = The 'web' container is not running yet [OK]

Hint: Start containers before exec commands [OK]

Common Mistakes:

• Blaming curl command syntax
• Assuming exec can't run curl
• Ignoring container start step

5. You want to run integration tests inside a Jenkins pipeline using Docker Compose. The tests run inside a container named app. Which pipeline snippet correctly starts services, runs tests inside app, and then cleans up?

hard

A. sh 'docker-compose exec app ./run-tests.sh'
sh 'docker-compose up -d'
sh 'docker-compose down'

B. sh 'docker-compose run app ./run-tests.sh'
sh 'docker-compose up -d'
sh 'docker-compose down'

C. sh 'docker-compose up -d'
sh 'docker-compose exec app ./run-tests.sh'
sh 'docker-compose down'

D. sh 'docker-compose down'
sh 'docker-compose up -d'
sh 'docker-compose exec app ./run-tests.sh'

Solution

1. Step 1: Start services before running tests

   Services must be started with docker-compose up -d before running commands inside containers.

2. Step 2: Run tests inside the 'app' container

   Use docker-compose exec app ./run-tests.sh to execute tests inside the running 'app' container.

3. Step 3: Clean up containers after tests

   Finally, stop and remove containers with docker-compose down to free resources.

4. Final Answer:

   sh 'docker-compose up -d' sh 'docker-compose exec app ./run-tests.sh' sh 'docker-compose down' -> Option C

5. Quick Check:

   Up, exec test, down = sh 'docker-compose up -d' sh 'docker-compose exec app ./run-tests.sh' sh 'docker-compose down' [OK]

Hint: Always start containers before exec, then clean up [OK]

Common Mistakes:

• Running exec before starting containers
• Using run instead of exec for tests
• Stopping containers before tests run