CloudBees CD Application Release Orchestration.
CloudBees CD is an enterprise-grade DevOps Release Automation platform that simplifies provisioning, build and release of multi-tiered applications. Our model-driven approach to managing environments and applications allows teams to collaborate on and coordinate multiple pipelines and releases across hybrid infrastructure in an efficient, predictable and auditable way.
With the CloudBees CD plugin you can:
- Trigger a release in CloudBees CD
- Trigger a pipeline in CloudBees CD
- Deploy an application in CloudBees CD
- Publish an artifact from Jenkins into the CloudBees CD artifact repository
- Run a Procedure in CloudBees CD
- Call a REST API to invoke any action in CloudBees CD
- Create Application in CloudBees CD from Deployment Package
In order to use and integrate with CloudBees CD, you would have to create a connection configuration in Jenkins, that stores connection information of the CloudBees CD Server you are connecting to. You can create one or more connection configurations depending on the number of Servers or Environments you are integrating with.
Navigate to Manage Jenkins / Configure System and go to CloudBees CD section. One or more configurations can be created to connect to and call APIs into CloudBees CD system. For each configuration, the following attributes need to be specified:
-
Configuration Name: Specify the name to store this configuration, which is used to connect to the CloudBees CD Server.
-
Server URL: CloudBees CD Server URL
-
REST API Version: CloudBees CD Server Rest API Version
-
User Name: CloudBees CD user name for Connection
-
User Password: CloudBees CD password for Connection
-
Do not send build details to CloudBees CD: By default, if the build has been triggered by CloudBees CD using CI configuration build details will be sent. Use this setting if you do not want to be sending build details to this CloudBees CD instance.
-
Override CloudBees CD SSL Validation Check: By default SSL Validation Check will be performed. Choose this setting to override the check. If you do not want to override this check, perform the SSL certificate setup required in Jenkins and CloudBees CD as per the CloudBees CD Server documentation.
Following post build actions are available in CloudBees CD Plugin. These actions can be executed separately or combined sequentially.
This integration allows you to create and deploy Java, .NET or any other application to any environment in CloudBees CD. Deployment package would be generated as part of your Jenkins CI build, and contain a Manifest file and artifacts to be deployed.
Sample manifest.json file can be found at https://github.com/electric-cloud/DeploymentPackageManager/tree/master/SampleManifests.
This post build action has following parameters:
-
Configuration: Name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Deployment Package Path: Location or path for the deployment package to be published to CloudBees CD. For e.g., MyProject/target
Create and Deploy Application from Deployment Package (Pipeline Script)
node {
cloudBeesFlowCreateAndDeployAppFromJenkinsPackage configuration: 'CdConfiguration', filePath: 'CdProject/target/'
}
This integration allows you to publish the artifact for your application to CloudBees CD. The Artifact will be generated as part of your Jenkins CI build.
This post build action takes the following parameters:
-
Configuration: Name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Relative Workspace: Specify the relative workspace (relative to workspace root) for artifact path.
-
Artifact Path: Location or path for the artifact files to be published to CloudBees CD. For e.g., MyProject/**/*-$BUILD_NUMBER.war
-
Artifact Name: Name of the application artifact using the format <group_id>:<artifact_key>. For e.g., "com.example:helloworld"
-
Artifact Version: Version of the application artifact. For e.g., you can specify 1.0 or 1.0-$BUILD_TAG that is based on Jenkins environment variable
-
CloudBees CD Repository Name: Name of the CloudBees CD Repository
Publish Artifact (Pipeline Script)
node {
cloudBeesFlowPublishArtifact artifactName: 'application:jpetstore', artifactVersion: '1.0', configuration: 'CdConfiguration', filePath: 'CdProject/target/jpetstore.war', repositoryName: 'default'
}
This integration allows you to run a pipeline in CloudBees CD.
This post build action takes the following parameters:
-
Configuration: Name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Project Name: Name of the CloudBees CD project
-
Pipeline Name: Name of the CloudBees CD pipeline
-
(Optional) Pipeline Parameters
-
Parameter name will be displayed as Label
-
Parameter value to be specified will be displayed as text input field
-
Run Pipeline Example (Pipeline Script)
node{
cloudBeesFlowRunPipeline addParam: '{"pipeline":{"pipelineName":"CdPipeline","parameters":[{"parameterName":"PipelineParam","parameterValue":"185"}]}}', configuration: 'CdConfiguration', pipelineName: 'CdPipeline', projectName: 'CloudBees'
}
This integration allows you to call the CloudBees CD REST API. Available as Post Build Action and Pipeline Step as well.
This post build action takes the following parameters:
-
Configuration: Specify the name of the CloudBees CD configuration.
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
URL Path: Specify the URL Path for the REST API
-
HTTP Method: Specify the HTTP Method
-
Parameters: Specify the parameters for the REST API. Parameters are transformed into JSON object and used within body of HTTP request.
-
Body: Specify the body for the REST API. This parameter is not used if 'Parameters' are provided.
-
Environment variable name for storing result: If provided, result of calling CloudBees REST API (JSON output) will be stored within provided environment variable available within build.
Call REST API Example Pipeline Step #1 (Scripted Pipeline)
node{
stage('Test') {
def result = cloudBeesFlowCallRestApi body: '', configuration: 'CdConfiguration', envVarNameForResult: 'CALL_REST_API_CREATE_PROJECT_RESULT', httpMethod: 'POST', parameters: [[key: 'projectName', value: 'CD-TEST-Jenkins-1.00.00.01'], [key: 'description', value: 'Native Jenkins Test Project']], urlPath: '/projects'
echo "result : $result"
echo "CALL_REST_API_CREATE_PROJECT_RESULT environment variable: $CALL_REST_API_CREATE_PROJECT_RESULT"
}
}
Call REST API Example Pipeline Step #2 (Declarative Pipeline)
pipeline{
agent none
stages {
stage('Example Build') {
steps {
cloudBeesFlowCallRestApi body: '', configuration: 'CdConfiguration', envVarNameForResult: 'CALL_REST_API_CREATE_PROJECT_RESULT', httpMethod: 'POST', parameters: [[key: 'projectName', value: 'EC-TEST-Jenkins-1.00.00.01'], [key: 'description', value: 'Native Jenkins Test Project']], urlPath: '/projects'
}
}
stage('Example Build 2') {
steps {
echo "CALL_REST_API_CREATE_PROJECT_RESULT environment variable: $CALL_REST_API_CREATE_PROJECT_RESULT"
}
}
}
}
This integration allows you to deploy an application using CloudBees CD.
This post build action takes the following parameters:
-
Configuration: Specify the name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Project Name: Specify the CloudBees CD project name
-
Application Name: Specify the CloudBees CD application name
-
Application Process Name: Specify the CloudBees CD application process name
-
(Optional) Environment Project Name: Specify the CloudBees CD environment project name if it is different than project for application
-
Environment Name: Specify the CloudBees CD environment name
-
(Optional) Deploy Parameters
-
Parameter name will be displayed as Label
-
Parameter value to be specified will be displayed as text input field
-
Deploy Application Example (Pipeline Script)
node{
cloudBeesFlowDeployApplication applicationName: 'DemoApplication', applicationProcessName: 'RunCommand', configuration: 'CdConfiguration', deployParameters: '{"runProcess":{"applicationName":"DemoApplication","applicationProcessName":"RunCommand","parameter":[{"actualParameterName":"Parameter1","value":"value1"},{"actualParameterName":"Parameter2","value":"value2"}]}}', environmentName: 'CdEnvironment', projectName: 'CloudBees'
}
This Integration allows you to trigger a release in CloudBees CD.
This post build action has following parameters:
-
Configuration: Specify the name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Project Name: Specify the CloudBees CD project name
-
Release Name: Specify the CloudBees CD release name
-
Starting Stage: Specify starting stage to run in the CloudBees CD release pipeline
- Parameter is required if ‘Stages to run’ is not used.
-
Stages to run: Specify stages to run in the CloudBees CD release pipeline
- Parameter is required if ‘Starting Stage’ is not used.
- Parameter is ignored if ‘Starting Stage’ is used.
-
(Optional) Pipeline parameters: Specify parameters for the CloudBees CD pipeline
-
Parameter name will be displayed as Label
-
Parameter value to be specified should go in the text input field
-
Trigger Release Example (Pipeline Script)
node{
cloudBeesFlowTriggerRelease configuration: 'CdConfiguration', parameters: '{"release":{"releaseName":"CdRelease1.1.5","stages":[{"stageName":"Stage 1","stageValue":false},{"stageName":"Stage 2","stageValue":true}],"pipelineName":"pipeline_CdRelease1.1.5","parameters":[{"parameterName":"ReleaseParam","parameterValue":"test"}]}}', projectName: 'CloudBees', releaseName: 'CdRelease1.1.5', startingStage: ''
}
Details for this build will be attached to the Release Run (if supported by CloudBees CD server).
This Integration allows you run a procedure in CloudBees CD.
This post build action has following parameters:
-
Configuration: Specify the name of the CloudBees CD configuration
-
Override Credential: Connect to CloudBees CD as a User other than the one mentioned in the electricflow Plugin Connection Configuration
-
Wait for CD Job Completed: Wait till launched CD job is completed
-
Depend on CD Job Outcome: Mark CI build as failed if CD Job outcome is error or unknown
-
Check Interval: Specify the CloudBees CD procedure name
-
-
Project Name: Specify the CloudBees CD project name
-
Procedure Name: Specify the CloudBees CD procedure name
-
(Optional) Procedure Parameters
-
Parameter name will be displayed as Label
-
Parameter value to be specified should go in the text input field
-
Run Procedure Example (Pipeline Script)
node{
cloudBeesFlowRunProcedure configuration: 'CdConfiguration', procedureName: 'TomcatCheckServer', procedureParameters: '{"procedure":{"procedureName":"TomcatCheckServer","parameters":[{"actualParameterName":"max_time","value":"10"},{"actualParameterName":"tomcat_config_name","value":"Tomcat configuration"}]}}', projectName: 'CloudBees'
}
node{
cloudBeesFlowRunProcedure configuration: 'CdConfiguration', overrideCredential: [credentialId: 'CREDS_PARAM'], procedureName: 'TomcatCheckServer', procedureParameters: '{"procedure":{"procedureName":"TomcatCheckServer","parameters":[{"actualParameterName":"max_time","value":"10"},{"actualParameterName":"tomcat_config_name","value":"Tomcat configuration"}]}}', projectName: 'CloudBees', runAndWaitOption: [checkInterval: 5, dependOnCdJobOutcome: true]
}
Example of the Run Procedure call with failed result handling (pipeline script)
Note: This script relies on the Pipeline Stage API improvements and requires Jenkins 2.138.4 or newer. Other required plugin versions are noted here: https://www.jenkins.io/blog/2019/07/05/jenkins-pipeline-stage-result-visualization-improvements/
//...
script {
try {
// Note that both 'dependOnCdJobOutcome' and 'throwExceptionIfFailed' properties of the RunAndWait option should be set to true.
cloudBeesFlowRunProcedure configuration: 'electricflow', procedureName: 'prepareDeployment', procedureParameters: '{"procedure":{"procedureName":"prepareDeployment","parameters":[]}}', projectName: 'CloudBees', runAndWaitOption: [dependOnCdJobOutcome: true, throwExceptionIfFailed: true]
} catch (RuntimeException ex) {
if (ex.getMessage() =~ 'outcome=warning') {
unstable("The 'prepareDeployment' CD job was finished with warning. This needs further investigation.")
currentBuild.result = 'UNSTABLE'
} else if (ex.getMessage() =~ 'outcome=error') {
currentBuild.result = 'FAILURE'
unstable("The 'prepareDeployment' CD job was finished with error and the CI build should be stopped.")
throw ex
}
}
}
//...- Updated Run And Wait option to allow interruption of the build when Flow runtime was not finished successfully. This enhancement is applied to the following methods:
- Trigger Release
- Run Pipeline
- Run Procedure
- Publish Application
- Create and Deploy Application from Deployment Package
- Updated Deploy application by possibility to specify project for environment if it is othe than project for application
- Fixed the following procedures for new Jenkins (2.264+) according to Jenkins forms tabular to div changes: Run Procedure, Run Pipeline, Deploy Application, Trigger Release
- Updated Publish Artifact by Relative Workspace parameter
- Updated Run And Wait checkInterval by min value
- Updated "Depend on CD job/pipeline outcome" functionality by association of CloudBees CD job/pipeline outcome "Warning" with CloudBees CI build result "Unstable"
- Updated build summary links for Run Pipeline, Publish Artifact, Trigger Release
- Fixed snippet generator UI for pipeline steps with extra parameters (Run Procedure, Trigger Release, Run Pipeline, Deploy Application)
- Event-based build watchers have been improved and now they are also sending build information after the build is finished.
- CloudBees CD Multibranch Pipelines support has been improved.
- Bug fixes and improvements
Improvements:
- Updated the following post build actions by Run and Wait option with possibility to depend on CD job or pipeline outcome:
- Run Pipeline
- Trigger Release
- Run Procedure
- Deploy Application
- Create and Deploy Application from Deployment Package
Improvements:
- Updated Run Procedure by “RunAndWait” option which includes extra dependOnCdJobOutcome and checkInterval sub-options
- Improved error messages in Trigger Pipeline PBA
- Improved error handling in Run Procedure PBA
- Updated build summary of Deploy Application by an extra link to CD application
Bugfixes:
- Fixed an issue when Publish Artifact has been creating a wrong repository structure if the artifact has been published from the Jenkins agent node
- Fixed an error when CD Artifacts URL had a double slash under some conditions
- Deploy Application PBA now has a link to the exact application that has been deployed instead of a link to all applications on customer instance
- Fixed an issue in EC-Jenkins when artifacts could URL could not be retrieved for the Report stage of Run And Monitor and Run And Wait under certain conditions
- The release retrieval code has been fixed
- Fixed an error when "Publish Artifacts" was turning a successful build into failed build under some conditions
- Fixed a bug when parameter "Stages to run" has been ignored and all stages were running
Documentation, help tips and labels:
- Updated plugin documentation by new screenshots and pipeline code snaps
- Parameters label for Trigger release has been changed to be more concrete
- Updated help tips for "Publish Artifacts" and "Create/Deploy Application from Deployment Package" PBAs has been improved and now has the list of supported cases
-
Added support for new CI Build Detail APIs:
- New Post Build Action - Associate Build To Release to allow attaching CI Build Data of the independent builds to releases or release runs
- Run Pipeline now attaches CI Build Data to the triggered pipeline run
- Trigger Release now attaches CI Build Data to the triggered release pipeline run
-
Improved integration with CloudBees CD:
- CI Build Data infrastructure has been created
- Event-based watchers have been created to send build data to CloudBees CD automatically if build has been triggered by CloudBees CD.
-
Re-branding: renaming from "CloudBees Flow" to "CloudBees CD"
- Added support of Configuration as Code
- Updated plugin dependencies
- All Post Build Actions now have the ability to connect to CloudBees Flow as a user other than the one mentioned in the electricflow Plugin configuration, under "Manage Jenkins". These credentials which are used to override the connection credential at the level of the PBA only supports global credentials at this time.
- Fixed parameters collision for pipelines with the same name in the following Post Build Actions: Trigger Release, Run Pipeline
- Fixed corrupted artifact uploading in the following Post Build Actions: Publish Artifact
- Updated plugin dependencies
Migrated plugin documentation from Wiki to GitHub
Updated "CloudBees Flow - Publish Artifact"
- Added pipeline compatibility
- Fixed support of running on agents
Updated "CloudBees Flow - Create and Deploy Application from Deployment Package"
- Added pipeline compatibility
- Fixed support of running on agents
- Added link to CloubBees Flow job within summary of a build
Added pipeline function aliases for all post build actions.
Added expand environment variable functionality for the following post build actions:
- CloudBees Flow - Call REST API
- CloudBees Flow - Run Procedure
- CloudBees Flow - Deploy Application
Added simple Jenkinsfile to the plugin repository
Updated "CloudBees Flow - Call REST API" related functionality:
- Added support of the new workflow step "CloudBees Flow - Call REST API" which is based on the same functionality as corresponded post build action. Snippet generator UI is available for the new workflow step
- Result of calling CloudBees Flow REST API (JSON output) now can be stored within environment variable available within build and also can be returned by the new workflow step within scripted pipelines
- Fixed URL on summary page of Call REST API jobs
Changed Jenkins baseline version for the plugin to 2.138.4
- Added basic unit tests
- Re-branding: renaming from "Electric Flow" to "CloudBees Flow"
- Fix security issue (SECURITY-1420)
- Fix security issues (SECURITY-1410, SECURITY-1411, SECURITY-1412)
Support for the following New Post Build Actions have been added:
- ElectricFlow - Deploy Application
- ElectricFlow - Trigger Release
- ElectricFlow - Call REST API
- ElectricFlow - Run Procedure
Post Build Action "ElectricFlow - Run Pipeline" modified as follows:
- It can now be run for pipelines without parameters
Post Build Action "ElectricFlow - Publish Artifact" modified as follows:
- Added support for publishing to both directories and sub-directories
- Explicit error messages added for build runs
Usability Changes
- Post Build Action page shows dynamically retrieved values all the time
- Two new buttons "Validate Before Apply" and "Compare Before Apply" added in Post Build Action Pages for Deploy Application, Trigger Release, Run Procedure and Run Pipeline, to make sure that failure to retrieve information is handled gracefully (no stack traces) and at the same time, users can understand the field errors before saving the configuration.
- More descriptive Help tips.
- More verbose messages when Test Connection fails with Electric Flow.
- More verbose logging on response body for failed Rest API calls.
- New option called "Override Electric Flow SSL Validation Check" introduced for testing connection with Electric Flow, where there is a need to test Electric Flow Post Build Actions before doing the SSL setup.
Post Build Action "ElectricFlow - Publish Artifact" modified as follows:
- Fixed Scenarios where Build Step fails with exceptions
- Added Support for remoting (build on remote windows machines)
Support added for running plugin tasks from jenkins pipeline as per https://issues.jenkins-ci.org/browse/JENKINS-44084.
More detailed output from plugin on build page results.
Hierarchy files output added to build page.
General clean up of code.
Initial Release.