Agent connection methods (SSH, JNLP) in Jenkins - Mini Project: Build & Apply

Jenkins Agent Connection Methods: SSH and JNLP Setup

📖 Scenario: You are setting up Jenkins agents to connect to the Jenkins master server. Agents can connect using different methods. Two common methods are SSH and JNLP (Java Network Launch Protocol). You will configure both connection methods step-by-step.

🎯 Goal: Build a simple Jenkins agent configuration using both SSH and JNLP connection methods. You will create the initial agent data, add connection details, apply the connection method logic, and finally display the configured agent connection info.

📋 What You'll Learn

Create a dictionary to hold agent names and their IP addresses

Add a configuration variable to specify the connection method (SSH or JNLP)

Use a loop to assign connection commands based on the connection method

Print the final agent connection commands

💡 Why This Matters

🌍 Real World

Jenkins agents need to connect to the master server to run jobs. SSH and JNLP are common ways to establish this connection securely.

💼 Career

Understanding how to configure Jenkins agents and their connection methods is essential for DevOps engineers managing CI/CD pipelines.

1

Create initial Jenkins agents data

Create a dictionary called agents with these exact entries: 'agent1': '192.168.1.10', 'agent2': '192.168.1.11', 'agent3': '192.168.1.12'

Jenkins

# Create the agents dictionary with names and IP addresses
# Your code here

Hint

Use curly braces to create a dictionary with the exact keys and values.

2

Add connection method configuration

Create a variable called connection_method and set it to the string 'SSH'

Jenkins

agents = {'agent1': '192.168.1.10', 'agent2': '192.168.1.11', 'agent3': '192.168.1.12'}
# Set the connection method to 'SSH'
# Your code here

Hint

Assign the string 'SSH' to the variable named connection_method.

3

Generate connection commands for agents

Create an empty dictionary called connection_commands. Then use a for loop with variables agent and ip to iterate over agents.items(). Inside the loop, if connection_method is 'SSH', set connection_commands[agent] to f"ssh user@{ip}". Otherwise, set it to f"java -jar agent.jar -jnlpUrl http://jenkins/computer/{agent}/slave-agent.jnlp".

Jenkins

agents = {'agent1': '192.168.1.10', 'agent2': '192.168.1.11', 'agent3': '192.168.1.12'}
connection_method = 'SSH'
# Create connection_commands dictionary and fill it with commands based on connection_method
# Your code here

Hint

Use a for loop to go through agents and assign commands based on the connection method.

4

Display the agent connection commands

Use a for loop with variables agent and command to iterate over connection_commands.items(). Inside the loop, print the string f"{agent}: {command}".

Jenkins

agents = {'agent1': '192.168.1.10', 'agent2': '192.168.1.11', 'agent3': '192.168.1.12'}
connection_method = 'SSH'
connection_commands = {}
for agent, ip in agents.items():
    if connection_method == 'SSH':
        connection_commands[agent] = f"ssh user@{ip}"
    else:
        connection_commands[agent] = f"java -jar agent.jar -jnlpUrl http://jenkins/computer/{agent}/slave-agent.jnlp"
# Print each agent and its connection command
# Your code here

Hint

Print each agent name followed by a colon and its connection command.

Practice

1. Which statement correctly describes the difference between SSH and JNLP agent connection methods in Jenkins?

easy

A. SSH agents connect by Jenkins initiating the connection; JNLP agents connect by the agent initiating the connection.

B. JNLP agents connect by Jenkins initiating the connection; SSH agents connect by the agent initiating the connection.

C. Both SSH and JNLP agents require Jenkins to initiate the connection.

D. Both SSH and JNLP agents require the agent to initiate the connection.

Solution

1. Step 1: Understand SSH agent connection

   SSH agents connect by Jenkins server initiating an SSH connection to the agent machine.

2. Step 2: Understand JNLP agent connection

   JNLP agents connect by the agent itself initiating a connection back to the Jenkins server.

3. Final Answer:

   SSH agents connect by Jenkins initiating the connection; JNLP agents connect by the agent initiating the connection. -> Option A

4. Quick Check:

   SSH = Jenkins initiates, JNLP = Agent initiates [OK]

Hint: Remember: SSH = Jenkins connects out, JNLP = agent connects in [OK]

Common Mistakes:

• Confusing which side initiates the connection
• Thinking both methods work the same way
• Assuming JNLP requires SSH protocol

2. Which of the following is the correct syntax to configure a Jenkins SSH agent in the Jenkins UI?

