Input step for manual approval in Jenkins - Commands & Configuration

Introduction

Sometimes, automated pipelines need a human to check and approve before continuing. The input step in Jenkins pauses the pipeline and waits for someone to approve or reject it. This helps avoid mistakes and ensures important decisions are reviewed.

When you want a team lead to approve deployment to production.

When a security check requires manual confirmation before continuing.

When a pipeline needs a manual check after automated tests pass.

When you want to pause a pipeline to review logs or results before next steps.

When compliance rules require human approval before sensitive actions.

Config File - Jenkinsfile

Jenkinsfile

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building the project...'
      }
    }
    stage('Approval') {
      steps {
        script {
          def userInput = input(
            id: 'userInput', message: 'Approve deployment?', parameters: [
              [$class: 'BooleanParameterDefinition', defaultValue: false, description: 'Check to approve', name: 'Approve']
            ]
          )
          if (!userInput) {
            error('Deployment not approved')
          }
        }
      }
    }
    stage('Deploy') {
      steps {
        echo 'Deploying the project...'
      }
    }
  }
}

This Jenkinsfile defines a pipeline with three stages: Build, Approval, and Deploy.

The Approval stage uses the input step to pause the pipeline and ask for manual approval with a checkbox.

If the checkbox is not checked, the pipeline stops with an error.

If approved, the pipeline continues to the Deploy stage.

Commands

This command updates the Jenkins pipeline job with the Jenkinsfile that includes the input step for manual approval.

Terminal

jenkins-jobs --conf jenkins.ini update Jenkinsfile

Expected Output

Job updated successfully

Starts the Jenkins pipeline job named 'my-pipeline' and waits for it to complete. The pipeline will pause at the input step waiting for manual approval.

Terminal

jenkins-cli build my-pipeline -s

Expected Output

[Pipeline] Start of Pipeline

[Pipeline] stage

[Pipeline] { (Build)

Building the project...

[Pipeline] }

[Pipeline] stage

[Pipeline] { (Approval)

Waiting for input: Approve deployment?

→

-s - Waits for the job to complete before returning.

Approves the input step named 'userInput' in the 'my-pipeline' job, allowing the pipeline to continue to the Deploy stage.

Terminal

jenkins-cli input my-pipeline userInput --proceed

Expected Output

Input approved, continuing pipeline

Shows the console output of the 'my-pipeline' job to verify that the Deploy stage ran after approval.

Terminal

jenkins-cli console my-pipeline

Expected Output

[Pipeline] stage

[Pipeline] { (Deploy)

Deploying the project...

[Pipeline] }

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

If you remember nothing else from this pattern, remember: the input step pauses the pipeline and waits for a human to approve before continuing.

Common Mistakes

Not handling the case when approval is denied in the Jenkinsfile.

The pipeline will continue even if the user does not approve, causing unintended deployments.

Use an if statement to check the input result and call error() to stop the pipeline if not approved.

Using input step outside a stage block in the Jenkinsfile.

Jenkins pipelines require steps to be inside stages; otherwise, the pipeline may fail to run.

Always place the input step inside a stage's steps block.

Not specifying an id for the input step and trying to approve via CLI.

Without an id, the CLI cannot identify which input to approve, causing errors.

Always provide an id parameter in the input step to reference it in CLI commands.

Summary

Define an input step inside a stage in Jenkinsfile to pause the pipeline for manual approval.

Use the Jenkins CLI to start the pipeline and approve the input step to continue.

Check the pipeline console output to confirm the deployment stage runs after approval.

Practice

1. What is the main purpose of the input step in a Jenkins pipeline?

easy

A. To send email notifications

B. To automatically deploy the application

C. To run tests in parallel

D. To pause the pipeline and wait for manual approval

Solution

1. Step 1: Understand the role of the input step

   The input step is designed to pause the pipeline execution and wait for a user to approve or reject the continuation.

2. Step 2: Compare with other pipeline actions

   Other options like deployment, testing, or notifications are handled by different steps, not input.

3. Final Answer:

   To pause the pipeline and wait for manual approval -> Option D

4. Quick Check:

   Input step = manual pause [OK]

Hint: Input step always waits for user action [OK]

Common Mistakes:

• Confusing input with automated steps
• Thinking input triggers deployment
• Assuming input sends notifications

2. Which of the following is the correct syntax to add a manual approval input step in a Jenkins declarative pipeline?

easy

A. input message: 'Approve deployment?'

B. input('Approve deployment?')

C. input { message: 'Approve deployment?' }

D. input message = 'Approve deployment?'

Solution

1. Step 1: Recall Jenkins input step syntax

   The correct syntax uses the input step with named parameters like message: 'text'.

2. Step 2: Check each option

   input message: 'Approve deployment?' matches the correct syntax. Options A, B, and D use incorrect formats or braces.

3. Final Answer:

   input message: 'Approve deployment?' -> Option A

4. Quick Check:

   Correct input syntax uses named parameters [OK]

Hint: Use named parameters with colon for input step [OK]

Common Mistakes:

• Using parentheses instead of named parameters
• Using braces instead of parentheses
• Assigning message with equals sign

3. Given the following Jenkins scripted pipeline snippet, what will happen when it reaches the input step?

node {
  stage('Build') {
    echo 'Building...'
  }
  stage('Approval') {
    input message: 'Proceed with deployment?'
  }
  stage('Deploy') {
    echo 'Deploying...'
  }
}

medium

A. Pipeline pauses and waits for user approval before deploying

B. Pipeline skips the approval and deploys immediately

C. Pipeline fails with a syntax error

D. Pipeline runs all stages without pause

Solution

1. Step 1: Analyze the input step behavior

   The input step pauses the pipeline and waits for a user to approve before continuing.

2. Step 2: Understand pipeline flow

   After approval, the pipeline proceeds to the Deploy stage. Without approval, it stays paused.

3. Final Answer:

   Pipeline pauses and waits for user approval before deploying -> Option A

4. Quick Check:

   Input step pauses pipeline = Pipeline pauses and waits for user approval before deploying [OK]

Hint: Input step always pauses pipeline until user approves [OK]

Common Mistakes:

• Assuming input step is skipped automatically
• Thinking input causes syntax error
• Believing pipeline runs all stages without pause

4. Identify the error in this Jenkins pipeline snippet that uses an input step:

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        input message: 'Approve test run?'
        echo 'Running tests...'
      }
    }
  }
}

