Docker agents for isolation in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Docker agent in Jenkins?

A Docker agent in Jenkins is a container that runs a Jenkins build or job isolated from the main Jenkins server. It provides a clean environment for each build.

beginner

Why use Docker agents for isolation in Jenkins?

Docker agents isolate builds so they don't affect each other or the main server. This helps avoid conflicts and keeps builds clean and repeatable.

intermediate

How do you specify a Docker agent in a Jenkins pipeline?

You specify a Docker agent in the pipeline using the 'agent' block with 'docker' and the image name, for example: agent { docker { image 'python:3.12' } }

beginner

What happens to the Docker container after the Jenkins job finishes?

The Docker container used as an agent is stopped and removed automatically, ensuring no leftover state affects future builds.

intermediate

Can Docker agents use custom Docker images?

Yes, you can use any Docker image as an agent, including custom images with pre-installed tools needed for your build.

What is the main benefit of using Docker agents in Jenkins?

A Isolate builds to avoid conflicts

B Speed up the Jenkins server hardware

C Store build logs permanently

D Automatically write code

Docker agents isolate builds so they run in clean environments, preventing conflicts.

How do you define a Docker agent in a Jenkins pipeline?

A agent docker image 'node:latest'

B agent { docker { image 'node:latest' } }

C docker agent { image 'node:latest' }

D pipeline { docker agent 'node:latest' }

The correct syntax uses the 'agent' block with 'docker' and 'image' keys.

What happens to the Docker container after the Jenkins job completes?

A It stays running for reuse

B It crashes intentionally

C It is stopped and removed

D It is saved as a new image

Docker containers used as agents are stopped and removed to keep the environment clean.

Can you use a custom Docker image as a Jenkins agent?

A No, only official images are allowed

B Only images without tools can be used

C Only images from Docker Hub can be used

D Yes, any Docker image can be used

Jenkins supports any Docker image as an agent, including custom ones.

Which of these is NOT a reason to use Docker agents in Jenkins?

A Faster build execution by skipping tests

B Consistent build environment

C Build isolation

D Easy cleanup after builds

Skipping tests is unrelated to Docker agents; agents focus on isolation and environment consistency.

Explain how Docker agents help maintain clean build environments in Jenkins.

Think about how a new room is cleaned before a new guest arrives.

Describe the steps to configure a Docker agent in a Jenkins pipeline.

Focus on the pipeline syntax for Docker agents.

Practice

1. What is the main benefit of using Docker agents in Jenkins for running jobs?

easy

A. They provide isolated environments to avoid conflicts between builds.

B. They speed up the Jenkins UI loading time.

C. They allow Jenkins to run without any plugins installed.

D. They automatically backup Jenkins configuration files.

Solution

1. Step 1: Understand Docker agent purpose

   Docker agents run Jenkins jobs inside containers, isolating each build environment.

2. Step 2: Identify the benefit of isolation

   This isolation prevents conflicts and keeps builds clean and reproducible.

3. Final Answer:

   They provide isolated environments to avoid conflicts between builds. -> Option A

4. Quick Check:

   Docker agents = isolated environments [OK]

Hint: Docker agents isolate builds to avoid conflicts [OK]

Common Mistakes:

• Thinking Docker agents speed up Jenkins UI
• Believing Docker agents remove need for plugins
• Assuming Docker agents backup Jenkins configs

2. Which of the following is the correct syntax to specify a Docker agent with image python:3.12 in a Jenkins pipeline?

easy

A. agent { docker { image 'python:3.12' } }

B. agent { docker.image('python:3.12') }

C. agent { docker('python:3.12') }

D. agent { docker { image: 'python:3.12' } }

Solution

1. Step 1: Recall Jenkins pipeline Docker agent syntax

   The correct syntax uses agent { docker { image 'image_name' } } format.

2. Step 2: Match the syntax with options

   agent { docker { image 'python:3.12' } } matches the correct syntax exactly with single quotes and no colon.

3. Final Answer:

   agent { docker { image 'python:3.12' } } -> Option A

4. Quick Check:

   Correct Docker agent syntax = agent { docker { image 'python:3.12' } } [OK]

