Using Jenkins Deploy Dashboard Plugin for Visual Deployment Management
This article introduces the Deploy Dashboard plugin for Jenkins, explains how to visualize deployment status across environments, shows step‑by‑step instructions for adding versions, creating the dashboard view, adding deployment buttons, and provides pipeline code examples for seamless CI/CD integration.
The Deploy Dashboard plugin (available at https://plugins.jenkins.io/deploy-dashboard/) provides a visual overview of which application versions are deployed to which environments, helping teams answer questions like "Which version is currently in dev?" or "Was a hot‑fix deployed to production yesterday?".
In agile development, frequent releases make it hard to track deployment status manually; the plugin consolidates this information into a single dashboard view.
Visualizing with Deploy Dashboard – A custom view lists code release versions alongside their target test and production environments. Clicking an environment shows its release history.
Getting Started: Adding a New Version to the Dashboard – Assuming you already have a Jenkins job that builds and deploys your app, call the addDeployToDashboard method with the environment name and version parameter. Example pipeline snippet:
properties([parameters([
string(name: 'version', description: 'App version to deploy'),
choice(
name: 'env',
choices: ['dev', 'prod'],
description: 'Environment where the app should be deployed'
)
])])
node {
// ...
stage("Deploy") {
// Deploy app version ${params.version} to ${params.env} env
// add release information to the dashboard
addDeployToDashboard(
env: params.env,
buildNumber: params.version
)
}
}Creating the Dashboard View – On the Jenkins home or folder page, click the "+" tab to launch the New View wizard, name the view, select the "Deploy View" type, and optionally use a regular expression (e.g., .*) to include jobs.
Adding Deployment Buttons to a Version – If you prefer separating CI and CD, use buildAddUrl to add custom buttons to the build sidebar. Example:
node {
stage("Build") {
String builtVersion = "v2.7.5"
// Build app with ${builtVersion} version
// Add buttons to the left sidebar
buildAddUrl(title: 'Deploy to DEV', url: "/job/app-deploy/parambuild/?env=dev&version=${builtVersion}")
buildAddUrl(title: 'Deploy to PROD', url: "/job/app-deploy/parambuild/?env=prod&version=${builtVersion}")
}
}This feature lets quality‑assurance teams deploy any existing version to an environment with a couple of clicks.
Declarative Pipeline Example – The plugin works with declarative pipelines as well:
pipeline {
agent any
parameters {
choice choices: ['dev','prod'], description: '', name: 'env'
string defaultValue: '', description: '', name: 'version', trim: false
}
stages {
stage('Hello') {
steps {
script {
addDeployToDashboard(
env: params.env,
buildNumber: params.version
)
}
}
}
}
}The Deploy Dashboard plugin thus simplifies tracking and managing deployments across multiple environments, improving visibility for developers, QA, and operations teams.
DevOps Cloud Academy
Exploring industry DevOps practices and technical expertise.
How this landed with the community
Was this worth your time?
0 Comments
Thoughtful readers leave field notes, pushback, and hard-won operational detail here.
