• Overview
  • Documentation
  • Version history

Description

DevOps Deploy is engineered to handle the most complex deployment situations with push-button automation and controlled auditing needed in production. DevOps Deploy automates application deployments across varying IT environments.

The DevOps Deploy plug-in for HCL DevOps Velocity imports deployment data from DevOps Deploy into HCL DevOps Velocity. Applications in DevOps Deploy can be mapped in the HCL DevOps Velocity pipeline and the application versions can be tracked from the pipeline.

Quick Info

Product icon

Product

HCL DevOps Velocity (HCL Accelerate)
Plugin type icon

Type

plugin
Compatibility icon

Compatibility

HCL DevOps Velocity 5.0.0 or later; HCL Accelerate 2.0x to 4.0.x
created by icon

Created by

HCLSoftware

Published Date

Last Updated

Summary

The DevOps Deploy plug-in for HCL DevOps Velocity synchronizes applications, processes, components, versions, snapshots, teams, environments, and more from DevOps Deploy. A Deploy application can be configured as an application in an HCL DevOps Velocity pipeline and the DevOps Deploy processes can be configured in the HCL DevOps Velocity pipeline. The HCL DevOps Velocity pipeline can then display the latest version of the application deployed to different environments.

Compatibility

The DevOps Deploy plug-in requires HCL DevOps velocity version 2.3 or later.

Usage

To use the DevOps Deploy plug-in, the plug-in must be loaded and an instance created before you can configure the plug-in integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The DevOps Deploy plug-in supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
syncAppResources Syncs applications, components, environments, processes, agents and status data.
syncSnapCompVersions Syncs inventories and snapshots data.
syncAppCompRequests Syncs application and component process requests.
syncInProgressRequests Syncs in-progress application process requests.

Notes:

  • The plug-in had only syncLaunchEvent and SyncInProgressAprsEvent scheduled events for the plug-in versions 3.4.2 till 4.0.3.
  • The plug-in had only syncLaunchEvent scheduled event for the plug-in versions up to 3.4.1.

Integration

There are two methods to integrate the plug-in:

  • Using the user interface
  • Using a JSON file

Using the user interface

To install the plug-in, perform the following steps:

  1. From the home page, click Settings > Integrations > Available.
  2. In the Action column for the HCL DevOps Deploy plug-in, click Install.

To integrate the plug-in, perform the following steps:

  1. From the home page, click Settings > Integrations > Installed.
  2. In the Action column for the HCL DevOps Deploy plug-in, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Integrating the plug-in by using JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plug-in properties can be defined. Refer to the JSON sample code in Configuration Properties section.

To integrate the plug-in using a JSON, perform the following steps:

  1. Navigate to value stream page, and then click the necessary value stream.
  2. Click icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
  3. Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
  4. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section more details.
  5. Click Save.

Minimum permission to integrate with HCL DevOps Deploy

The access token generated from HCL DevOps Deploy must have the following permissions to connect with HCL DevOps Deploy.

  • VIEW_APPLICATIONS
  • EDIT_APPLICATIONS
  • VIEW_ENVIRONMENTS
  • EXECUTE_ENVIRONMENTS
  • MANAGE_SECURITY
  • SETTINGS_TAB

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plug-in integrations.
  • The HCL DevOps Deploy Configuration Properties table describes the configuration properties that define the connection and communications with the HCL DevOps Deploy server. When using the JSON method to integrate the plug-in these properties are coded within the properties configuration property.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plug-in that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the integration. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plug-in configuration properties used to connect and communicate with the HCL DevOps Deploy server. Enclose the properties within braces. Yes properties
  The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plug-in. The value for the HCL DevOps Deploy plug-in is ucv-ext-launch. Yes type
HCL DevOps Deploy Configuration Properties
Name Type Description Required Property Name
Access Token String Token to authenticate against HCL DevOps Deploy. Yes launchToken
Url String HCL DevOps Deploy server url. Yes baseUrl
Build Polling Timeout String Length of time (in minutes) to wait for build to complete if task is set to wait. The default value is 10. No buildPollingTimeout
User Access Key String The user access key to authenticate with this server. Yes ucvAccessKey

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.


 "integrations": [
    {
      "type": "ucv-ext-launch",
      "tenant_id": "tenantid",
      "name": "Deploy_Plugin ",
      "properties": {
        "Url": "deploy_server_url",
        "launchToken": "deploy_access_token"
      }
    }  ]

ucv-ext-launch:5.0.7.tar

Uploaded: 05-Aug-2024 08:20

Release Notes

In this version, the automation task execution mechanism got modified. Previously we used to do completion of tasks during sync event. Now during the execution of the automation task, completion of the task happens. It is helpful for giving exact user to the devops velocity and makes the execution faster. Build Polling Timeout as a new parameter is added in the plugin which indicates Length of time (in minutes) to wait for build to complete if task is set to wait. Users can customize the Build Polling Timeout as per the need. Along with that a property which is a wait property is added. During the addition of the task, the wait property is in true state by default. It indicates the plugin will wait for the build to complete. If it is explicitly set to false, then the plugin will not be built to complete.

ucv-ext-launch:5.0.6.tar

Uploaded: 22-May-2024 09:00

ucv-ext-launch:5.0.5.tar

Uploaded: 03-Apr-2024 09:21