Hint: Use agent { docker { image 'name' } } syntax [OK]

Common Mistakes:

• Using dot notation instead of block syntax
• Adding colon inside image declaration
• Using parentheses incorrectly

3. Given this Jenkins pipeline snippet:

pipeline {
  agent {
    docker {
      image 'node:18'
      args '-p 3000:3000'
    }
  }
  stages {
    stage('Run') {
      steps {
        sh 'node -v'
      }
    }
  }
}

What will be the output of the sh 'node -v' command?

medium

A. No output, command skipped

B. Error: node command not found

C. v12.x.x (Node.js version 12 output)

D. v18.x.x (Node.js version 18 output)

Solution

1. Step 1: Identify Docker image used

   The pipeline uses the Docker image node:18, which includes Node.js version 18.

2. Step 2: Understand command execution inside container

   The sh 'node -v' runs inside the container, so it will output Node.js version 18.

3. Final Answer:

   v18.x.x (Node.js version 18 output) -> Option D

4. Quick Check:

   Docker image node:18 runs Node.js v18 [OK]

Hint: Command runs inside specified Docker image environment [OK]

Common Mistakes:

• Assuming host Node.js version runs instead
• Expecting error due to missing node
• Confusing image tag with different Node version

4. You wrote this Jenkins pipeline snippet to use a Docker agent:

pipeline {
  agent {
    docker {
      image 'ubuntu:latest'
      args '-v /var/run/docker.sock:/var/run/docker.sock'
    }
  }
  stages {
    stage('Test') {
      steps {
        sh 'docker ps'
      }
    }
  }
}

But the build fails with docker: command not found. What is the likely cause?

medium

A. The Jenkins agent cannot mount volumes.

B. The ubuntu:latest image does not have Docker installed.

C. The args option is incorrect syntax.

D. The docker ps command is invalid inside containers.

Solution

1. Step 1: Check the Docker image capabilities

   The ubuntu:latest image is a minimal OS image and does not include Docker by default.

2. Step 2: Understand why command fails

   Since Docker is not installed inside the container, docker ps command is not found, causing the error.

3. Final Answer:

   The ubuntu:latest image does not have Docker installed. -> Option B

4. Quick Check:

   Missing Docker in image = command not found error [OK]

Hint: Check if Docker is installed inside the container image [OK]

Common Mistakes:

• Blaming volume mount syntax
• Assuming docker commands always work in containers
• Thinking docker ps is invalid inside containers

5. You want to run a Jenkins job inside a Docker container with a custom environment variable MY_VAR=hello and mount the workspace directory to /app inside the container. Which Jenkins pipeline snippet correctly sets this up?

hard

A. agent { docker { image 'python:3.12' args '-e MY_VAR=hello -v /app:$WORKSPACE' } }

B. agent { docker { image 'python:3.12' args '-v $WORKSPACE:/app -e MY_VAR=hello' } }

C. agent { docker { image 'python:3.12' args '-e MY_VAR=hello -v $WORKSPACE:/app' } }

D. agent { docker { image 'python:3.12' args '-v /app -e MY_VAR=hello' } }

Solution

1. Step 1: Understand Docker args for environment and volume

   To set environment variables, use -e VAR=value. To mount volumes, use -v host_path:container_path.

2. Step 2: Match correct volume and env var syntax

   agent { docker { image 'python:3.12' args '-e MY_VAR=hello -v $WORKSPACE:/app' } } correctly uses -e MY_VAR=hello and mounts $WORKSPACE to /app inside container.

3. Final Answer:

   agent { docker { image 'python:3.12' args '-e MY_VAR=hello -v $WORKSPACE:/app' } } -> Option C

4. Quick Check:

   Env var and volume mount syntax = agent { docker { image 'python:3.12' args '-e MY_VAR=hello -v $WORKSPACE:/app' } } [OK]

Hint: Use '-e VAR=value' and '-v host:container' in args [OK]

Common Mistakes:

• Reversing volume mount paths
• Omitting environment variable flag
• Incorrect order or missing colon in volume