Labels for agent selection in Jenkins - Commands & Configuration

Introduction

When you run Jenkins jobs, you want them to run on specific machines or environments. Labels help Jenkins pick the right machine (agent) to run your job based on what that machine can do.

When you have multiple Jenkins agents with different software installed and want jobs to run only where compatible tools exist

When you want to separate jobs by operating system, like running Windows jobs on Windows agents and Linux jobs on Linux agents

When you want to dedicate certain agents for heavy tasks and others for light tasks

When you want to control job distribution to avoid overloading a single agent

When you want to test your application on different environments automatically

Commands

This command starts a Jenkins agent and assigns it the labels 'linux' and 'java' so Jenkins knows this agent can run jobs requiring these labels.

Terminal

jenkins-agent --labels linux,java

Expected Output

INFO: Agent started with labels: linux, java

INFO: Connected to Jenkins master

→

--labels - Assigns labels to the agent for job selection

This command triggers the Jenkins job 'my-pipeline' and tells Jenkins to run it on an agent labeled 'linux'.

Terminal

jenkins-jobs --label linux build my-pipeline

Expected Output

Started build #42 on agent with label linux

Build queued

Build running

Build successful

→

--label - Specifies the label to select the agent for running the job

This command uses Jenkins CLI to start 'my-pipeline' and passes the parameter LABEL=java to select an agent labeled 'java'.

Terminal

jenkins-cli build my-pipeline -p LABEL=java

Expected Output

[Pipeline] Start of Pipeline

Running on agent with label java

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

If you remember nothing else from this pattern, remember: Labels let Jenkins pick the right agent to run your job based on the agent's capabilities.

Common Mistakes

Not assigning any labels to agents and expecting jobs to run on them

Jenkins cannot match jobs to agents without labels, so jobs may stay queued or run on wrong agents

Always assign meaningful labels to agents that describe their environment or capabilities

Using labels in job configuration that do not match any agent labels

Jobs will not find a suitable agent and will remain queued indefinitely

Ensure job label selectors exactly match labels assigned to at least one agent

Summary

Assign labels to Jenkins agents to describe their environment or capabilities.

Use these labels in job configurations or commands to select the right agent for running jobs.

This ensures jobs run on compatible machines and resources are used efficiently.

Practice

1.

What is the main purpose of using labels in Jenkins agent selection?

easy

A. To store job build logs

B. To change the Jenkins user interface theme

C. To tell Jenkins which agent can run a specific job

D. To configure Jenkins system settings

Solution

1. Step 1: Understand Jenkins agent labels

   Labels are tags assigned to agents to identify their capabilities or roles.

2. Step 2: Purpose of labels in job assignment

   Jenkins uses these labels to select the right agent that matches the job requirements.

3. Final Answer:

   To tell Jenkins which agent can run a specific job -> Option C

4. Quick Check:

   Labels guide agent selection = A [OK]

Hint: Labels connect jobs to suitable agents quickly [OK]

Common Mistakes:

• Thinking labels change UI or store logs
• Confusing labels with system settings

2.

Which of the following is the correct syntax to select an agent with label linux and docker in Jenkins pipeline?

easy

A. agent { label linux docker }

B. agent { label 'linux, docker' }

C. agent { label 'linux || docker' }

D. agent { label 'linux && docker' }

Solution

1. Step 1: Understand label expressions in Jenkins

   Jenkins uses logical operators like && for AND and || for OR in label expressions.

2. Step 2: Correct syntax for AND condition

   To require both labels, use 'linux && docker' inside the label field.

3. Final Answer:

   agent { label 'linux && docker' } -> Option D

4. Quick Check:

   AND labels use && = D [OK]

Hint: Use && for AND, || for OR in label expressions [OK]

Common Mistakes:

• Using space-separated labels without operators
• Using commas instead of logical operators
• Confusing AND (&&) with OR (||)

3.

Given this Jenkins pipeline snippet, what agent will run the job if agents have labels linux, docker, and gpu?

agent { label 'linux && (docker || gpu)' }

medium

A. An agent with linux and either docker or gpu labels

B. An agent with linux and gpu labels

C. An agent with both linux and docker labels

D. Any agent with linux, docker, and gpu labels all together

Solution

1. Step 1: Analyze label expression

   The expression requires the agent to have the 'linux' label AND either 'docker' OR 'gpu' label.

2. Step 2: Determine matching agents

   Agents with 'linux' plus 'docker' or 'linux' plus 'gpu' satisfy the condition.

3. Final Answer:

   An agent with linux and either docker or gpu labels -> Option A

4. Quick Check:

   linux AND (docker OR gpu) = A [OK]

Hint: Parentheses group OR conditions, AND applies outside [OK]

Common Mistakes:

• Thinking all three labels are required
• Ignoring parentheses in label expressions
• Assuming OR means both labels must be present

4.

What is wrong with this Jenkins pipeline agent label expression that causes the job to wait indefinitely?

agent { label 'linux && docker || gpu' }

medium

A. Labels must be quoted with double quotes, not single quotes

B. Missing parentheses causing wrong operator precedence

C. Using commas instead of logical operators

D. Agent label cannot contain logical operators

Solution

1. Step 1: Understand operator precedence in label expressions

   Logical AND (&&) has higher precedence than OR (||), so expression is parsed as '(linux && docker) || gpu'.

2. Step 2: Identify why job waits

   If no agent has both linux and docker, but some have gpu alone, job may pick gpu agents. If gpu agents are missing or busy, job waits.

3. Final Answer:

   Missing parentheses causing wrong operator precedence -> Option B

4. Quick Check:

   Use parentheses to control label logic = C [OK]

Hint: Use parentheses to clarify label logic precedence [OK]

Common Mistakes:

• Ignoring operator precedence in label expressions
• Using wrong quote types
• Believing logical operators are not allowed

5.

You want a Jenkins job to run only on agents that have linux and docker labels but never on agents with gpu label. Which label expression should you use?

hard

A. linux && docker && !gpu

B. linux && docker || !gpu

C. linux && (docker || !gpu)

D. linux && docker && gpu

Solution

1. Step 1: Understand label requirements

   The job must run on agents with both 'linux' and 'docker' labels, but exclude any with 'gpu'.

2. Step 2: Construct correct label expression

   Use AND (&&) for required labels and NOT (!) to exclude 'gpu': 'linux && docker && !gpu'.

3. Final Answer:

   linux && docker && !gpu -> Option A

4. Quick Check:

   Include linux and docker, exclude gpu = B [OK]

Hint: Use ! to exclude labels in Jenkins expressions [OK]

Common Mistakes:

• Using OR instead of AND for required labels
• Not excluding gpu label properly
• Misplacing parentheses causing wrong logic