Agent availability and offline handling in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Jenkins agent?

A Jenkins agent is a machine or environment that runs jobs assigned by the Jenkins master. It helps distribute workload and run builds or tests.

beginner

What does it mean when a Jenkins agent is offline?

An offline agent is not connected to the Jenkins master and cannot run any jobs until it reconnects.

intermediate

How can Jenkins handle an agent that goes offline during a build?

Jenkins can retry the build on another available agent or mark the build as failed depending on the configuration.

intermediate

What is the purpose of the 'Availability' setting for a Jenkins agent?

It controls when the agent should be online or offline, such as always online, only when jobs are assigned, or manually controlled.

beginner

How can you manually bring a Jenkins agent back online?

In the Jenkins UI, go to the agent's page and click the 'Launch agent' or 'Bring Online' button to reconnect it to the master.

What happens when a Jenkins agent goes offline?

A It stops running jobs until it reconnects

B It continues running jobs normally

C It automatically deletes all jobs

D It becomes the Jenkins master

An offline agent cannot run jobs until it reconnects to the Jenkins master.

Which Jenkins feature helps manage when an agent is online or offline?

A Job Parameters

B Agent Availability settings

C Pipeline Syntax

D Build Triggers

Agent Availability settings control when agents are online or offline.

If an agent goes offline during a build, what can Jenkins do?

A Delete the build history

B Ignore the failure and continue

C Automatically restart the Jenkins master

D Retry the build on another agent or fail the build

Jenkins can retry the build on another agent or mark it as failed depending on configuration.

How do you manually bring a Jenkins agent back online?

A Click 'Bring Online' in the agent's Jenkins UI page

B Restart the Jenkins master

C Delete and recreate the agent

D Run a Jenkins pipeline

You can manually reconnect an agent by clicking 'Bring Online' in its Jenkins UI page.

What is the role of a Jenkins agent?

A To manage user permissions

B To store Jenkins configuration files

C To run jobs assigned by the Jenkins master

D To host the Jenkins web interface

Jenkins agents run jobs assigned by the Jenkins master to distribute workload.

Explain what happens when a Jenkins agent goes offline and how Jenkins handles it.

Think about connection and job execution.

Describe how to manually bring a Jenkins agent back online and why you might need to do this.

Focus on manual reconnection steps.

Practice

1. What does it mean when a Jenkins agent is marked as offline?

easy

A. The agent is connected and ready to accept jobs.

B. The agent is not available to run any jobs.

C. The agent is running a job currently.

D. The agent is permanently deleted from Jenkins.

Solution

1. Step 1: Understand agent status meaning

   In Jenkins, an agent marked offline means it is not available to run jobs.

2. Step 2: Differentiate from other statuses

   Online agents are connected and ready; offline means unavailable temporarily or for maintenance.

3. Final Answer:

   The agent is not available to run any jobs. -> Option B

4. Quick Check:

   Offline agent = unavailable [OK]

Hint: Offline means agent can't run jobs now [OK]

Common Mistakes:

• Confusing offline with running a job
• Thinking offline means deleted
• Assuming offline means ready

2. Which of the following is the correct way to mark a Jenkins agent as offline using the Jenkins CLI?

easy

A. jenkins-cli offline-agent --name agent1

B. java -jar jenkins-cli.jar offline-agent agent1

C. java -jar jenkins-cli.jar offline-agent --agent agent1

D. java -jar jenkins-cli.jar disconnect-node agent1

Solution

1. Step 1: Recall Jenkins CLI command for offline

   The correct command to mark an agent offline is disconnect-node with the agent name as argument.

2. Step 2: Check syntax correctness

   Options A, B, and C use incorrect commands or flags; only java -jar jenkins-cli.jar disconnect-node agent1 uses the correct command and syntax.

3. Final Answer:

   java -jar jenkins-cli.jar disconnect-node agent1 -> Option D

4. Quick Check:

   disconnect-node command marks offline [OK]

Hint: Use 'disconnect-node' command with agent name [OK]

Common Mistakes:

• Using wrong command names like offline-agent
• Adding incorrect flags
• Confusing CLI syntax

3. Given this Jenkins pipeline snippet:

node('agent1') {
  echo "Agent status: ${env.NODE_NAME}"
}

