Welcome
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
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.
Configuring existing agents and agent relays for high-availability
You must configure the agents and agent relays before converting them for a high-availability environment.

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.
  - Setting up clusters of servers
    To configure a cluster of servers, set up a shared database and file system for the servers to use.
  - Adding servers to clusters
    You can add new servers to a cluster at installation time, or you can move existing servers to be part of a cluster.
  - Converting a stand-alone server to high availability
    You can convert an HCL DevOps Deploy (Deploy) server into the first node of a high-availability cluster.
  - Configuring existing agents and agent relays for high-availability
    You must configure the agents and agent relays before converting them for a high-availability environment.
- 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.
- 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, Azure OpenAI, WatsonX, and Ollama. 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.

Configuring existing agents and agent relays for high-availability

You must configure the agents and agent relays before converting them for a high-availability environment.

When migrating an existing single-server environment to a high-availability (HA) cluster, verify the connection end-points configured on all existing agents and agent relays. If the end-points do not already point to the appropriate cluster Load Balancer, Virtual IP address (VIP), or common DNS name, then update them accordingly.

For information about the properties that must be updated and their configuration requirements, see:

Important:

When configuring or updating existing agents and agent relays for an HA environment, you must follow the property-specific configuration requirements described in the agent and agent relay installation properties topics.
WebSocket connection properties support multiple end-points for failover.
The properties that are used for CodeStation HTTP artifact traffic require a single Load Balancer or VIP URL and do not support multiple URLs or failover-list syntax.