Skip to end of metadata
Go to start of metadata

Plugin Information

View ElectricFlow on the plugin site for more information.

Overview

ElectricFlow 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. 

Features

Key feature of integration includes: 

  • Create Application in ElectricFlow from Deployment Package

  • Publish Artifact from Jenkins into ElectricFlow
  • Run ElectricFlow Pipeline

  • Call REST API of ElectricFlow

  • Deploy Application using ElectricFlow

  • Trigger Release in ElectricFlow
  • Run Procedure in ElectricFlow

Connection Configurations

In order to use and integrate with ElectricFlow, you would have to create a connection configuration in Jenkins, that stores connection information of the Electric Flow 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 ElectricFlow section. One or more configurations can be created to connect to and call APIs into ElectricFlow 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 Electric Flow Server.
  • Server URL: Electric Flow Server URL

  • REST API Version: Electric Flow Server Rest API Version

  • User Name: Electric Flow user name for Connection

  • User Password: Electric Flow password for Connection

  • Override Electric Flow 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 Electric Flow as per the Electric Flow Server documentation.


Supported Post Build Actions

Following post build actions are available in ElectricFlow Plugin. These actions can be executed separately or combined sequentially.

Create Application from Deployment Package to ElectricFlow

This integration allows you to create and deploy Java, .Net or any other application to any environment in ElectricFlow. Deployment package would be generated as part of your Jenkins CI build, and contain a Manifest file and artifacts to be deployment. 

Sample manifest.json file can be found at https://github.com/electric-cloud/DeploymentPackageManager/tree/master/SampleManifests

This build action has following parameters:

  • Configuration: Name of the ElectricFlow configuration
  • Deployment Package Path: Location or path for the deployment package to be published to ElectricFlow. For e.g., MyProject/target


Publish Artifact to ElectricFlow

This integration allows you to publish the artifact for your application to ElectricFlow. The Artifact will be generated as part of your Jenkins CI build. 

This build action takes the following parameters:

  • Configuration: Name of the ElectricFlow configuration
  • Artifact Path: Location or path for the artifact files to be published to ElectricFlow. 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

  • ElectricFlow Repository Name: Name of the ElectricFlow Repository


Run Pipeline in ElectricFlow

This integration allows you to run a pipeline in ElectricFlow.

This build action takes the following parameters:

  • Configuration: Name of the ElectricFlow configuration
  • Project Name: Name of the ElectricFlow project

  • Pipeline Name: Name of the ElectricFlow pipeline

  • (Optional) Pipeline Parameters

    • Parameter name will be displayed as Label

    • Parameter value to be specified will be displayed as text input field


Call REST API of ElectricFlow

This integration allows you to call the ElectricFlow REST API

This build action takes the following parameters:

  • Configuration: Specify the name of the ElectricFlow 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

  • Body: Specify the body for the REST API


Deploy Application using ElectricFlow

This integration allows you to deploy an application using ElectricFlow.

This build action takes the following parameters:

  • Configuration: Specify the name of the ElectricFlow configuration
  • Project Name: Specify the ElectricFlow project name

  • Application Name: Specify the ElectricFlow application name

  • Application Process Name: Specify the ElectricFlow application process name

  • Environment Name: Specify the ElectricFlow environment name

  • (Optional) Deploy Parameters

    • Parameter name will be displayed as Label

    • Parameter value to be specified will be displayed as text input field


Trigger Release in ElectricFlow

This Integration allows you to trigger a release in ElectricFlow.

This build action has following parameters:

  • Configuration: Specify the name of the ElectricFlow configuration
  • Project Name: Specify the ElectricFlow project name

  • Release Name: Specify the ElectricFlow release name

  • (Optional) Starting Stage: Specify starting stage to run in the ElectricFlow pipeline

    • Parameter is required if ‘Stages to run’ isn’t used

  • (Optional) Stages to run: Specify stages to run in the ElectricFlow pipeline

    • Parameter is required if ‘Starting Stage’ isn’t used

  • (Optional) Pipeline parameters: Specify parameters for the ElectricFlow pipeline

    • Parameter name will be displayed as Label

    • Parameter value to be specified should go in the text input field


Run Procedure in ElectricFlow

This Integration allows you run a procedure in ElectricFlow.

This build action has following parameters:

  • Configuration: Specify the name of the ElectricFlow configuration
  • Project Name: Specify the ElectricFlow project name

  • Procedure Name: Specify the ElectricFlow procedure name

  • (Optional) Procedure Parameters

    • Parameter name will be displayed as Label

    • Parameter value to be specified should go in the text input field


Release Notes

Version 1.1.5 (Dec 19, 2018)

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.

Version 1.1.4 (Nov 22, 2017)

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)

Version 1.1.3 (May 9, 2017)

Support added for running plugin tasks from jenkins pipeline as per https://issues.jenkins-ci.org/browse/JENKINS-44084.

Version 1.1.2 (Apr 28, 2017)

More detailed output from plugin on build page results.
Hierarchy files output added to build page.

Version 1.1.1 (Apr 27, 2017)

General clean up of code.

Version 1.0 (Apr 26, 2017)

Initial Release.

  • No labels