Disk space management in Jenkins - Step-by-Step Execution

Process Flow - Disk space management

Start Jenkins Job

↓

Check Disk Space

↓

Is Disk Space < Threshold?

No→Continue Job

Yes↓

Clean Workspace and Old Builds

↓

Re-check Disk Space

↓

Enough Space?

No→Fail Job or Alert Admin

Yes↓

Continue Job Execution

This flow shows how Jenkins checks disk space before running jobs, cleans up if needed, and decides whether to continue or stop.

Execution Sample

Jenkins

node {
  def freeSpaceStr = sh(script: "df --output=avail -B1 ${WORKSPACE} | tail -1", returnStdout: true).trim()
  def freeSpace = freeSpaceStr.toLong()
  if (freeSpace < 5000000000L) {
    cleanWs()
    freeSpaceStr = sh(script: "df --output=avail -B1 ${WORKSPACE} | tail -1", returnStdout: true).trim()
    freeSpace = freeSpaceStr.toLong()
  }
  echo "Free space: ${freeSpace}"
}

This Jenkins pipeline script checks free disk space, cleans workspace if below 5GB, then prints free space.

Process Table

Step	Action	Disk Space (bytes)	Condition	Result
1	Start job and check disk space	4000000000	4000000000 < 5000000000?	True - proceed to cleanup
2	Run cleanWs() to clean workspace	7000000000	N/A	Workspace cleaned, disk space increased
3	Print free space after cleanup	7000000000	7000000000 < 5000000000?	False - enough space, continue job
4	Job continues execution	7000000000	N/A	Job runs successfully

💡 Disk space after cleanup is sufficient, job continues normally.

Status Tracker

Variable	Start	After Step 1	After Step 2	Final
freeSpace	N/A	4000000000	7000000000	7000000000

Key Moments - 3 Insights

Why do we check disk space before cleaning the workspace?

Because if disk space is already enough (see Step 1 in execution_table), cleaning is unnecessary and saves time.

How does cleanWs() affect disk space?

cleanWs() deletes old files and builds, increasing free disk space as shown from 4GB to 7GB in Step 2.

What happens if disk space is still low after cleanup?

The job should fail or alert admin to prevent running with insufficient space, but in this example, space is enough after cleanup.

Visual Quiz - 3 Questions

Look at the execution table, what is the disk space value after running cleanWs()?

A 7000000000

B 5000000000

C 4000000000

D 3000000000

💡 Hint

Check Step 2 in the execution_table under 'Disk Space (bytes)' column.

At which step does the condition 'freeSpace < 5000000000' become false?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Condition' column in execution_table for each step.

If the initial disk space was 6000000000 bytes, what would happen at Step 1?

A Cleanup would run

B Job would continue without cleanup

C Job would fail immediately

D Disk space would decrease

💡 Hint

Refer to the condition check in Step 1 of execution_table.

Concept Snapshot

Jenkins Disk Space Management:
- Check disk space before job runs
- If below threshold, run cleanWs() to free space
- Re-check space; if enough, continue job
- If still low, fail job or alert
- Helps prevent job failures due to disk full

Full Transcript

This visual execution shows how Jenkins manages disk space during job runs. First, it checks the available disk space. If the space is less than 5GB, it cleans the workspace using cleanWs() to free up space. After cleanup, it checks disk space again. If the space is sufficient, the job continues normally. If not, the job should fail or alert an administrator. This process helps avoid job failures caused by insufficient disk space.

Practice

1. What is the main purpose of managing disk space in Jenkins?

easy

A. To reduce the number of Jenkins plugins installed

B. To increase the number of Jenkins users

C. To speed up the Jenkins UI loading time

D. To keep Jenkins builds running smoothly without storage issues

Solution

1. Step 1: Understand Jenkins build process

   Jenkins stores build files and logs in workspaces which consume disk space.

2. Step 2: Identify the effect of disk space on builds

   If disk space runs out, builds can fail or Jenkins may slow down.

3. Final Answer:

   To keep Jenkins builds running smoothly without storage issues -> Option D

