Introduction
Introduction
Explaining $JENKINS_HOME
Best practices for backup and restore
Backing up manually
IntroductionRestoring manuallyRestoring credentials
Using the CloudBees Backup Plugin
IntroductionScheduling your backups in the CloudBees Backup PluginRestoring from CloudBees Backup Plugin
Backup and restore on Kubernetes
Backup and restore on AWS
Using Velero for backup and restore of Kubernetes clusters
Using cluster operations to run backups
Introduction
Getting the CLI tool
Using the CLI tool
Examples of usage
From CloudBees Jenkins Platform Controllers
Configuring an alias for the Jenkins CLI tool
Configuring the Jenkins CLI tool to work with non-TrustStore SSL certificates
Managing CasC bundles and creating items
About plugins
IntroductionRestart Aborted Builds pluginAWS CLI pluginCloudBees Amazon Web Services Deploy EngineMicrosoft Azure CLI pluginCloudBees Backup pluginCloudBees Bitbucket Branch Source pluginCloudBees Assurance ProgramCloudBees CasC API pluginCloudBees CasC Client pluginCloudBees CasC Items API pluginCloudBees CasC Items Commons pluginCloudBees CasC Items Controller pluginCloudBees CasC Items Server pluginCloudBees CasC Server pluginCloud Foundry CLI pluginConsolidated Build View pluginCloudBees Docker Build and Publish pluginCloudBees Docker TraceabilityDocker Pipeline pluginCloudBees Docker Hub/Registry NotificationCloudBees Even Scheduler pluginCloudBees Fast Archiving pluginFolders pluginFolders Plus pluginGitHub Branch Source pluginJenkins Health Advisor by CloudBeesCloudBees Long-Running Build pluginMonitoring pluginNodes Plus pluginOpenShift CLI pluginCloudBees Plugin Usage Analyzer pluginCloudBees Prometheus Metrics pluginPull Request Builder for GitHub pluginCloudBees Quiet Start pluginSecure Copy pluginSkip Next Build pluginSSH Build Agents pluginCloudBees Support pluginTemplate pluginCloudBees Label Throttling pluginUser Activity MonitoringCloudBees Git Validated Merge pluginVisual Studio Team Services pluginWikitext Security plugin
Plugin management
IntroductionGetting started with plugin managementCloudBees Assurance ProgramBeekeeper Upgrade AssistantAdding Beekeeper plugin exceptionsFinding the support tier for a pluginInstalling pluginsUpgrading plugins from the Plugin ManagerUninstalling pluginsDisabling pluginsReviewing plugin usageConfiguring plugin catalogsManaging plugins with Update CenterManaging plugins in a secure environment
Getting started
IntroductionPipeline termsPipeline project typesCloudBees Pipeline benefits
Planning for Pipelines
IntroductionUsing Pipeline development utilitiesDetermining plugin compatibilityPipeline best practices
Creating Pipelines
IntroductionPrerequisitesCreating your first PipelineCreating Pipelines in SCMCreating Pipelines in Web UIUsing Pipeline as Code
Automating with Jenkinsfile
IntroductionConfig Adv ScriptedConfig Build StageConfig Deploy StageConfig Optional Step ArgsConfig Test StageCreating JenkinsfileCustomizing ParametersHandling FailuresString InterpolationUsing Multiple AgentsWorking With The Env
Administering Pipelines
IntroductionControlling buildsManaging artifactsTracing artifactsTriggering jobs with a simple webhookRestoring filesVisualizing PipelineInserting checkpointsSecuring PipelinesConfiguring Pipelines with user-scoped credentialsUsing Pipeline PoliciesSpecifying a matrix of one or more dimensionsConverting a Freestyle project to a Declarative Pipeline
Remote collaboration features
IntroductionTrigger a job with a notification event using Cross Team CollaborationEnable external notification events with external HTTP endpointsCluster-wide copy artifactsCluster-wide job triggers
Pipeline templates
IntroductionSetting up a Pipeline Template CatalogDefining Pipeline Template CatalogsSetting Up A Pipeline TemplateUsing parameters in template.yamlManaging multibranch Pipeline options in template.yamlManaging Pipeline Template Catalogs in bulkExample full Maven/Java app Jenkinsfile
Pipeline syntax reference
IntroductionUsing Declarative Pipeline syntaxUsing Scripted Pipeline syntax
Multibranch Pipeline Template syntax
IntroductionBranch SourceBitbucketGitHubGitBranch Property StrategyExamples
Introduction
CloudBees Jenkins JVM troubleshooting
Performance decision tree for troubleshooting
Troubleshooting memory leaks
Troubleshooting file and thread leaks
Generating a support bundle
cbsupport CLI documentation

Microsoft Azure CLI plugin

2 minute read

The CloudBees Azure CLI plugin and its dependency, Azure Publisher Settings Credentials plugin, are deprecated due to a critical security vulnerability. If you are using the CloudBees Azure CLI plugin, please uninstall it and instead use the Azure CLI plugin, as explained in Microsoft Azure CLI Plugin.

NOTE: The CloudBees Azure CLI plugin is disabled, but is not automatically uninstalled.

End-of-life announcement

CloudBees has determined that the Azure Publisher Settings plugin will be removed from the CloudBees Assurance Program (CAP) in late 2022. Notification will be provided prior to the removal of the plugin. Please contact CloudBees Support if you have any concerns or questions.

The CloudBees Azure CLI plugin is no longer supported, and customers who have been using this plugin are urged to replace it with the open source version. If you are using CloudBees Azure CLI plugin version 1.2 or later, follow the steps below to update to a supported version.

Removing the CloudBees Azure CLI plugin

The CloudBees Azure CLI plugin is no longer supported, and customers who have been using this plugin are urged to replace it with the open source version. If you are using CloudBees Azure CLI plugin version 1.2 or later, follow the steps in this document to update to a supported version.

  1. First, verify that you are running a version which needs to be updated. Navigate to Manage Jenkins > Manage Plugins > Installed. If you are running either of these versions, then proceed to step #2

    CloudBees Azure CLI Plugin v1.2:

    azure plugin v12

    CloudBees Azure CLI Plugin v1.3

    azure plugin disabled

  2. Click Uninstall to remove the plugin. Click Yes on the next screen to confirm.

  3. Restart Jenkins to complete the uninstallation. You can perform a safe restart by visiting http://<your_jenkins_hostname>/safeRestart.

Updating the plugin

Due to a bug in Jenkins Update Manager, you will need to manually download and install the new open source version of the Azure CLI plugin: https://plugins.jenkins.io/azure-cli

  1. Once you have downloaded the plugin, upload it using _Manage Jenkins > Manage Plugins > Advanced _ tab:

    azure upload plugin

  2. You should see a screen like this indicating the plugin has been installed:

    azure install plugin prep

You can also verify that the correct plugin has been installed by going to Manage Jenkins > Manage Plugins > Installed and verifying that the plugin is listed.

CloudBees Amazon Web Services Deploy Engine
CloudBees Backup plugin