Configuring the BACKUP Component

The BACKUP component is a dedicated Platform Private Cloud module that handles system backup and restore jobs. It separates backup and restore processing from the STORAGE component while preserving existing customer workflows.

You can deploy multiple BACKUP components in a multi-server environment. Active BACKUP components share the database-backed backup queue and atomically claim available jobs.

Prerequisites

Before enabling the BACKUP component:

  • Deploy the backup.war application on one or more Platform application-server nodes.

  • Ensure each BACKUP node can connect to the Platform databases.

  • Ensure each BACKUP node can access the customer storage location configured by StorageDir.

  • For customers using third-party cloud storage, ensure the BACKUP node can access the cloud service.

  • Verify the BACKUP component appears as active in the System Console.

  • Configure the number of BACKUP job consumers using Backup Jobs Thread.

  • Make sure Enable Backup Component property is enabled.

Enabling the component does not automatically migrate customers from STORAGE to BACKUP. Use BACKUP Migration Routing to select customers for migration.

Component endpoints

The BACKUP web application provides these internal component endpoints:

  • /backup/health/ping - Health check.

  • /backup/servlet/Component - Component status and running-job information.

These endpoints support Platform component communication and operational monitoring. Do not expose them as public customer APIs.

Verification

To verify the BACKUP component:

  1. Navigate to the Backup Component Information page using the following path:

    System Console > Components > BACKUP

  2. Verify the BACKUP component is active and review its status and running-job information.

  3. Submit a backup for a test customer assigned to BACKUP.

  4. Verify the job appears in Monitoring > Jobs and the completed activity appears in View Backup Log.