Managing API-driven pipelines#

API-driven pipeline applications

On the Pipeline page, you need to create a pipeline to incorporate API-driven applications.

API-driven pipeline applications enable you to effectively populate the pipeline and move dots through the system solely through build and deployment uploads. The create build and upload deployment API commands are displayed in the UI and can be executed in a command terminal. Advantages of using these build and deployment APIs are for providing simplified endpoints for loading data and allowing you to integrate the pipeline with unsupported tools. The relationship between the APIs and the pipeline phases that are populated are detailed in the following table.

API Pipeline phases
builds/apiDriven Input
deployments/apiDriven DEV, QA, PROD, and any environments in the pipeline.

  1. To map an application environment to the pipeline on the Pipeline page, complete the following steps:

    1. For the environment where you want to add the application, click Add button Add app.

    2. On the Add app - Choose the app window, in the Managed by list, select API-driven.

    3. Click either the Create new application or Use existing appplication radio button.

      Note: The Managed by and Description fields are already populated with API-driven.

    4. Based on the radio button you chose in the previous step, use the required procedure in the following table:

      Create new application Use existing application
      In the Application name field, enter the name for the application. This option links your pipeline application to an already existing application in HCL™ Accelerate. You can use the API-driven REST API to create new versions and deployments for this application.
      Click Save to add the application to the stage. Click the Existing application type drop-down to list all the applications in your database and select the application. Note: If you want to use the API to create versions and run deployments for plugins without pipeline capabilities, select Other.
        Click the Existing application name drop-down to list and then select the application.
        Click Save to add the application to the stage.

  2. To upload a build that will create a new version for that application, complete the following steps:

    1. Click Add button under the Input stage of the pipeline for the TEST API-driven Application application, used as an example and shown in the figure below. pipeline and test api driven application

      The Create version modal window will display a curl command, shown in the figure below, to interact with the TEST API-driven Application REST API. create a build through the api modal window

      Note: The Application name entered previously in the Add apps - Choose the apps window is displayed in the Create version modal window above the curl command. Refer to this page for more details on the builds/apiDriven API.

    2. Click copy icon to copy the curl command.

    3. Paste the curl command in a text editor.

    4. Edit the following user provided fields: <User Access Key>, <Version Name>, <Build URL>, and <Commit SHA>.

    5. Copy the curl command.

    6. Paste the curl command into a terminal or CI/CD automation scripts having network access to the HCL Accelerate server.

      Note: The displayed commands only work in the UNIX operating system. For MS-DOS operating systems, modifications will be required.

    7. Execute the curl command.

      Note: Running these commands manually in a terminal are typically performed for several initial test runs. This method is not recommended for production use. For best practice, add the create build and upload deployment curl commands directly in the CI/CDs for automatic triggering.

  3. Notify the pipeline of an Input version's deployment by completing the following steps:

    1. Click Add button under the DEV stage of the pipeline for the TEST API-driven Application application, used as an example and shown in the figure of the previous step.

      The Create a deployment through the API (DEV) modal window will display a curl command, shown in the figure below, to interact with the TEST API-driven Application REST API to upload a deployment to the aforementioned application. upload a deployment through the api modal window

      Note: The Application name entered previously in the Add apps - Choose the apps window is displayed in the Upload deployment status modal window above the curl command. Refer to this page for more details on the deployments/apiDriven API.

    2. Click copy icon to copy the curl command.

    3. Paste the curl command in a text editor.

    4. Edit the following user provided fields: <User Access Key>, <Version Name>, and <Deployment URL>.

    5. Copy the curl command.

    6. Paste the curl command into a terminal or CI/CD automation scripts having network access to the HCL Accelerate server.

      Note: The displayed commands only work in the UNIX operating system. For MS-DOS operating systems, modifications will be required.

    7. Execute the curl command.

      Note: Running these commands manually in a terminal are typically performed for several initial test runs. This method is not recommended for production use. For best practice, add the create build and upload deployment curl commands directly in the CI/CDs for automatic triggering.

Parent topic: Pipelines