medium

A. The message parameter is missing quotes

B. The input step cannot be used in the Test stage

C. The input step must be inside a script block in declarative pipeline

D. The echo step must come before the input step

Solution

1. Step 1: Understand declarative pipeline input usage

   In declarative pipelines, the input step must be wrapped inside a script block to run scripted steps.

2. Step 2: Check the snippet

   The input step is directly inside steps without script, causing a syntax error.

3. Final Answer:

   The input step must be inside a script block in declarative pipeline -> Option C

4. Quick Check:

   Input in declarative needs script block [OK]

Hint: Wrap input step in script block in declarative pipelines [OK]

Common Mistakes:

• Placing input step directly in steps without script
• Missing quotes around message
• Thinking input can't be used in certain stages

5. You want to add a manual approval step in a Jenkins declarative pipeline that asks the user to confirm deployment with a custom message and a timeout of 1 hour. Which snippet correctly implements this?

hard

A. input message: 'Deploy now?', timeout: 3600

B. script { input message: 'Deploy now?', timeout: 3600 }

C. script { input message: 'Deploy now?', timeout: 60, submitter: 'admin' }

D. script { input message: 'Deploy now?', timeout: 60 }

Solution

1. Step 1: Understand timeout parameter unit

   The timeout parameter for input is in seconds, so 1 hour = 3600 seconds.

2. Step 2: Check declarative pipeline syntax

   Input must be inside a script block in declarative pipelines.

3. Step 3: Evaluate options

   script { input message: 'Deploy now?', timeout: 3600 } correctly uses script block and timeout 3600 seconds. script { input message: 'Deploy now?', timeout: 60 } uses 60 (1 minute), B lacks script block, C adds submitter but timeout is 60 seconds.

4. Final Answer:

   script { input message: 'Deploy now?', timeout: 3600 } -> Option B

5. Quick Check:

   Timeout in seconds + script block = script { input message: 'Deploy now?', timeout: 3600 } [OK]

Hint: Timeout is seconds; use script block in declarative [OK]

Common Mistakes:

• Using timeout in minutes instead of seconds
• Omitting script block in declarative pipeline
• Adding unnecessary parameters