4. Quick Check:

   Disk space management = smooth builds [OK]

Hint: Disk space issues cause build failures, manage to avoid them [OK]

Common Mistakes:

• Thinking disk space affects only UI speed
• Confusing disk space with user management
• Assuming plugins control disk space

2. Which Jenkins pipeline step is used to clean the workspace and free disk space?

easy

A. deleteDir()

B. cleanWs()

C. removeWorkspace()

D. clearDisk()

Solution

1. Step 1: Recall Jenkins pipeline steps for workspace cleanup

   The step cleanWs() is designed to delete all files in the current workspace.

2. Step 2: Verify other options

   deleteDir() deletes the current directory but is less specific; others are not valid Jenkins steps.

3. Final Answer:

   cleanWs() -> Option B

4. Quick Check:

   Workspace cleanup step = cleanWs() [OK]

Hint: Remember cleanWs() cleans workspace files in pipelines [OK]

Common Mistakes:

• Using deleteDir() which deletes current dir but not workspace safely
• Assuming removeWorkspace() or clearDisk() exist
• Confusing cleanWs() with plugin names

3. What will happen if you add cleanWs() at the end of a Jenkins pipeline script?

medium

A. The build will fail due to missing workspace files

B. The workspace files will be backed up automatically

C. The workspace files will be deleted after the build completes

D. Nothing happens; cleanWs() is ignored

Solution

1. Step 1: Understand cleanWs() behavior

   cleanWs() deletes all files in the workspace where the build runs.

2. Step 2: Consider placement at pipeline end

   Placing cleanWs() at the end deletes files after build finishes, freeing disk space.

3. Final Answer:

   The workspace files will be deleted after the build completes -> Option C

4. Quick Check:

   cleanWs() at end = workspace cleaned [OK]

Hint: cleanWs() deletes workspace files after build ends [OK]

Common Mistakes:

• Thinking cleanWs() backs up files
• Assuming it causes build failure
• Believing cleanWs() does nothing

4. You added cleanWs() in your Jenkins pipeline, but disk space is still filling up. What is a likely cause?

medium

A. The Disk Usage Plugin is not installed or configured

B. cleanWs() only deletes files older than 7 days

C. cleanWs() does not delete files if the build fails

D. cleanWs() requires manual confirmation to delete files

Solution

1. Step 1: Understand cleanWs() limitations

   cleanWs() deletes workspace files but does not manage other disk usage like old builds or logs.

2. Step 2: Role of Disk Usage Plugin

   The Disk Usage Plugin helps monitor and automate cleanup beyond workspace, including old builds and artifacts.

3. Final Answer:

   The Disk Usage Plugin is not installed or configured -> Option A

4. Quick Check:

   Disk Usage Plugin needed for full cleanup [OK]

Hint: Use Disk Usage Plugin for full disk cleanup automation [OK]

Common Mistakes:

• Believing cleanWs() deletes all disk files
• Thinking cleanWs() deletes only old files
• Assuming cleanWs() needs manual approval

5. How can you automate disk space cleanup in Jenkins to delete old builds and workspace files regularly?

hard

A. Configure the Disk Usage Plugin and add cleanWs() in pipelines

B. Manually delete workspace files after each build

C. Disable all Jenkins plugins to reduce disk usage

D. Increase disk size instead of cleaning files

Solution

1. Step 1: Use Disk Usage Plugin for monitoring and cleanup

   This plugin tracks disk usage and can be set to delete old builds automatically.

2. Step 2: Use cleanWs() in pipelines for workspace cleanup

   Adding cleanWs() deletes workspace files after builds, freeing space regularly.

3. Final Answer:

   Configure the Disk Usage Plugin and add cleanWs() in pipelines -> Option A

4. Quick Check:

   Plugin + cleanWs() = automated cleanup [OK]

Hint: Combine Disk Usage Plugin with cleanWs() for automation [OK]

Common Mistakes:

• Relying on manual deletion only
• Disabling plugins instead of cleaning
• Ignoring disk size limits