Project Restoration

  • Last update: 2025-06-20
  • Overview

    Version

    FineOps VersionFunctional Change
    V1.5.5/
    V1.12.0Allowed restoring an O&M project if there was a backup of the project within 24 hours.
    V1.16.0Allowed backing up and restoring FineDataLink projects.
    V2.3.0

    1. Allowed restoring unavailable projects.

    2. Allowed specifying new servers during restoration in case of server unavailability.

    V2.20.0

    Optimized the file restoration logic of the FineBI Master engine to ensure consistency with data extraction status.

    Application Scenario

    You can restore a project from the project backup generated by FineOps.

    Restoring FineOps-Deployed Projects

    Projects deployed via FineOps support one-click restoration in FineOps.

    Project Restoration

    1. Log in to FineOps as the admin, click the O&M project to be restored, and choose Maintenance > Backup Management.

    2. Find the required backup file in Backup Record and click the xx icon.

    3. A prompt will appear: "The restoration will last for a period, during which the project to be restored cannot be used. Are you sure to restore it?" Click the OK button to start restoration.

    iconNote:

    For FineBI 6.1 projects, the data in the rocks_data file of the Engine - Metadata Node component maintains a 1:1 correspondence with data extraction status.

    Generally, the rocks_data file of the Engine - Metadata Node component will not be restored since standard backup and restoration operations do not cover extracted data.

    • If detecting a rocks_data directory on the target server, FineOps will skip restoration of this file.

    • If detecting no rocks_data directory on the target server (for example, when you specify a new server for the Engine - Metadata Node component, FineOps will restore the rocks_data file.


    Troubleshooting

    If the following issues occur, the restoration cannot proceed normally, and troubleshooting/additional configuration is required.

    Missing a Backup Within 24 Hours

    Issue description: Restoration fails with a prompt, saying "Ensure a backup in the past 24 hours before restoration. The current project is backed up at Time last time. Try again after backing it up."

    Cause analysis: A valid project backup created within the last 24 hours is required as a fallback mechanism. This ensures recovery if restoration from other backups fails.

    Solution: Perform a full backup of the project before restoring it. For details, see Project Backup.

    Missing Component Images

    Issue description: Restoration fails with a prompt, saying "The Image name image is missing. Contact technical support to obtain the image and try again."

    Cause analysis: Restoration will fail if FineOps does not detect the image of the backup-specified version.

    Solution:

    1. Premium users can contact technical support personnel to obtain the image package of the corresponding version. For details about how to contact technical support, see Technical Support Channel Introduction.

    2. Push the image to the repository. For details, see Pushing Image to the Repository Manually.

    Missing Project Nodes

    Issue description: A prompt appears during restoration: "The number of current project nodes is less than the backup-time node count. Check whether the OPS Agent component of each node is started, or add nodes."

    Scenario One: Restoration cannot be performed if the OPS Agent component on some project nodes is not started.

    • Click the project in FineOps and choose Maintenance > Component Management.

    • Locate the OPS Agent component and click Restart. Ensure the status of all containers is running.

    Scenario Two: If the number of current project nodes is less than the backup-time node count, you must add a required number of nodes before restoration.

    • Click Add Node to enter the node configuration page. A prompt will appear: "Currently lack X main application node(s) and X component node(s)."

    • Click Add Node and add the required number of nodes.

    iconNote:

    1. The new servers must meet the requirements for deploying projects. For details, see New Project Deployment.

    2. The new servers must be clean instances. If detecting an OPS Agent component on the new server, FineOps will consider that a project has been deployed on this server. Restoration failure will occur with the prompt: "An OPS Agent component exists on the specified node Node name."

    • After adding the required number of nodes, click OK to start project restoration.

    iconNote:
    If the node hosting cluster components is decommissioned in the current project, you must reconfigure the cluster after successful restoration.

    Excess Project Nodes

    Issue description: Restoration fails with a prompt, saying: "The number of current project nodes is more than the backup-time node count. The project cannot be restored from this backup. Disable redundant nodes or try again with other backups."

    Cause analysis: The project scaled out after backup creation, causing topology drift that blocks restoration.

    Solution: Do not use this backup for restoration.

    If restoration is necessary, premium users can contact FanRuan technical support personnel for assistance. For details about how to contact technical support, see Technical Support Channel Introduction.

    Restoring Non-FineOps-Deployed Projects

    Projects not deployed via FineOps do not support one-click restoration in FineOps. This section describes how to manually restore them.

    Backing up the Project Before Restoration

    Restoring projects from backups might fail due to external dependencies. (Take the config folder that stores information about the external database as an example. Restoring this folder will fail if the original external database involved in the backup file is unavailable.)

    Therefore, you are advised to perform a complete backup of the project before restoration, or to create a snapshot of the server as a fallback mechanism. For details, see Project Backup.

    Locating the Backup File

    1. Log in to FineOps as the admin, click the O&M project to be restored, and choose Maintenance > Backup Management.

    2. Find the required backup file in Backup Record and click the xx icon to copy the backup directory name.

    3. Log in to the FineOps server via terminal, navigate to FineOps mounting directory/ops/resources/backup, and find the above-mentioned backup directory.

    This directory stores the project files for this backup.

    1711522899b2sp_fixed.jpeg

    Restoring the Project

    Project Node Closing

    Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project.

    Project File Restoration

    Restore the files on each project node/file server using the backup files obtained in the previous section.

    Backup FileTarget PositionDescription
    assets

    Standalone: /webroot/WEB-INF/assets

    Cluster: File server path/assets

    It stores general shared and persistent directories, FineReport template backups, and cached content (including images) of project read-write operations.
    reportlets

    Standalone: /webroot/WEB-INF/reportlets

    Cluster: File server path/reportlets

    It stores FineReport templates.
    resources

    Standalone: /webroot/WEB-INF/resources

    Cluster: File server path/resources

    It stores license files and files for template encryption.
    classes

    Standalone: /webroot/WEB-INF/classes

    Cluster: /webroot/WEB-INF/classes of each project node

    It stores default and custom class files to be called by the project.
    config

    Standalone: /webroot/WEB-INF/config

    Cluster: /webroot/WEB-INF/config of each project node

    It stores information about the FineDB configuration database to be called by the platform.
    embed

    Standalone: /webroot/WEB-INF/embed

    Cluster: /webroot/WEB-INF/embed of each project node

    It stores built-in FineDB databases that were or are used by the project. Even if you currently use an external configuration database, you are advised to back up this folder for easy rollback.

    plugins

    Standalone: /webroot/WEB-INF/plugins

    Cluster: /webroot/WEB-INF/plugins of each project node

    It stores plugin-related files.

    Project Node Restart

    Restart the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. After startup, the project can run normally.


    Attachment List


    Theme: Project Management
    • Helpful
    • Not helpful
    • Only read