System configuration management in Jenkins - Mini Project: Build & Apply

System Configuration Management with Jenkins

📖 Scenario: You are working as a DevOps engineer. Your team wants to automate the setup of a simple Jenkins job that runs a shell command to print system information. This helps ensure consistent system configuration checks across servers.

🎯 Goal: Build a Jenkins pipeline script that defines a job to run a shell command uname -a to display system information.

📋 What You'll Learn

Create a Jenkins pipeline script with a pipeline block

Define an agent to run the job on any available node

Add an environment variable SYS_COMMAND with the value uname -a

Use a stage named System Info to run the shell command stored in SYS_COMMAND

Print the output of the shell command in the Jenkins console

💡 Why This Matters

🌍 Real World

Automating system configuration checks helps teams maintain consistent environments and quickly detect issues.

💼 Career

Jenkins pipelines are widely used in DevOps roles to automate tasks like system monitoring, deployment, and testing.

1

Create the basic Jenkins pipeline structure

Write a Jenkins pipeline script starting with pipeline { and define an agent any block inside it.

Jenkins

pipeline {
    agent any
    // Your code here
}

Hint

Start by writing pipeline { and inside it add agent any to run on any node.

2

Add an environment variable for the system command

Inside the pipeline block, add an environment block that defines a variable called SYS_COMMAND with the value uname -a.

Jenkins

pipeline {
    agent any
    environment {
        // Your code here
    }
}

Hint

Use the environment block to set SYS_COMMAND = 'uname -a'.

3

Add a stage to run the system command

Inside the pipeline block, add a stages block with a stage named System Info. Inside this stage, add a steps block that runs the shell command stored in SYS_COMMAND using sh.

Jenkins

pipeline {
    agent any
    environment {
        SYS_COMMAND = 'uname -a'
    }
    stages {
        stage('System Info') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use sh SYS_COMMAND inside the steps block to run the command.

4

Print the output of the system command

Add a script block inside the steps of the System Info stage. Use def output = sh(script: SYS_COMMAND, returnStdout: true).trim() to capture the command output, then print it with echo output.

Jenkins

pipeline {
    agent any
    environment {
        SYS_COMMAND = 'uname -a'
    }
    stages {
        stage('System Info') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use a script block to capture the output and then print it with echo.

Practice

1. What is the main purpose of system configuration management in Jenkins?

easy

A. To write code for Jenkins plugins

B. To monitor Jenkins server performance

C. To automate setting up and maintaining computer systems

D. To create user accounts in Jenkins

Solution

1. Step 1: Understand system configuration management

   It automates the setup and maintenance of computer systems to keep them consistent.

2. Step 2: Relate to Jenkins usage

   Jenkins uses this to run tools like Ansible or Puppet to automate system setup.

3. Final Answer:

   To automate setting up and maintaining computer systems -> Option C

4. Quick Check:

   System configuration management = automation of system setup [OK]

Hint: Think automation of system setup and maintenance [OK]

Common Mistakes:

• Confusing system config with Jenkins plugin development
• Thinking it monitors Jenkins server only
• Assuming it manages Jenkins user accounts

2. Which Jenkins pipeline step correctly runs an Ansible playbook named setup.yml?

easy

A. sh 'ansible-playbook setup.yml'

B. ansiblePlaybook 'setup.yml'

C. run ansible setup.yml

D. execute 'ansible-playbook setup.yml'

Solution

1. Step 1: Identify correct Jenkins pipeline syntax for shell commands

   Jenkins uses sh step to run shell commands.

2. Step 2: Check Ansible command correctness

   The correct command is ansible-playbook setup.yml.

3. Final Answer:

   sh 'ansible-playbook setup.yml' -> Option A

4. Quick Check:

   Use sh for shell commands in Jenkins [OK]

Hint: Use 'sh' step for shell commands in Jenkins pipeline [OK]

Common Mistakes:

• Using non-existent Jenkins steps like ansiblePlaybook
• Omitting the 'sh' wrapper for shell commands
• Using incorrect command syntax

3. Given this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Config') {
      steps {
        sh 'ansible-playbook -i inventory setup.yml'
      }
    }
  }
}

What happens when this pipeline runs?

medium

A. Jenkins runs the Ansible playbook setup.yml using the inventory file

B. Jenkins fails because sh cannot run Ansible

C. Jenkins skips the stage because no agent is specified

D. Jenkins runs the playbook but ignores the inventory file

Solution

1. Step 1: Understand the sh step in Jenkins pipeline

   The sh step runs shell commands on the agent.

2. Step 2: Analyze the command ansible-playbook -i inventory setup.yml

   This runs the Ansible playbook setup.yml using the specified inventory file.

3. Final Answer:

   Jenkins runs the Ansible playbook setup.yml using the inventory file -> Option A

4. Quick Check:

   sh runs shell commands, so Ansible runs as expected [OK]

Hint: Remember sh runs shell commands exactly [OK]

Common Mistakes:

• Thinking Jenkins cannot run Ansible via shell
• Assuming agent is missing and stage skips
• Ignoring the inventory file in command

4. You wrote this Jenkins pipeline step:

sh 'ansible-playbook setup.yml -i inventory'

But the pipeline fails with "command not found" error. What is the likely cause?

medium

A. The playbook setup.yml has syntax errors

B. Ansible is not installed or not in PATH on the Jenkins agent

C. The sh step is incorrect syntax

D. The inventory file is missing

Solution

1. Step 1: Understand "command not found" error

   This error means the shell cannot find the command ansible-playbook.

2. Step 2: Check possible causes

   If Ansible is not installed or not in the PATH on the Jenkins agent, this error occurs.

3. Final Answer:

   Ansible is not installed or not in PATH on the Jenkins agent -> Option B

4. Quick Check:

   "command not found" means missing executable [OK]

Hint: "command not found" means missing program or PATH issue [OK]

Common Mistakes:

• Assuming inventory file missing causes command not found
• Thinking sh syntax is wrong
• Blaming playbook syntax for command not found

5. You want Jenkins to ensure all your servers have the same configuration using Puppet. Which approach best fits system configuration management in Jenkins?

hard

A. Write Puppet manifests inside Jenkinsfile without running them

B. Manually log into each server and run Puppet commands

C. Use Jenkins only to build software, not for configuration

D. Create a Jenkins pipeline that runs Puppet agent commands on target servers

Solution

1. Step 1: Understand Jenkins role in system configuration

   Jenkins automates running configuration tools like Puppet on servers.

2. Step 2: Identify best practice

   Running Puppet agent commands via Jenkins pipeline automates and ensures consistency.

3. Final Answer:

   Create a Jenkins pipeline that runs Puppet agent commands on target servers -> Option D

4. Quick Check:

   Automation via Jenkins pipeline is best practice [OK]

Hint: Automate Puppet runs via Jenkins pipeline for consistency [OK]

Common Mistakes:

• Manually running Puppet defeats automation purpose
• Ignoring Jenkins for configuration management
• Writing manifests but not executing them