Home
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.
Enabling maintenance mode
Maintenance mode stops activity on the server so you can run important tasks that require the server to be idle.

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.
  - Enabling maintenance mode
    Maintenance mode stops activity on the server so you can run important tasks that require the server to be idle.
  - 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 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 user preferences
  Each user can specify display options for the server, including the 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. To use all product features after the evaluation period, you must have a license.
- 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

Enabling maintenance mode

Maintenance mode stops activity on the server so you can run important tasks that require the server to be idle.

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 and estimated end time of the maintenance activity. While the maintenenace mode is enabled, some of the tasks/actions are blocked and some are allowed. Below is a list of such tasks:

What is 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.
Execution of processes triggered by the calendar, including recurring deployments.
Execution of processes triggered by a repeating a process request.
Approval or Rejection of any approval tasks.
New version imports.
Automatic version imports.
Processes started upon completion of a version import.
Auto Discovery.
Auto Compare.
Auto Configure.

What is not blocked during maintenance mode?

Processes which begun before maintenance mode are allowed to run to completion.
Sub-processes kicked off by processes that begun before maintenance mode are allowed.
Manual tasks that are part of a process can be responded to, and the process are allowed to continue.
Make changes to the server, such as changing properties, creating elements such as applications and resources, and editing processes.

Procedure

Click Settings > System Settings.
Activate the Enable Maintenance Mode option in the General Settings field.
Save the settings.
To schedule a full system shutdown, select the start date and time and end date and time for the scheduled full system blackout.
This step takes the database offline during the dates selected for maintenance.

Note: You require permissions to set up full system blackout. Go to Settings > System Settings > Manage Maintenance Blackout, and enable the Create Maintenance Blackout option.

What to do next

Make sure you do not restart the server until all processes have completed.
You can disable maintenance mode by clearing the Enable Maintenance Mode option. You need appropriate permissions to manage maintenance mode.