Docker compose in pipelines in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Docker Compose used for in Jenkins pipelines?

Docker Compose is used to define and run multi-container Docker applications within Jenkins pipelines, allowing easy setup of complex environments for testing or deployment.

beginner

How do you start Docker Compose services in a Jenkins pipeline?

You run the command docker-compose up -d inside a pipeline step to start the services in detached mode.

intermediate

Why should you use docker-compose down in Jenkins pipelines?

Using docker-compose down stops and removes containers, networks, and volumes created by Docker Compose, cleaning up resources after the pipeline finishes.

beginner

What Jenkins pipeline syntax is used to run shell commands like Docker Compose?

The sh step is used in Jenkins pipelines to run shell commands such as docker-compose up -d.

intermediate

How can you ensure Docker Compose commands run only after the Docker service is ready in Jenkins?

You can add a wait or retry logic in the pipeline script or use health checks in Docker Compose to ensure services are ready before proceeding.

Which command starts Docker Compose services in detached mode within a Jenkins pipeline?

A docker-compose run

B docker-compose start

C docker-compose build

D docker-compose up -d

The command docker-compose up -d starts all services defined in the compose file in detached mode.

What is the purpose of docker-compose down in a Jenkins pipeline?

A To stop and remove containers and networks created by Docker Compose

B To build Docker images

C To start containers in the background

D To list running containers

docker-compose down cleans up all resources created by Docker Compose, preventing leftover containers.

In Jenkins pipeline syntax, which step runs shell commands like Docker Compose commands?

A sh

B bat

C script

D docker

The sh step runs shell commands on Unix/Linux agents in Jenkins pipelines.

Why might you add health checks in Docker Compose when used in Jenkins pipelines?

A To speed up container startup

B To ensure services are ready before pipeline steps depend on them

C To automatically update images

D To reduce container size

Health checks help the pipeline wait until services are fully ready before running dependent steps.

Which file does Docker Compose use to define services for Jenkins pipelines?

A config.xml

B Dockerfile

C docker-compose.yml

D Jenkinsfile

Docker Compose uses docker-compose.yml to define multi-container service configurations.

Explain how to integrate Docker Compose commands in a Jenkins pipeline to start and stop services.

Think about starting services before tests and cleaning up after.

Describe why cleaning up Docker Compose resources is important in Jenkins pipelines.

Consider what happens if containers keep running after the pipeline.

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