Node and stage blocks in Jenkins - Step-by-Step Execution

Process Flow - Node and stage blocks

Start Pipeline

↓

Enter node block

↓

Enter stage block

↓

Execute steps inside stage

↓

Exit stage block

↓

More stages?

Yes→Enter next stage block

No↓

Exit node block

↓

Pipeline ends

The pipeline starts, enters a node block to allocate an agent, then runs one or more stage blocks sequentially, executing steps inside each stage, then exits the node and ends.

Execution Sample

Jenkins

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

This pipeline runs on any available agent, enters a 'Build' stage, and prints 'Building...'.

Process Table

Step	Block Entered	Action	Output	Next Step
1	pipeline	Start pipeline execution	Pipeline started	Enter node block
2	node	Allocate agent	Agent allocated	Enter stage 'Build'
3	stage 'Build'	Run steps	Prints 'Building...'	Exit stage 'Build'
4	stage 'Build'	Exit stage block	Stage 'Build' completed	Check for more stages
5	node	Exit node block	Agent released	Pipeline ends
6	pipeline	End pipeline	Pipeline finished	Stop execution

💡 Pipeline ends after all stages run and node block exits

Status Tracker

Variable	Start	After Step 2	After Step 3	After Step 5	Final
agentAllocated	false	true	true	false	false
currentStage	none	Build	Build	none	none
pipelineStatus	not started	running	running	running	finished

Key Moments - 3 Insights

Why do we need a node block before stages?

The node block allocates an agent (a machine) where the stages run. Without it, the pipeline has no place to execute commands. See execution_table step 2 where agent allocation happens before stages.

Can stages run outside a node block?

No, stages must be inside a node block to run on an agent. The execution flow shows stages inside the node block (steps 3 and 4).

What happens after all stages complete?

After all stages finish, the node block exits releasing the agent (step 5), then the pipeline ends (step 6). This ensures resources are freed.

Visual Quiz - 3 Questions

Look at the execution table, at which step is the agent allocated?

A Step 3

B Step 1

C Step 2

D Step 5

💡 Hint

Check the 'Action' column for 'Allocate agent' in the execution_table.

At which step does the pipeline print 'Building...'?

A Step 3

B Step 2

C Step 4

D Step 5

💡 Hint

Look for 'Run steps' and output 'Prints Building...' in execution_table.

If we add another stage after 'Build', which step would change?

A Step 3

B Step 4

C Step 5

D Step 6

💡 Hint

Adding stages affects the 'Check for more stages' step in execution_table.

Concept Snapshot

pipeline {
  agent any
  stages {
    stage('Name') {
      steps { ... }
    }
  }
}

- node block allocates agent
- stages run inside node
- steps execute commands
- pipeline ends after stages

Full Transcript

This visual execution shows how a Jenkins pipeline runs using node and stage blocks. First, the pipeline starts and enters a node block to allocate an agent machine. Then it enters a stage block named 'Build' and runs the steps inside, printing 'Building...'. After the stage completes, the pipeline checks for more stages. If none remain, it exits the node block, releasing the agent, and ends the pipeline. Variables like agentAllocated and currentStage track the state changes. Key points include that stages must run inside a node block to have an agent, and the pipeline ends only after all stages and node exit. The quizzes test understanding of when agent allocation and stage execution happen, and how adding stages affects the flow.

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