Welcome
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
Agents and agent relay configuration
After you install an agent for HCL DevOps Deploy (Deploy), you can modify its configuration or create an agent relay to facilitate communication to remote relays.
Updating the JRE location for agents
If you upgrade the JRE and change the JRE location on agents, you must also update the JRE location in the agent Java configuration file.

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.
- Backup and recover
  You can back up and recover the contents of your HCL DevOps Deploy (Deploy) installation.
- High availability and failover
  You can configure clustered HCL DevOps Deploy (Deploy) servers, and agents for high availability. You can also configure agents and agent relays for failover.
- Setting up high-availability clusters
  To configure a high-availability cluster, you store shared files on network storage. Then, you configure multiple servers, set each server to access the same files and database, and configure a load balancer to distribute the traffic between the servers.
- Adding cold standby servers
  You can add cold standby servers to serve as a backup server or for disaster recovery. You must start the secondary server or servers when the active server fails, and network traffic is routed to the secondary servers.
- Server settings and configuration
  After you install HCL DevOps Deploy (Deploy), you can modify the server configuration and configure more options.
- Setting your profile
  As a HCL DevOps Deploy (Deploy) user, you can manage teams and roles for your account, and preferences such as display options, language for the server, and how the server shows times and dates.
- Agents and agent relay configuration
  After you install an agent for HCL DevOps Deploy (Deploy), you can modify its configuration or create an agent relay to facilitate communication to remote relays.
  - Agent security and communication
    Agents use SSL-secured WebSocket, and HTTPS protocols to communicate with the server.
  - Managing agents remotely
    After an agent is installed, you can manage (with the monitor process) many of its features from the HCL DevOps Deploy (Deploy) web application.
  - Managing Java packages on an agent
    You can upload, install, and manage Java packages on compact agent using the web UI.
  - Managing Java packages on agents in bulk
    You can manage the Java distribution on your numerous agents by using Bulk Actions.
  - Updating the JRE location for agents
    If you upgrade the JRE and change the JRE location on agents, you must also update the JRE location in the agent Java configuration file.
  - Creating and managing agent pools
    Similar to resource groups, agent pools help you organize and manage agents that are installed in different environments.
  - Migrating agents to Web
    Agent Configuration Templates allow you to migrate JMS agents on a server to Web agents with the ability to revert back to the original JMS configuration. This allows you to specify connection details for groups of agents.
  - Removing and reinstalling agents as Windows™ services
    If you installed an agent as a Windows™ service, you can remove and reinstall the service.
  - Setting agent properties
    Agent properties store information that are relevant to a specific agent.
  - Updating the JRE location for agent relays
    If you upgrade the JRE and change the JRE location, you must also update the agent relays. If you do not change the location of the JRE, you do not have to update these files.
  - Changing passwords for the agent relay keystores
    You can change the Java™ keystore passwords for the agent relay.
  - Managing agent relays remotely
    After an agent relay is installed, you can manage many of its features from the HCL DevOps Deploy (Deploy) web application.
  - Migrating agents relays to Web
    JMS agent relays on a server can be migrated to Web with the ability to revert back to the original JMS configuration. This allows you to specify connection details for groups of agent relays.
- Licensing
  HCL DevOps Deploy (Deploy) provides a 60-day license-free evaluation period. You must have a license to use all product features after the evaluation period.
- Configuring the AI settings
  You can configure the AI settings to integrate an AI service, such as OpenAI. The AI service is used by the Deploy users to troubleshoot deployment failures.
- Setting up the wizard for new users
  HCL DevOps Deploy (Deploy) includes a wizard to help users become familiar with the procedures and steps in creating a deployment. Some configuration is required before the wizard can be used.
- Customizing the table views
  Customize a table view in the HCL DevOps Deploy (Deploy) application by hiding or showing, and reordering of the table columns.
- Managing data
  This section gives details about how you can manage your data in HCL DevOps Deploy (Deploy)
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.

Updating the JRE location for agents

If you upgrade the JRE and change the JRE location on agents, you must also update the JRE location in the agent Java configuration file.

Before you begin

Verify the supported Java version for agents. See Prerequisite software.
You have installed the new JRE on the target agent and set the JAVA_HOME environment variable of the system.

Important: Do not use the server UI to restart the agent.

Procedure

On the agent system, stop the agent.
See Agent executable command-line commands.
Edit the location of the JRE in the Java home configuration file.
- On Linux™ or AIX, edit the installation_directory/conf/agent/javahome file.
- On Windows™, edit the installation_directory\conf\agent\javahome.conf file.
  Note: For example, add the new location of the JRE on Windows™ as:
```
C:\Program Files\Java\jdk-17.0.0
```
- If the agent is running as a service on Windows™, remove and reinstall the service. See Removing and reinstalling agents as Windows services.
  Note: For the Windows service of agents, you must update the JAVA_HOME property in installation_directory\conf\agent\javahome.conf file with the new location of Java, and then recreate the Windows service.
On the agent system, start the agent.
See Agent executable command-line commands.

Results

You have updated the JRE of the active agents.