Agent directive in Jenkins - Commands & Configuration

Introduction

When running automated tasks in Jenkins, you need to tell it where to run those tasks. The agent directive tells Jenkins which machine or environment to use for running your pipeline steps.

When you want your Jenkins pipeline to run on a specific machine or container.

When you need to run different parts of your pipeline on different environments.

When you want to use a Docker container as the environment for your build.

When you want to run your pipeline on the Jenkins master node itself.

When you want to avoid running your pipeline on any node and just run it locally.

Config File - Jenkinsfile

Jenkinsfile

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building the project'
            }
        }
    }
}

pipeline: Defines the Jenkins pipeline.

agent any: Tells Jenkins to run this pipeline on any available agent.

stages: Contains the steps to run.

stage('Build'): A step group named Build.

steps: Commands to execute inside the stage.

Commands

This command updates the Jenkins job configuration with the Jenkinsfile containing the agent directive. It tells Jenkins where to run the pipeline.

Terminal

jenkins-jobs --conf jenkins.ini update Jenkinsfile

Expected Output

Job updated successfully

Starts the Jenkins pipeline named 'my-pipeline' which uses the agent directive to select the node for running the build.

Terminal

jenkins-cli build my-pipeline

Expected Output

Started build #1

Shows the console output of the first build of 'my-pipeline' to verify the pipeline ran on the selected agent.

Terminal

jenkins-cli console my-pipeline #1

Expected Output

[Pipeline] Start of Pipeline

[Pipeline] echo

Building the project

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

The agent directive tells Jenkins where to run your pipeline steps, choosing the right machine or environment for your tasks.

Common Mistakes

Not specifying an agent directive in the Jenkinsfile.

Jenkins will not know where to run the pipeline and will fail with an error.

Always include an agent directive like 'agent any' or specify a particular agent.

Using 'agent none' without defining agents for individual stages.

The pipeline will have no environment to run in and will fail unless each stage has its own agent.

Use 'agent none' only if you define agents inside each stage.

Summary

The agent directive in Jenkinsfile defines where the pipeline runs.

Use 'agent any' to run on any available Jenkins node.

You can specify agents per stage or for the whole pipeline.

Practice

1. What does the agent directive specify in a Jenkins pipeline?

easy

A. The build triggers for the pipeline

B. The version of Jenkins to use

C. The environment variables for the pipeline

D. Where the pipeline or stage should run

Solution

1. Step 1: Understand the role of agent

   The agent directive tells Jenkins where to run the pipeline or a specific stage.

2. Step 2: Compare other options

   Options A, B, and C relate to Jenkins configuration but not the agent directive.

3. Final Answer:

   Where the pipeline or stage should run -> Option D

4. Quick Check:

   Agent directive = run location [OK]

Hint: Agent means where to run your pipeline or stage [OK]

Common Mistakes:

• Confusing agent with environment variables
• Thinking agent sets build triggers
• Assuming agent defines Jenkins version

2. Which of the following is the correct syntax to specify that a Jenkins pipeline should run on any available agent?

easy

A. agent any

B. agent: any

C. agent = any

D. agent: 'any'

Solution

1. Step 1: Recall correct Jenkins pipeline syntax

   The correct syntax to specify any available agent is agent any without colons or equals.

2. Step 2: Analyze other options

   Options A, B, and D use incorrect punctuation or quotes not valid in declarative pipeline syntax.

3. Final Answer:

   agent any -> Option A

4. Quick Check:

   Correct syntax for any agent = agent any [OK]

Hint: Use 'agent any' without punctuation for any agent [OK]

Common Mistakes:

• Adding colons or equals signs incorrectly
• Using quotes around any
• Confusing declarative syntax with scripted syntax

3. Given this Jenkins pipeline snippet, what agent will the Build stage run on?

pipeline {
  agent none
  stages {
    stage('Build') {
      agent { label 'linux' }
      steps {
        echo 'Building on Linux agent'
      }
    }
  }
}

medium

A. Agent with label 'linux'

B. Any available agent

C. No agent, pipeline will fail

D. Agent with label 'windows'

Solution

1. Step 1: Understand agent none at pipeline level

   The pipeline disables default agent allocation with agent none.

2. Step 2: Check stage-level agent directive

   The Build stage specifies agent { label 'linux' }, so it runs on an agent labeled 'linux'.

3. Final Answer:

   Agent with label 'linux' -> Option A

4. Quick Check:

   Stage agent label 'linux' overrides pipeline none [OK]

Hint: Stage agent label overrides pipeline agent none [OK]

Common Mistakes:

• Assuming pipeline agent none means no agent anywhere
• Confusing label names
• Thinking default agent applies despite agent none

4. Identify the error in this Jenkins pipeline snippet:

pipeline {
  agent {
    label docker
  }
  stages {
    stage('Test') {
      steps {
        echo 'Testing...'
      }
    }
  }
}

medium

A. Incorrect agent block syntax, should be agent { label 'docker' }

B. Missing quotes around label name

C. Agent directive cannot use label

D. Pipeline missing stages block

Solution

1. Step 1: Review agent block syntax

   The label value must be enclosed in quotes, like label 'docker'.

2. Step 2: Identify syntax error

   The snippet has label docker without quotes, causing a syntax error as docker is treated as an undefined variable.

3. Final Answer:

   Missing quotes around label name -> Option B

4. Quick Check:

   Agent block syntax must be exact [OK]

Hint: Agent block must be exactly agent { label 'name' } [OK]

Common Mistakes:

• Misplacing braces or indentation
• Using agent label without braces
• Confusing agent label with docker agent syntax

5. You want a Jenkins pipeline that does not allocate any agent by default but runs the Deploy stage on a Docker container with image nginx:latest. Which pipeline snippet correctly achieves this?

hard

A. pipeline {
agent any
stages {
stage('Deploy') {
agent none
steps {
echo 'Deploying with nginx container'
}
}
}
}

B. pipeline {
agent { docker { image 'nginx:latest' } }
stages {
stage('Deploy') {
steps {
echo 'Deploying with nginx container'
}
}
}
}

C. pipeline {
agent none
stages {
stage('Deploy') {
agent { docker { image 'nginx:latest' } }
steps {
echo 'Deploying with nginx container'
}
}
}
}

D. pipeline {
agent none
stages {
stage('Deploy') {
agent { label 'nginx:latest' }
steps {
echo 'Deploying with nginx container'
}
}
}
}

Solution

1. Step 1: Disable default agent allocation

   Using agent none at pipeline level disables default agent allocation.

2. Step 2: Specify Docker agent for Deploy stage

   The Deploy stage uses agent { docker { image 'nginx:latest' } } to run inside the nginx Docker container.

3. Step 3: Verify other options

   pipeline { agent { docker { image 'nginx:latest' } } stages { stage('Deploy') { steps { echo 'Deploying with nginx container' } } } } runs entire pipeline in Docker, not just Deploy stage. pipeline { agent any stages { stage('Deploy') { agent none steps { echo 'Deploying with nginx container' } } } } wrongly uses agent none inside stage with agent any pipeline. pipeline { agent none stages { stage('Deploy') { agent { label 'nginx:latest' } steps { echo 'Deploying with nginx container' } } } } uses label instead of docker image.

4. Final Answer:

   Pipeline with agent none and stage agent docker image nginx:latest -> Option C

5. Quick Check:

   agent none + stage docker agent = correct [OK]

Hint: Use agent none globally, docker agent per stage [OK]

Common Mistakes:

• Using agent any globally when none is needed
• Misusing label instead of docker image
• Placing agent none inside stage incorrectly