Welcome
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
Plug-ins
The Deploy plug-ins provide tools for creating component processes and integrations. HCL provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
Installing plug-ins
You can install plug-ins from the Deploy Web UI and the plug-ins site.
Installing plug-ins from the plug-in site
You can install plug-ins by downloading them from the plug-ins site and loading them into the Deploy product.

Release Notes
This section includes what's new, defect fixes, and deprecations and removals in all releases.
System Requirements
This document includes information about the hardware, containers, prerequisite software, supported operating system, and database requirements with component level detail for the HCL DevOps Deploy (Deploy).
Getting Started
Quickly become productive with HCL DevOps Deploy (Deploy).
Installing
An HCL DevOps Deploy (Deploy) installation consists of a Deploy server, a database server, and at least one agent.
Upgrading and Migrating
Stay updated with latest features and functionalities by upgrading HCL DevOps Deploy (Deploy) server, agents, and relays. This section also provides instruction on how to migrate your Deploy instance.
Integrating
HCL DevOps Deploy (Deploy) supports integrations with other IBM® and HCL products, products from others, and certain cloud systems.
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
Managing Security
HCL DevOps Deploy (Deploy) uses a flexible team-based and role-based security model that maps to your organizational structure.
Modeling Software Deployment
Modeling software deployment in HCL DevOps Deploy (Deploy) includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.
Deploying
Learn how to deploy applications in HCL DevOps Deploy (Deploy).
Reporting
Provides several different deployment and security reports.
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- Plug-ins
  The Deploy plug-ins provide tools for creating component processes and integrations. HCL provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
  - Installing plug-ins
    You can install plug-ins from the Deploy Web UI and the plug-ins site.
    - Installing plug-ins from the plug-in site
      You can install plug-ins by downloading them from the plug-ins site and loading them into the Deploy product.
    - Installing plug-ins from the Web UI
      To avoid navigating to the plug-ins site, you can seamlessly install the latest plug-in versions directly from the Web UI.
  - Creating plug-ins
    You can create your own plug-ins for use with HCL DevOps Deploy (Deploy). A plug-in consists of XML files and supporting script files that the plug-in requires.
  - Example plug-in
    A plug-in consists of one or more steps. A step represents a unit of functionality that can be user-configured and combined with other steps into a process. Creating a plug-in consists in defining its individual steps and then grouping them together for presentation in HCL DevOps Deploy (Deploy).
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.
- Process-as-code feature
  Programmatically manage processes with PAC language.
Troubleshooting and Support
Learn how to troubleshoot some common issues with HCL DevOps Deploy (Deploy).
Security Considerations
You can act to ensure that your installation is secure and set up user access controls.

Installing plug-ins from the plug-in site

You can install plug-ins by downloading them from the plug-ins site and loading them into the Deploy product.

About this task

You can browse, download, and get documentation for external plug-ins from the HCL Plug-ins site. The site contains many plug-ins that are available in the Deploy product.

The site includes plug-ins that are developed by the following sources:

HCL Software — Your Deploy license entitles you to download and install the plug-ins that are developed by HCLSoftware.
Partners — Plug-ins that are provided by partners can be purchased from the partner website. Search for partner to find the partner plug-ins in the plug-ins site.
Note: Support for each partner plug-in is provided exclusively by the partner who provided the plug-in.
Community — Plug-ins are provided by members of the Deploy community on the HCLSoftware Deploy Community website. Search for community to find the community plug-ins in the plug-ins site. You can contribute to code in the community or use code posted there to incorporate into your own.
Note: Support is provided exclusively through the community.

Procedure

On the Web UI, go to Settings > Automation > Installed Plugins.
Load the plug-in by clicking Load Plugin.
Enter the path to the compressed plug-in file, and then click Submit.

Results

The plug-in is installed and listed on the Installed Plugins page. After the plug-in is installed, it is available immediately.

Notes:

You do not need to restart the server after you install a plug-in.
You can upgrade a plug-in by installing the new version over the old version.
You cannot roll back a plug-in version to a previous version from the Web UI. To move to a previous version of a plug-in, see Rolling back a plug-in version to a previous version.