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:
- From the home page, click Settings > Integrations > Available.
- In the Action column for the HCL DevOps Deploy plug-in, click Install.
To integrate the plug-in, perform the following steps:
- From the home page, click Settings > Integrations > Installed.
- In the Action column for the HCL DevOps Deploy plug-in, click Add Integration.
- On the Add Integration page enter values for the fields used to configure the integration and define communication.
- 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:
- Navigate to value stream page, and then click the necessary value stream.
- Click icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
- 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.
- 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.
- 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"
}
} ]
Summary
Usage
Configuration Properties
