Welcome
Installing
A HCL DevOps Deploy (Deploy) installation consists of a Deploy server, a database server, and at least one agent.
Installing agent relays
An agent relay is a communication proxy for agents that are located behind a firewall or in another network location. You can install agent relays in interactive mode or in silent mode.
Running agent relays as services using systemd
System requirements and considerations

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
A HCL DevOps Deploy (Deploy) installation consists of a Deploy server, a database server, and at least one agent.
- Firewall and communication configuration
  This topic describes the communication between the HCL DevOps Deploy (Deploy) components, the firewall, and the ports involved in the communication.
- Installing the server database
  You must install a supported database before you install HCL DevOps Deploy (Deploy). The database parameters such as database name, database username, and connection information are required at the time of Deploy installation.
- Installing the DevOps Deploy server
  The server provides services such as the user interface used to configure application deployments, the security service, and the artifact repository, among others. Installing the server involves specifying configuration information for the server, such as the ports that the server uses.
- Installing with Kubernetes
  The HCL DevOps Deploy (Deploy) server can be installed in a cloud-based environment, as a containerized server cluster, managed by Kubernetes. Deploy works with Kubernetes to simplify application deployment and manage versions in the containers.
- Installing agents
  You can install agents from the server or from the command line on the agent system. To configure a failover server for an agent, you must install the agent from the command line.
- Installing agent relays
  An agent relay is a communication proxy for agents that are located behind a firewall or in another network location. You can install agent relays in interactive mode or in silent mode.
  - Installing agent relays in interactive mode
    Installing an agent relay from the command line involves running a batch file or shell script and specifying information about the agent relay.
  - Installing agent relays in silent mode
    In silent mode, you specify the installation properties in a text file and then run the agent relay installation without command-line prompts.
  - Installing an agent relay in a Kubernetes cluster
    An HCL DevOps Deploy (Deploy)agent relay automates application deployments through your environments. Relays are especially good for coordinating environments with numerous agents. You can connect several agents outside the firewall to the server with a single relay.
  - Running agent relays as services using systemd
    - System requirements and considerations
    - Installing agent relays as services using systemd
      You can find information about the steps to install agent relays to run as systemd services. After you configure an agent relay using the systemd service, the agent relay automatically restarts when it stops abruptly.
    - Uninstalling agent relay services using systemd
      You can uninstall an agent relay running as a systemd service when the agent relay is no longer required.
  - Agent relay installation properties
    You can find the list of HCL DevOps Deploy (Deploy) agent relay properties that are used during the installation process.
- Installing plug-ins
  Plug-ins can be installed at any time. You do not need to restart the server after you install a plug-in.
- Starting DevOps Deploy
  Both UNIX™ and Windows™ installations require the HCL DevOps Deploy (Deploy) server and at least one agent. Also, make sure that the appropriate driver is installed and configured.
- Installing and uninstalling test fixes (patches) from the server
  Test fixes are provided to correct specific issues. They are applied to the server as patches.
- Uninstalling
  Learn how to uninstall the HCL DevOps Deploy (Deploy) server, and 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).
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.

System requirements and considerations

You can find information about the system requirements and considerations when you install the agent relay as a service by using the systemd software suite.

Supported operating systems

The systemd software suite supports the following operating systems:

RHEL 8, 9, and later versions
SUSE Linux Enterprise Server (SLES) 15 and later versions
Ubuntu 22.04, 24.04, and later versions

Note: The supplied systemd service unit file is tested on the listed operating systems and might not be compatible with other Linux distributions.

SLES considerations

For SLES-enabled systems, install the agent relay in the default location. Installing the agent relay outside the default location might prevent the systemd from starting the service and could result in error messages. You must consider the following when installing the agent relays on SLES-enabled systems:

When the agent relay is installed in the default location, it can run as a non-root user. Configure the file ownership settings correctly.
If you do not install the agent relay in the default location, the self-upgrade feature may not apply appropriate labels when replacing files. This feature might prevent the service from starting after an upgrade.
When the agent relay is installed and configured correctly, the service runs with minimum restrictions beyond the traditional UNIX restrictions.

Considerations for Deploy 8.0.1 and earlier versions

The unit files embedded with the Deploy package are not compatible with older versions of Deploy (8.0.1 or earlier) with systemd. Users of the older product versions must continue to use System V Init scripts.

Note: The operating systems that support running the agent relays with systemd also support System V Init scripts.

The systemd's System V Init compatibility functionality allows systemd to interpret and manage legacy System V Init scripts. This functionality enables the older versions and applications to run on systems using the systemd without modifying scripts. This compatibility functionality requires the installation of compatibility packages.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.