easy

A. Provide Jenkins server IP and SSH port only.

B. Provide Jenkins server URL and agent secret key only.

C. Provide only the agent's IP address without credentials.

D. Provide agent's hostname, SSH credentials, and remote root directory.

Solution

1. Step 1: Identify SSH agent configuration requirements

   SSH agents require hostname, SSH credentials (username/key), and remote root directory to connect properly.

2. Step 2: Eliminate incorrect options

   Options A, B, and C miss essential details like credentials or directory, so they are incorrect.

3. Final Answer:

   Provide agent's hostname, SSH credentials, and remote root directory. -> Option D

4. Quick Check:

   SSH agent needs hostname + credentials + directory [OK]

Hint: SSH agent setup needs hostname, credentials, and directory [OK]

Common Mistakes:

• Skipping SSH credentials in configuration
• Confusing JNLP secret with SSH setup
• Providing incomplete connection details

3. Given a Jenkins agent configured with JNLP, what will happen if the agent machine cannot reach the Jenkins server URL?

medium

A. The agent will connect using SSH fallback automatically.

B. The agent will connect successfully because Jenkins initiates the connection.

C. The agent will fail to connect because it initiates the connection to Jenkins.

D. The Jenkins server will push jobs to the agent regardless.

Solution

1. Step 1: Understand JNLP connection direction

   JNLP agents initiate the connection to the Jenkins server URL, so the agent must reach the server.

2. Step 2: Analyze network failure impact

   If the agent cannot reach the Jenkins server URL, the connection attempt fails and the agent cannot connect.

3. Final Answer:

   The agent will fail to connect because it initiates the connection to Jenkins. -> Option C

4. Quick Check:

   JNLP agent needs network access to Jenkins [OK]

Hint: JNLP agent must reach Jenkins URL to connect [OK]

Common Mistakes:

• Assuming Jenkins initiates JNLP connection
• Thinking SSH fallback is automatic
• Believing Jenkins can push jobs without agent connection

4. You configured an SSH agent in Jenkins but the connection keeps failing with authentication errors. What is the most likely cause?

medium

A. Agent machine cannot reach Jenkins server URL.

B. Incorrect SSH credentials or missing SSH key on the agent machine.

C. JNLP agent secret key is invalid.

D. Jenkins server firewall blocks outgoing SSH connections.

Solution

1. Step 1: Identify cause of SSH authentication failure

   Authentication errors usually mean wrong username/password or missing SSH key on the agent side.

2. Step 2: Eliminate other options

   Agent machine cannot reach Jenkins server URL. relates to JNLP, not SSH. JNLP agent secret key is invalid. is about JNLP secret. Jenkins server firewall blocks outgoing SSH connections. is unlikely as Jenkins initiates SSH outbound.

3. Final Answer:

   Incorrect SSH credentials or missing SSH key on the agent machine. -> Option B

4. Quick Check:

   SSH auth errors = bad credentials or missing key [OK]

Hint: Check SSH credentials and keys first for connection errors [OK]

Common Mistakes:

• Confusing JNLP secret with SSH credentials
• Ignoring network reachability issues
• Assuming firewall blocks inbound SSH to Jenkins

5. You need to connect Jenkins agents located behind strict firewalls that block incoming connections to the agent machines. Which connection method should you choose and why?

hard

A. Use JNLP because agents initiate connections to Jenkins, bypassing firewall restrictions.

B. Use SSH because Jenkins can initiate connections to agents behind firewalls.

C. Use SSH with VPN to bypass firewall restrictions.

D. Use JNLP but disable agent authentication for easier connection.

Solution

1. Step 1: Analyze firewall impact on connection methods

   Firewalls blocking incoming connections to agents prevent Jenkins from initiating SSH connections.

2. Step 2: Choose method allowing agent-initiated connection

   JNLP agents initiate connection to Jenkins server, so they can connect despite firewall restrictions on incoming traffic.

3. Step 3: Evaluate other options

   SSH requires Jenkins to connect in, VPN adds complexity, disabling authentication is insecure and not recommended.

4. Final Answer:

   Use JNLP because agents initiate connections to Jenkins, bypassing firewall restrictions. -> Option A

5. Quick Check:

   Firewall blocks incoming? Choose agent-initiated JNLP [OK]

Hint: Firewalls blocking incoming? Pick JNLP agent connection [OK]

Common Mistakes:

• Choosing SSH despite firewall inbound block
• Disabling authentication for convenience
• Ignoring VPN complexity and security