Jenkins - Managing Plugins

Jenkins - Managing Plugins

Plugins are the heart of Jenkins’ extensibility, providing integration with countless tools, enhancing the UI, adding build steps, and enabling advanced CI/CD workflows. Effective plugin management is key to a functional Jenkins instance.

Accessing Plugin Manager

Navigate to Manage Jenkins → Plugins.

The Plugin Manager has several tabs:

Updates Tab

Lists installed plugins for which newer versions are available in the configured Update Center(s).

• Check the boxes next to plugins you want to update.
• Click ‘Download now and install after restart’ or ‘Install without restart’ (if available and safe for the specific plugin).
• Best Practice: Review plugin changelogs before updating critical plugins. Update plugins regularly to get bug fixes, new features, and crucial security patches. Consider updating in batches or during maintenance windows.

Available Plugins Tab

Lists all plugins available from the configured Update Center(s) that are not currently installed.

• Use the ‘Filter’ box to search for plugins by name or functionality (e.g., ‘Pipeline’, ‘Docker’, ‘AWS’, ‘Slack’, ‘Blue Ocean’).
• Clicking a plugin name often provides a link to its documentation wiki page.
• Select the checkbox next to the desired plugin(s).
• Click ‘Install without restart’ or ‘Download now and install after restart’. Jenkins handles dependency installation automatically.
• You can explore available plugins directly on the Jenkins plugin site: https://plugins.jenkins.io/

Installed Plugins Tab

Shows all plugins currently installed on your Jenkins instance, including their version and whether they are enabled or disabled.

• Enable/Disable: Uncheck the ‘Enabled’ box to disable a plugin without uninstalling it (requires restart). This can be useful for troubleshooting.
• Uninstall: Click the ‘Uninstall’ button next to a plugin you no longer need. Jenkins will prompt for a restart to complete the uninstallation.
• Downgrade: While not directly available in the UI, you can manually downgrade by uploading an older .hpi or .jpi file via the ‘Advanced settings’ tab (see below).
• Dependencies: This view also shows bundled plugins and dependencies.

Advanced settings Tab

Provides advanced options:

• Update Site: Manage the URL of the Jenkins Update Center. You might change this to a local mirror or a custom update center.
• HTTP Proxy Configuration: Configure Jenkins to use an HTTP proxy to reach the Update Center if your network requires it.
• Deploy Plugin: Manually upload a plugin file (.hpi or .jpi). This is used for installing custom-developed plugins, specific versions downloaded manually, or for offline installations.
• Check now: Force Jenkins to check the Update Center for new plugin data immediately.

Plugin Management Best Practices

• Install Only What You Need: Avoid installing excessive plugins, as each adds overhead and potential security surface area.
• Keep Plugins Updated: Regularly apply updates, especially security patches.
• Check Compatibility: Major Jenkins core upgrades might require specific plugin versions. Check the release notes.
• Use Supported Plugins: Prefer actively maintained plugins listed on the official Jenkins plugin site.
• Configuration as Code (CasC): The Jenkins Configuration as Code plugin can manage plugin installation and versions via YAML files stored in Git, ensuring consistency across instances.
• Restart Strategy: While ‘Install without restart’ works for many modern plugins, some still require a Jenkins restart to take full effect or complete uninstallation. Plan restarts during maintenance windows when necessary.