Filters

CLEAR ALL

Search Results ()

Filter Icon

Search Results ()

    All Plugins (171)

    Filter Icon

    Quick Info

    Product icon
    Product
    DevOps Velocity (HCL Accelerate)
    Plugin type icon
    Type
    plugin
    Compatibility icon
    Compatibility
    HCL Accelerate 4.0.12 or later
    created by icon
    Created by
    HCL Software
    Published Date
    June 5th, 2023
    Last Updated
    September 1st, 2023

    Description

    The YAML Executor plug-in automates the initial setup process for integrating different CI/CD tools into HCL Accelerate. You can define the integration configurations in a YAML file and apply it in HCL Accelerate to automate the integration process.

    Quick Info

    Product icon
    Product
    DevOps Velocity (HCL Accelerate)
    Plugin type icon
    Type
    plugin
    Compatibility icon
    Compatibility
    HCL Accelerate 4.0.12 or later
    created by icon
    Created by
    HCL Software
    Published Date
    June 5th, 2023
    Last Updated
    September 1st, 2023

    ucv-ext-yaml-executor:0.0.6.tar

    Uploaded: 01-Sep-2023 11:11

    Pull Command

    docker pull hclcr.io/accelerate/ucv-ext-yaml-executor:0.0.6

    Release Notes

  • Started using timeSpan for Initial Sync date.
  • ucv-ext-yaml-executor:0.0.5.tar

    Uploaded: 02-Jun-2023 07:48

    Pull Command

    docker pull hclcr.io/accelerate/ucv-ext-yaml-executor:0.0.5

    Release Notes

  • Initial Release
  • Summary

    The YAML Executor plug-in is automatically installed and configured without manual configuration. You can apply the YAML file under Settings>External Config Pipeline to initiate the YAML Executor plug-in integration process.

    Steps

    Importing YAML configuration file into HCL Accelerate

    Import the YAML configuration file into HCL Accelerate by using any one of the following methods:

    Method 1: Using GitHub plug-in

    Integrate HCL Accelerate with a GitHub repository that contains the ucv.yml file to import the YAML configuration file into HCL accelerate.

    Perform the following steps to import the YAML configuration file using GitHub plug-in:

    1. Log in to HCL Accelerate.
    2. Click Settings>Integrations.
    3. In the Installed tab, click Add Integration for the installed GitHub plug-in.
      Note: If the GitHub plug-in is not installed, go to Available tab and click Install for GitHub plug-in.
    4. Enter the details in the required fields to add GitHub integration.
    5. Click Add to save the details and enable the integration.
      The YAML configuration file from the GitHub repository is automatically synced to HCL Accelerate and displayed under Settings>External config pipeline.

    Method 2: Using user interface

    You can import the YAML configuration file into HCL Accelerate using user interface if it is not hosted in a GitHub repository.

    Perform the following steps to add YAML configuration file using user interface:

    1. Log in to HCL Accelerate.
    2. Click Settings>External Config Pipeline.
    3. Click Download sample yaml to download the sample YAML file.
    4. Edit the sample file with the actual values of your configuration.
    5. Click Add new config file.
      Add New Config dialog opens.
    6. Click Choose file to select the edited file.
    7. Click Confirm to upload the file.
      The uploaded YAML configuration file is displayed in the list.
    8. To edit the existing YAML configuration file, perform the following steps:
      1. Click overflow menu of the YAML configuration file and then click Edit.
        The existing YAML configuration file will download.
      2. Edit the downloaded YAML configuration file.
      3. Click overflow menu of the YAML configuration file which you have edited and then click Update.
        Update config dialog opens.
      4. Click Choose file to select the edited file.
      5. Click Confirm to upload the file.
        The updated YAML configuration file is displayed in the list.

    Applying YAML configuration file

    Once you have the YAML configuration file in HCL Accelerate, perform the following steps to apply the configuration:

    1. Log in to HCL Accelerate.
    2. Click Settings>External Config Pipeline.
    3. Choose the required YAML configuration file in the list and click right angle bracket to preview the configuration details.
    4. Click Apply for the required YAML configuration file.
    5. Click overflow menu for the required YAML configuration file and then click View Logs to view the logs of the applied YAML configuration file.

    YAML configuration file properties

    The YAML configuration file is used to define configuration settings for automating the initial setup process for integrating various CI/CD tools into HCL Accelerate.

    YAML File Structure

    The following table describe the properties used to define the configuration in the YAML file.

    Property name Type Description Required
    version String The version number of YAML file. Yes
    integrations Array List of integration configurations. Yes

     

    Integrations

    The following table describe the properties that you must define under integrations:

    Property name Type Description Required
    type String Type or category of the CI/CD tool. Yes
    attributes Object Additional attributes specific to the integration. Yes
    configs Object Configuration object for the integration. Yes

    Configuration Object

    The following table describe the properties that you must define under configs :

    Property name Type Description Required
    name String Name of the configuration. Yes
    loggingLevel String Logging level for the integration. Yes
    deltaTime String Optional: Time difference for the integration. Yes

    For additional configuration properties depending on integration type, see: HCL Accelerate Plugins Configuration.

    Sample YAML configuration file

    Following is the sample YAML configuration file with two integrations:

    
    version: "8.0.0"
    integrations:
      - type: ucv-ext-launch
        attributes:
          auto-config: true
        configs:
          name: Launch Integration
          loggingLevel: DEBUG
          deltaTime: '2023-05-15T18:30:00.000Z'
          # Additional integration-specific fields for Launch Integration
    
      - type: another-integration
        attributes:
          auto-config: true
        configs:
          name: Another Integration
          loggingLevel: INFO
          # Additional integration-specific fields for Another Integration
        

    Replace the property values in the sample file with the actual values specific to your configuration.

    Customizing YAML configuration file

    Perform the following steps to customize the YAML configuration file for your required integrations:

    1. Open the YAML configuration file in a text editor.
    2. Update version property with the appropriate version number.
    3. Under integrations property, add or remove any property as required.
    4. For each integration, add typeattributes, and configs property.
    5. Under configs property, you must add the required properties based on the integration type.
    6. Set the auto-config attribute to true for enabling automatic setup of pipeline applications processes and environments after creating a new integration.
    7. Save the YAML configuration file.