Kubernetes agents in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Kubernetes agent in Jenkins?

A Kubernetes agent in Jenkins is a temporary worker pod created on demand in a Kubernetes cluster to run Jenkins jobs. It helps Jenkins scale by running builds inside containers.

intermediate

How does Jenkins create Kubernetes agents?

Jenkins uses the Kubernetes plugin to create agents by launching pods with specific container images and configurations defined in pod templates.

beginner

Why use Kubernetes agents instead of static Jenkins agents?

Kubernetes agents are dynamic and created only when needed, saving resources and allowing Jenkins to scale automatically. Static agents run all the time and can waste resources.

intermediate

What is a pod template in Jenkins Kubernetes plugin?

A pod template defines the configuration for the Kubernetes pod Jenkins will create as an agent. It includes container images, environment variables, volumes, and commands.

intermediate

How does Jenkins communicate with Kubernetes to manage agents?

Jenkins uses the Kubernetes API to create, monitor, and delete pods that act as agents. It authenticates using credentials like service accounts or tokens.

What does a Kubernetes agent in Jenkins typically run inside?

A A Jenkins master node

B A virtual machine

C A Kubernetes pod

D A physical server

Kubernetes agents run inside pods created dynamically in the Kubernetes cluster.

Which Jenkins plugin is used to create Kubernetes agents?

A Pipeline plugin

B Kubernetes plugin

C Docker plugin

D Git plugin

The Kubernetes plugin allows Jenkins to create agents as pods in Kubernetes.

What is the main benefit of using Kubernetes agents in Jenkins?

A Manual agent management

B Permanent build environment

C Faster Jenkins startup

D Automatic scaling and resource efficiency

Kubernetes agents are created on demand, allowing Jenkins to scale and use resources efficiently.

What does a pod template specify in Jenkins Kubernetes agents?

A Container images and pod settings

B Jenkins master configuration

C Build scripts

D User permissions

Pod templates define how the Kubernetes pod agent is configured, including container images.

How does Jenkins authenticate to Kubernetes to manage agents?

A Using service account tokens or credentials

B Using SSH keys

C Using FTP credentials

D Using database passwords

Jenkins uses Kubernetes credentials like service account tokens to communicate securely with the cluster.

Explain how Jenkins uses Kubernetes agents to run build jobs.

Think about how Jenkins scales builds using Kubernetes pods.

Describe what a pod template is and why it is important for Kubernetes agents in Jenkins.

Consider what Jenkins needs to know to create a pod for a build.

Practice

1. What is the main purpose of using Kubernetes agents in Jenkins?

easy

A. To run Jenkins jobs inside isolated pods on a Kubernetes cluster

B. To store Jenkins job logs permanently on the master node

C. To replace Jenkins pipelines with Kubernetes scripts

D. To run Jenkins jobs only on physical machines

Solution

1. Step 1: Understand Kubernetes agents role

   Kubernetes agents run Jenkins jobs inside pods, providing isolation and scalability.

2. Step 2: Compare options

   Only To run Jenkins jobs inside isolated pods on a Kubernetes cluster correctly describes running jobs inside pods on Kubernetes clusters.

3. Final Answer:

   To run Jenkins jobs inside isolated pods on a Kubernetes cluster -> Option A

4. Quick Check:

   Kubernetes agents = isolated pods for Jenkins jobs [OK]

Hint: Kubernetes agents run jobs inside pods, not on master node [OK]

Common Mistakes:

• Thinking agents run jobs on master node
• Confusing Kubernetes agents with storage solutions
• Assuming Kubernetes replaces Jenkins pipelines

2. Which Jenkins pipeline syntax correctly defines a Kubernetes agent using podTemplate?

easy

A. containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent') { podTemplate { node { /* steps */ } } }

B. node { podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) { /* steps */ } }

C. podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) { node { /* steps */ } }

D. podTemplate { node(containers: ['jnlp']) { /* steps */ } }

Solution

1. Step 1: Identify correct podTemplate usage

   The podTemplate block wraps the node block and defines containers properly.

2. Step 2: Validate syntax correctness

   podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) { node { /* steps */ } } correctly places podTemplate outside node and defines containerTemplate properly.

3. Final Answer:

   podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) { node { /* steps */ } } -> Option C

4. Quick Check:

   podTemplate wraps node with containerTemplate [OK]

Hint: podTemplate wraps node, containerTemplate inside podTemplate [OK]

Common Mistakes:

• Placing podTemplate inside node block
• Using containerTemplate outside podTemplate
• Incorrect nesting of blocks

3. Given this Jenkins pipeline snippet, what will be the output if the pod agent is correctly configured?

podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) {
  node {
    stage('Test') {
      echo 'Running inside Kubernetes agent'
    }
  }
}

medium

A. The pipeline will fail because podTemplate is missing a label

B. The message 'Running inside Kubernetes agent' will be printed in the Jenkins console log

C. Nothing will print because echo is not supported inside podTemplate

D. The pipeline will run on the Jenkins master node ignoring podTemplate

Solution

1. Step 1: Understand podTemplate and node behavior

   The podTemplate defines the Kubernetes pod agent, and node runs the steps inside it.

2. Step 2: Analyze echo command inside stage

   The echo command prints the message to the Jenkins console log during the 'Test' stage.

3. Final Answer:

   The message 'Running inside Kubernetes agent' will be printed in the Jenkins console log -> Option B

4. Quick Check:

   echo inside podTemplate prints message [OK]

Hint: echo prints messages in Jenkins console inside podTemplate [OK]

Common Mistakes:

• Assuming echo won't work inside podTemplate
• Thinking podTemplate requires label always
• Confusing podTemplate with running on master node

4. You wrote this Jenkins pipeline but it fails with "No nodes available" error:

podTemplate(containers: [containerTemplate(name: 'jnlp', image: 'jenkins/inbound-agent')]) {
  stage('Build') {
    node {
      echo 'Building...'
    }
  }
}

What is the likely cause?

medium

A. The containerTemplate name 'jnlp' is invalid

B. The stage block is outside the node block

C. The node block is outside the podTemplate block

D. The node block is missing a label matching the podTemplate

Solution

1. Step 1: Check node block label requirement

   When using podTemplate, the node block must specify the label matching the podTemplate to allocate the pod.

2. Step 2: Identify missing label causes no node available

   Without label, Jenkins cannot find the Kubernetes agent pod, causing the error.

3. Final Answer:

   The node block is missing a label matching the podTemplate -> Option D

4. Quick Check:

   node label missing = no Kubernetes pod allocated [OK]

Hint: Always specify node label matching podTemplate to avoid no nodes error [OK]

Common Mistakes:

• Not specifying node label
• Misplacing node and stage blocks
• Assuming containerTemplate name causes error

5. You want to run a Jenkins job on a Kubernetes agent with two containers: one for building with Maven and one for running tests with Node.js. Which pipeline snippet correctly defines this setup?

hard

A. podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1'), containerTemplate(name: 'nodejs', image: 'node:16')]) {
node {
stage('Build') {
container('maven') {
sh 'mvn clean install'
}
}
stage('Test') {
container('nodejs') {
sh 'npm test'
}
}
}
}

B. podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1')]) {
node {
stage('Build') {
sh 'mvn clean install'
}
stage('Test') {
container('nodejs') {
sh 'npm test'
}
}
}
}

C. podTemplate(containers: [containerTemplate(name: 'nodejs', image: 'node:16')]) {
node {
stage('Build') {
container('maven') {
sh 'mvn clean install'
}
}
stage('Test') {
sh 'npm test'
}
}
}

D. podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1'), containerTemplate(name: 'nodejs', image: 'node:16')]) {
node {
stage('Build') {
sh 'mvn clean install'
}
stage('Test') {
sh 'npm test'
}
}
}

Solution

1. Step 1: Define multiple containers in podTemplate

   podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1'), containerTemplate(name: 'nodejs', image: 'node:16')]) { node { stage('Build') { container('maven') { sh 'mvn clean install' } } stage('Test') { container('nodejs') { sh 'npm test' } } } } correctly defines two containers: 'maven' and 'nodejs' with proper images.

2. Step 2: Use container block to run commands in specific containers

   podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1'), containerTemplate(name: 'nodejs', image: 'node:16')]) { node { stage('Build') { container('maven') { sh 'mvn clean install' } } stage('Test') { container('nodejs') { sh 'npm test' } } } } uses container('name') to run build and test commands inside respective containers.

3. Final Answer:

   Option A correctly defines two containers and uses container blocks for commands -> Option A

4. Quick Check:

   Multiple containers + container blocks = podTemplate(containers: [containerTemplate(name: 'maven', image: 'maven:3.8.1'), containerTemplate(name: 'nodejs', image: 'node:16')]) { node { stage('Build') { container('maven') { sh 'mvn clean install' } } stage('Test') { container('nodejs') { sh 'npm test' } } } } [OK]

Hint: Use container('name') block to run commands in specific pod containers [OK]

Common Mistakes:

• Not defining all containers in podTemplate
• Running commands outside container blocks
• Mixing container names or missing container blocks