If agent1 is offline, what will happen when this pipeline runs?

medium

A. The pipeline will fail immediately with an error.

B. The pipeline will run on the master node instead.

C. The pipeline will wait until agent1 comes online.

D. The pipeline will skip the node block and continue.

Solution

1. Step 1: Understand node block behavior

   The node('agent1') block waits for the specified agent to be available before running.

2. Step 2: Check what happens if agent is offline

   If agent1 is offline, Jenkins will wait until it comes online or timeout occurs.

3. Final Answer:

   The pipeline will wait until agent1 comes online. -> Option C

4. Quick Check:

   node waits for agent online [OK]

Hint: node waits for specified agent to be online [OK]

Common Mistakes:

• Assuming pipeline fails immediately
• Thinking it runs on master automatically
• Believing it skips the node block

4. You have a Jenkins agent that should be offline for maintenance, but jobs are still assigned to it. What is the most likely cause?

medium

A. The agent was not properly marked offline in Jenkins configuration.

B. The agent is offline but Jenkins is ignoring the status due to a plugin bug.

C. The agent was marked offline but the 'Accept tasks' option is still enabled.

D. The jobs are configured to run only on the master node.

Solution

1. Step 1: Check agent offline marking

   If jobs are still assigned, likely the agent was not properly marked offline in Jenkins UI or configuration.

2. Step 2: Eliminate other causes

   The agent was marked offline but the 'Accept tasks' option is still enabled. is incorrect because offline agents do not accept tasks; The agent is offline but Jenkins is ignoring the status due to a plugin bug. is rare; The jobs are configured to run only on the master node. is unrelated.

3. Final Answer:

   The agent was not properly marked offline in Jenkins configuration. -> Option A

4. Quick Check:

   Proper offline marking stops job assignment [OK]

Hint: Ensure agent is correctly marked offline in Jenkins UI [OK]

Common Mistakes:

• Assuming offline agent still accepts tasks
• Blaming plugins without checking config
• Confusing job node assignment

5. You want to create a Jenkins pipeline that automatically skips running on an agent if it is offline and instead runs on the master node. Which scripted pipeline snippet achieves this?

hard

A. if (Jenkins.instance.getNode('agent1').toComputer().isOnline()) {
node('agent1') { echo 'Running on agent1' }
} else {
node('master') { echo 'Running on master' }
}

B. node('agent1') {
if (agent1.isOnline()) {
echo 'Running on agent1'
} else {
node('master') { echo 'Running on master' }
}
}

C. try {
node('agent1') { echo 'Running on agent1' }
} catch (Exception e) {
node('master') { echo 'Running on master' }
}

D. node('agent1') {
echo 'Running on agent1'
}
node('master') {
echo 'Running on master'
}

Solution

1. Step 1: Check agent online status in pipeline

   if (Jenkins.instance.getNode('agent1').toComputer().isOnline()) { node('agent1') { echo 'Running on agent1' } } else { node('master') { echo 'Running on master' } } correctly checks if 'agent1' is online using Jenkins API before choosing node.

2. Step 2: Verify fallback to master node

   If agent1 is offline, if (Jenkins.instance.getNode('agent1').toComputer().isOnline()) { node('agent1') { echo 'Running on agent1' } } else { node('master') { echo 'Running on master' } } runs the job on 'master' node, matching the requirement.

3. Step 3: Analyze other options

   node('agent1') { if (agent1.isOnline()) { echo 'Running on agent1' } else { node('master') { echo 'Running on master' } } } uses invalid syntax; try { node('agent1') { echo 'Running on agent1' } } catch (Exception e) { node('master') { echo 'Running on master' } } relies on exception which is not best practice; node('agent1') { echo 'Running on agent1' } node('master') { echo 'Running on master' } runs both nodes unconditionally.

4. Final Answer:

   if (Jenkins.instance.getNode('agent1').toComputer().isOnline()) { node('agent1') { echo 'Running on agent1' } } else { node('master') { echo 'Running on master' } } -> Option A

5. Quick Check:

   Check agent online status before node selection [OK]

Hint: Check agent online status via Jenkins API before node [OK]

Common Mistakes:

• Using invalid syntax to check agent status
• Relying on exceptions to handle offline agents
• Running both nodes regardless of status