Filters

Search Results ()

Search Results ()

    All Plugins (147)

    Quick Info

    Product
    HCL Accelerate
    Type
    plugin
    Compatibility
    HCL Accelerate version 2.3 or later
    Created by
    HCL Software
    Website
    Published Date
    August 5th, 2021
    Last Updated
    June 7th, 2022

    Description

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

    The Deploy Plugin for Accelerate imports deployment data from HCL Deploy into HCL Accelerate. Applications in HCL Deploy can be mapped in the Accelerate pipeline and the application versions can be tracked from the pipeline.

    Quick Info

    Product
    HCL Accelerate
    Type
    plugin
    Compatibility
    HCL Accelerate version 2.3 or later
    Created by
    HCL Software
    Website
    Published Date
    August 5th, 2021
    Last Updated
    June 7th, 2022

    ucv-ext-ucd:1.0.8.tar

    Uploaded: 07-Jun-2022 03:25

    Pull Command

    docker pull hclcr.io/accelerate/ucv-ext-ucd:1.0.8

    Release Notes

  • reduced vulnerability
  • ucv-ext-ucd:1.0.5.tar

    Uploaded: 28-Mar-2022 03:33

    Pull Command

    docker pull hclcr.io/accelerate/ucv-ext-ucd:1.0.5

    Release Notes

  • Re- branding of Launch Plugin to UCD
  • ucv-ext-ucd:1.0.3.tar

    Uploaded: 17-Mar-2022 06:45

    ucv-ext-ucd:1.0.1.tar

    Uploaded: 14-Mar-2022 06:59

    Overview

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

    Compatibility

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

    History

    The following table describes the changes made in each plugin version.

    Plugin history details
    Version Description
    1.0.5 Re-branding of HCL Launch Plugin to HCL Deploy.

    Steps

    Usage

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

    Integration type

    The HCL Deploy plugin supports scheduled events integration which are listed in the following table.

    Scheduled events
    Name Description
    syncDeployEvent Timed event that synchronizes with HCL Deploy

    Integration

    There are two methods to integrate the plug-in:

    • Using the user interface
    • Using a JSON file

    The tables in the Configuration properties topic describe the properties used to define the integration.

    Using the user interface

    1. From the Plugins page, click Settings > Integrations > Plugins.
    2. Under the Action column for the 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.

    Using a 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.

    1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
    2. Edit the JSON file to include the plug-in configuration properties.
    3. Save and upload the JSON file. This replaces the current JSON file with the new content.
    4. View the new integration on the Integrations page.

    Minimum permission to integrate with HCL Deploy

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

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

    Settings

    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 Deploy Configuration Properties table describes the configuration properties that define the connection and communications with the HCL 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 plugin configuration properties used to connect and communicate with the HCL 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 Deploy plugin is ucv-ext-ucd. Yes type
    HCL Deploy Configuration Properties
    Name Type Description Required Property Name
    Access Token String Token to authenticate against HCL Deploy. Yes deployToken
    Max Deploy deployment history days String Number of days to go back and retrieve deployment history on initial sync. No deployMaxDeploymentHistory
    Deploy team page size String Number of teams to read from HCL per request. No deployTeamsPagination
    Url String HCL Deploy server url. Yes baseUrl
    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-ucd",
          "tenant_id": "tenantid",
          "name": "Deploy_Plugin ",
          "properties": {
            "Url": "deploy_server_url",
            "ucvAccessKey": "ucv_access_key",
            "deployToken": "deploy_access_token"
          }
        }  ]