ucv-ext-launch:5.0.4.tar

Uploaded: 16-Feb-2024 10:30

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:5.0.4
 

Release Notes

Create dedicated events

  • Sync applications and resources
  • Sync snapshots and components
  • Sync application and component process requests
  • Sync in-progress application process requests to sync data from DevOps Deploy server

Objective: Improve performance, quick setup, maintain independence, facilitate debugging

ucv-ext-launch:4.0.3.tar

Uploaded: 29-Nov-2023 10:25

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:4.0.3
 

Release Notes

  • Started uploading statuses to Snapshot and Component versions

ucv-ext-launch:4.0.2.tar

Uploaded: 18-Sep-2023 06:44

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:4.0.2
 

Release Notes

  • Using version properties for mapping build.url parameter

ucv-ext-launch:4.0.1.tar

Uploaded: 18-Aug-2023 15:09

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:4.0.1
 

Release Notes

  • Set Launch user as deployment executor
  • Default initial sync to 30 days

ucv-ext-launch:3.4.6.tar

Uploaded: 09-Jun-2023 13:50

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:3.4.6
 

Release Notes

  • Removed Version as Mandatory. Enable to select no version for the external Launch Plugin

ucv-ext-launch:3.4.5.tar

Uploaded: 10-Apr-2023 10:32

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:3.4.5
 

Release Notes

  • Bug Fix: In previous version - Launch plugin was not syncing more than 100 applications and it was resulting in Snapshot Upload failure.
  • Sync All Applications at First Sync: Now Launch plugin is syncing all the applications, environments, processes, and components data even if an initial sync date is given.

ucv-ext-launch:3.4.2.tar

Uploaded: 15-Mar-2023 06:48

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:3.4.2
 

Release Notes

  • Bug Fix: In previous version of Launch plugin deployment plan was not getting completed if we have parallel and sequential tasks with Launch app.

ucv-ext-launch:3.4.1.tar

Uploaded: 09-Mar-2023 11:38

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:3.4.1
 

Release Notes

  • In the previous version of plugin the deleted Application processes were also available while selecting the process in the pipeline

ucv-ext-launch:3.3.56.tar

Uploaded: 24-Feb-2023 05:16

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:3.3.56
 

Release Notes

  • Removed HCL Launch Status Task: Assign status task is removed and made part of main HCL Launch Task as post deployment success or failure step for assigning Snapshot or Component Version status.

ucv-ext-launch:2.0.49.tar

Uploaded: 06-Jan-2023 13:01

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.49
 

Release Notes

  • Minor bug fix

ucv-ext-launch:2.0.48.tar

Uploaded: 28-Sep-2022 04:43

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.48
 

Release Notes

  • Uploading Deployment Data: Previous version of plugin was not uploading deployment data for inprogress and failed state.
  • Added Category: Build and Deploy are the category for Launch plugin.
  • Removed Manual User Access Key: From current version onwards this plugin will only support Auto Generated User Access Key feature.
  • Initial Sync Date Field Added: Under the hidden properties section of add integration page for the Launch plugin an Initial Sync Date field is added. This field is optional and can be used only for the first sync.

ucv-ext-launch:2.04.7.tar

Uploaded: 01-Aug-2022 06:08

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.47
 

Release Notes

  • Importing failed application deployment history

ucv-ext-launch:2.0.46.tar

Uploaded: 05-Jul-2022 11:32

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.46
 

Release Notes

  • Fixed Error: Variable $_v0_inventories got invalid value

ucv-ext-launch:2.0.44.tar

Uploaded: 01-Jul-2022 07:04

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.44
 

Release Notes

  • Minor Bug Fix

ucv-ext-launch:2.0.42.tar

Uploaded: 30-Jun-2022 10:45

ucv-ext-launch:2.0.36.tar

Uploaded: 08-Mar-2022 11:36

ucv-ext-launch:2.0.24.tar

Uploaded: 28-Oct-2021 11:17

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.24
 

Release Notes

  • new functionality

ucv-ext-launch:2.0.8.tar

Uploaded: 01-Oct-2021 04:00

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.8
 

Release Notes

  • Resync data feature added

ucv-ext-launch:2.0.6.tar

Uploaded: 13-Aug-2021 09:25

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.6
 

Release Notes

  • Pass version build url

ucv-ext-launch:2.0.5.tar

Uploaded: 30-Jul-2021 12:03

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.5
 

Release Notes

  • Bug Fix

ucv-ext-launch:2.0.2.tar

Uploaded: 26-May-2021 06:45

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:2.0.2
 

Release Notes

  • Implemented simple callback

ucv-ext-launch:1.0.26.tar

Uploaded: 01-Apr-2021 09:39

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:1.0.26
 

Release Notes

  • Removed teams sync

ucv-ext-launch:1.0.22.tar

Uploaded: 18-Mar-2021 09:54

ucv-ext-launch:1.0.18.tar

Uploaded: 12-Mar-2021 05:51

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:1.0.18
 

Release Notes

  • Improved error logs

ucv-ext-launch:1.0.15.tar

Uploaded: 08-Mar-2021 09:16

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-launch:1.0.15
 

Release Notes

  • Added Pagination for Components

ucv-ext-launch:1.0.3.tar

Uploaded: 19-Feb-2021 05:55

Related Plugins