Node and stage blocks in Jenkins - Commands & Configuration

Introduction

When you automate software builds and tests, you need to organize tasks clearly and decide where they run. Node blocks tell Jenkins which machine to use, and stage blocks divide the work into clear steps.

When you want to run your build on a specific machine or environment.

When you want to split your pipeline into clear steps like build, test, and deploy.

When you want to see progress and results for each step separately in Jenkins.

When you want to control resources by choosing which node runs which part of the pipeline.

When you want to make your pipeline easier to read and maintain.

Config File - Jenkinsfile

Jenkinsfile

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building the application'
      }
    }
    stage('Test') {
      steps {
        echo 'Running tests'
      }
    }
    stage('Deploy') {
      steps {
        echo 'Deploying the application'
      }
    }
  }
}

This Jenkinsfile defines a pipeline with three stages: Build, Test, and Deploy.

The agent any means Jenkins can run this pipeline on any available node.

Each stage block groups related steps, making the pipeline organized and easy to follow.

Commands

Check that Jenkins CLI or Jenkins environment is ready to run pipelines.

Terminal

jenkins-jobs --version

Expected Output

2.319.1

Start the Jenkins pipeline named 'my-pipeline' which uses node and stage blocks to organize tasks.

Terminal

jenkins-cli build my-pipeline

Expected Output

[Pipeline] Start of Pipeline

[Pipeline] node

Running on Jenkins-agent-1 in /var/jenkins_home/workspace/my-pipeline

[Pipeline] stage

[Pipeline] { (Build)

[Pipeline] echo

Building the application

[Pipeline] }

[Pipeline] stage

[Pipeline] { (Test)

[Pipeline] echo

Running tests

[Pipeline] }

[Pipeline] stage

[Pipeline] { (Deploy)

[Pipeline] echo

Deploying the application

[Pipeline] }

[Pipeline] End of Pipeline

Finished: SUCCESS

View the console output of the pipeline to see the progress and results of each stage.

Terminal

jenkins-cli console my-pipeline

Expected Output

[Pipeline] Start of Pipeline

[Pipeline] node

Running on Jenkins-agent-1

[Pipeline] stage

[Pipeline] { (Build)

Building the application

[Pipeline] }

[Pipeline] stage

[Pipeline] { (Test)

Running tests

[Pipeline] }

[Pipeline] stage

[Pipeline] { (Deploy)

Deploying the application

[Pipeline] }

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

If you remember nothing else from this pattern, remember: node blocks choose where to run, and stage blocks organize what to run in clear steps.

Common Mistakes

Not wrapping steps inside stage blocks

Without stage blocks, the pipeline lacks clear steps, making it hard to track progress and debug.

Always group related steps inside stage blocks to organize the pipeline.

Using node blocks incorrectly or missing them

Without node blocks, Jenkins doesn't know which machine to run the tasks on, causing pipeline failures.

Use node blocks to specify the agent or machine where the pipeline or stages run.

Using 'agent any' but expecting tasks to run on a specific machine

'agent any' lets Jenkins pick any available node, which may not have required tools or environment.

Specify a particular node label in the agent block if you need a specific machine.

Summary

Node blocks tell Jenkins which machine or agent to use for running tasks.

Stage blocks divide the pipeline into clear, named steps for better organization and tracking.

Using node and stage blocks together makes pipelines easier to read, maintain, and debug.

Practice

1. What is the main purpose of a node block in a Jenkins pipeline?

easy

A. To declare environment variables for the pipeline

B. To define a named step grouping in the pipeline

C. To specify the machine or agent where the pipeline steps run

D. To send notifications after the pipeline finishes

Solution

1. Step 1: Understand the role of node block

   The node block tells Jenkins which machine or agent will run the enclosed commands.

2. Step 2: Differentiate from stage block

   The stage block is for grouping steps with a name, not for selecting the machine.

3. Final Answer:

   To specify the machine or agent where the pipeline steps run -> Option C

4. Quick Check:

   Node block = machine selection [OK]

Hint: Node block = where commands run, stage block = what step runs [OK]

Common Mistakes:

• Confusing node with stage blocks
• Thinking node defines step names
• Assuming node sets environment variables

2. Which of the following is the correct syntax to define a stage inside a Jenkins pipeline?

easy

A. stage: Build { echo 'Building...' }

B. node('Build') { echo 'Building...' }

C. steps { stage('Build') { echo 'Building...' } }

D. stage('Build') { steps { echo 'Building...' } }

Solution

1. Step 1: Recall correct stage syntax

   The correct syntax uses stage('name') { steps { ... } } to define a stage with steps inside.

2. Step 2: Check each option

   stage('Build') { steps { echo 'Building...' } } matches the correct syntax. Options A, B, and D misuse keywords or structure.

3. Final Answer:

   stage('Build') { steps { echo 'Building...' } } -> Option D

