Welcome
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
Server settings and configuration
After you install HCL DevOps Deploy (Deploy), you can modify the server configuration and configure more options.
Management of maintenance blackouts
You can manage important updates to ensure that tasks run smoothly without interfering with ongoing deployments by using maintenance blackouts. You can manage maintenance blackouts by creating a recurrence blackout, rescheduling an existing blackout, creating a specific environment blackout, and canceling an existing blackout.
Enabling maintenance mode
Maintenance mode blocks certain activities on the server so you can run important tasks that require the server to be idle.

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.
  - Increasing the amount of memory that is available to the server
    If you see "Out of memory" errors or are using the server at high capacity, increase the amount of system memory that is available to the server.
  - Modifying the context root of the server
    After you install the server, you can modify the context root, if your server configuration requires it.
  - Management of maintenance blackouts
    You can manage important updates to ensure that tasks run smoothly without interfering with ongoing deployments by using maintenance blackouts. You can manage maintenance blackouts by creating a recurrence blackout, rescheduling an existing blackout, creating a specific environment blackout, and canceling an existing blackout.
    - Creating recurrence maintenance blackouts
      You can schedule a maintenance in a daily, hourly, weekly, or monthly recurrence pattern.
    - Updating maintenance blackouts
      You can change the name and description of the past and upcoming recurring blackouts in a series.
    - Enabling maintenance mode
      Maintenance mode blocks certain activities on the server so you can run important tasks that require the server to be idle.
    - Canceling maintenance blackouts
      You can cancel the entire recurrent deployment series or just a single deployment blackout event without impacting the other deployments in the recurrence series.
  - Changing the database password
    If you change the password for your database, you must update the password on the server.
  - Changing passwords for the server KeyStore
    You can change the Java™ KeyStore password for the server.
  - Changing passwords for the encryption KeyStore
    You can change passwords for the encryption KeyStore.
  - Changing passwords for the Tomcat keystore
    You must change the default passwords for the Tomcat keystore and private keys.
  - Changing or updating the JRE of servers
    You can change the JRE of active servers by editing their configuration files.
  - Working with Notifications
    HCL DevOps Deploy (Deploy) can send email notifications whenever user-defined trigger events occur on the server.
  - Managing locks
    A lock ensures that processes do not interfere with one another. Normally, locks are released after they are no longer needed. Sometimes, a lock is not released, and its associated process is unable to complete.
  - System settings
    System settings allows you to manage global settings for components, clean up, password requirement, security, mail-server, and much more.
- 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.

Enabling maintenance mode

Maintenance mode blocks certain activities on the server so you can run important tasks that require the server to be idle.

Before you begin

Ensure that you have the permissions to manage maintenance mode.

About this task

When you enable maintenance mode, users can log in to the server as usual and perform some limited tasks. A message is displayed at the top indicating the start and estimated end time of the maintenance activity. While the maintenance mode is enabled, some of the tasks/actions are blocked and some are allowed. Below is a list of such tasks:

Tasks blocked during maintenance mode	Tasks not blocked during maintenance mode
Execution of new global, component, and application processes. With additional permissions, you can allow users to execute new deployments while maintenance mode is enabled.	Processes which are started before maintenance mode are allowed to run for completion.
Execution of processes triggered by the calendar, including recurring deployments.	Sub-processes kicked off by processes that are started before maintenance mode are allowed.
Execution of processes triggered by a repeating a process request.	Manual tasks that are part of a process can be responded to, and the process are allowed to continue.
Approval or rejection of any approval tasks.	Making changes to the server, such as changing properties, creating elements such as applications and resources, and editing processes.
New version imports.	-
Automatic version imports.	-
Processes started upon completion of a version import.	-
Auto Discovery.	-
Auto Compare.	-
Auto Configure.	-

Procedure

To enable maintenance mode immediately:

Click Settings > System Settings.
Activate the Enable Maintenance Mode option in the General Settings field.
Save the settings.

To schedule maintenance mode with a maintenance blackout,

Click Settings > Manage Maintenance Blackout, and create a maintenance blackout by selecting the start date and time and end date and time.
When the blackout period starts, the Deploy Server enters maintenance mode. The server is not shut down, but certain activities are blocked as described above.

Note: You require permissions to create a maintenance blackout.

Results

The maintenance mode is enabled.

What to do next