4. Quick Check:

   Stage syntax = stage('name') { steps { ... } } [OK]

Hint: Stage blocks use stage('name') with steps inside [OK]

Common Mistakes:

• Using node instead of stage for grouping steps
• Missing steps block inside stage
• Incorrect colon or braces placement

3. Given the Jenkins pipeline snippet below, what will be the output?

pipeline {
  agent any
  stages {
    stage('Example') {
      steps {
        node('linux') {
          echo 'Running on Linux node'
        }
      }
    }
  }
}

medium

A. Running on Linux node

B. Syntax error due to nested node inside steps

C. Pipeline runs but no output is shown

D. Error: agent and node blocks cannot be combined

Solution

1. Step 1: Analyze pipeline structure

   The pipeline uses agent any globally and inside the stage steps calls node('linux') to run commands on a Linux node.

2. Step 2: Understand nested node usage

   Nested node blocks inside steps are allowed in scripted pipelines; here it will run the echo command on the specified node.

3. Final Answer:

   Running on Linux node -> Option A

4. Quick Check:

   Nested node runs commands on specified agent [OK]

Hint: Nested node inside steps runs commands on chosen agent [OK]

Common Mistakes:

• Assuming nested node causes syntax error
• Thinking agent any forbids node blocks
• Expecting no output from echo

4. Identify the error in this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Test') {
      node {
        steps {
          echo 'Testing...'
        }
      }
    }
  }
}

medium

A. The node block is incorrectly placed inside stage

B. Missing agent inside the stage block

C. The steps block should be outside node

D. The echo command is invalid inside steps

Solution

1. Step 1: Review pipeline block structure

   Declarative pipelines require agent to specify where stages run; node is not valid inside stage in declarative syntax.

2. Step 2: Identify correct usage

   Instead of node, the stage should have an agent block or rely on global agent any.

3. Final Answer:

   The node block is incorrectly placed inside stage -> Option A

4. Quick Check:

   Declarative stage needs agent, not node [OK]

Hint: Use agent, not node, inside declarative stage blocks [OK]

Common Mistakes:

• Using node block inside declarative stage
• Confusing steps placement
• Thinking echo is invalid inside steps

5. You want to run two stages in your Jenkins pipeline: 'Build' on a Linux node and 'Test' on a Windows node. Which pipeline snippet correctly uses node and stage blocks to achieve this?

hard

A. pipeline {
agent none
stages {
stage('Build') {
steps {
node('linux') {
echo 'Building on Linux'
}
}
}
stage('Test') {
steps {
node('windows') {
echo 'Testing on Windows'
}
}
}
}
}

B. pipeline {
agent any
stages {
stage('Build') {
agent { label 'linux' }
steps {
echo 'Building on Linux'
}
}
stage('Test') {
agent { label 'windows' }
steps {
echo 'Testing on Windows'
}
}
}
}

C. pipeline {
agent any
stages {
stage('Build') {
node('linux') {
steps {
echo 'Building on Linux'
}
}
}
stage('Test') {
node('windows') {
steps {
echo 'Testing on Windows'
}
}
}
}
}

D. pipeline {
agent none
stages {
stage('Build') {
agent { label 'windows' }
steps {
echo 'Building on Linux'
}
}
stage('Test') {
agent { label 'linux' }
steps {
echo 'Testing on Windows'
}
}
}
}

Solution

1. Step 1: Understand declarative pipeline agent usage

   In declarative pipelines, use agent { label 'name' } inside stages to specify the node label.

2. Step 2: Evaluate each option

   pipeline { agent any stages { stage('Build') { agent { label 'linux' } steps { echo 'Building on Linux' } } stage('Test') { agent { label 'windows' } steps { echo 'Testing on Windows' } } } } correctly uses agent inside each stage with labels 'linux' and 'windows'. pipeline { agent none stages { stage('Build') { steps { node('linux') { echo 'Building on Linux' } } } stage('Test') { steps { node('windows') { echo 'Testing on Windows' } } } } } misuses node inside steps in declarative style. pipeline { agent any stages { stage('Build') { node('linux') { steps { echo 'Building on Linux' } } } stage('Test') { node('windows') { steps { echo 'Testing on Windows' } } } } } uses node blocks incorrectly inside stage. pipeline { agent none stages { stage('Build') { agent { label 'windows' } steps { echo 'Building on Linux' } } stage('Test') { agent { label 'linux' } steps { echo 'Testing on Windows' } } } } swaps labels incorrectly.

3. Final Answer:

   Option B uses agent labels correctly inside stages -> Option B

4. Quick Check:

   Use agent { label } inside stages for node selection [OK]

Hint: Use agent { label 'name' } inside stages, not node blocks [OK]

Common Mistakes:

• Using node blocks inside declarative stages
• Swapping node labels by mistake
• Not setting agent none when using stage agents