Project Backup

  • Last update: 2024-07-22
  • Overview

    Version

    FineOps Version

    Functional Change

    V1.5.5

    /

    V1.12.0

    Enhanced pre-backup disk space check requirements to avoid disk space exhaustion caused by backups.

    Adjusted O&M projects' backup and restoration requirements, and allowed restoring from backups made within 24 hours.

    V1.16.0

    Supported the backup management of FineDataLink applications.

    V2.7.0

    Simplified the backup content by cancelling backing up the following folders to avoid taking too much time:

    1. Cancelled the backup of standalone FineReport templates of previous versions: /assets/vcs.

    2. Cancelled the backup of standalone FineDataLink snapshots of previous versions: /dpworks/records.

    3. Cancelled the backup of the cluster's Excel source files: /assets/temp_attach.

    4. Cancelled the backup of FineDataLink cluster's snapshots of previous versions: /dpworks/records.

    Application Scenario

    FineReport, FineBI, and FineDataLink applications have built-in backup and restoration functions, but they have some limitations:

    1. Application backup files can only be stored in the project directory and do not support off-site backups. If the project is accidentally deleted, the backup may also be deleted.

    2. As the number of templates and data within the application increases, the speed of backups decreases.

    3. During application backups, JAR packages, templates, and configurations are backed up and restored separately, but these contents need to be backed up and restored uniformly according to time points in most cases.

    iconNote:

    When backing up containerized projects, the self-prepared components will not be backed up and cannot be restored.

    You are advised to manually back up these components during project backups, and to restore them synchronously when performing a restoration.

    Function Description

    FineOps provides Backup Management function.

    • You can choose one-click backup or automatic backup.

    • You can back up projects to the server where FineOps is located, and realize off-site backups.

    • You can manage backups, and view backup failure records and other information on the page.

    Prerequisite

    Confirming Image Repository Configuration

    When backing up projects deployed via the O&M platform, you may need to back up relevant images. Therefore, you must ensure the platform is properly connected to the image repository.

    Therefore, if the platform is not configured with an image repository, the backup function cannot be used, and a prompt will appear: "Use this function after configuring the image repository."

    Setting Backup Limit

    Since backups occupy server memory, you need to limit the number of backups and the occupied disk space.

    Log in to FineOps as the admin, set the limits under Setting > Backup Setting, and click Save.

    These settings apply to all projects within the O&M platform.

    Setting Content

    Description

    Backup Limit

    You can limit the maximum number of backups for each O&M project.

    When the number of manual or automatic backup files for a project reaches the upper limit, the earliest backup file will be automatically deleted. You can keep three manual and three automatic backups respectively by default.

    Disk Limit

    You can set a constraint value for the remaining available disk space of the O&M platform's backup save directory. 

    The backups are normally stored in the /ops/resources/backup folder of the O&M platform's mounting directory.

    • If no backups exist, during the first backup, the backup will not proceed if the remaining available space in the save directory is less than twice the set value.

    • If backups already exist, the backup will not proceed if the remaining available space in the save directory is less than the sum of the size of the most recent backup and the set value.

    • The default value is 5 GB.

    Project Backup

    Two backup methods:

    • Manual backup: Admins can manually trigger project backups.

    • Automatic backup: You can set automatic backup time, and the O&M platform will automatically back up the project at specified time points.

    Manual Backup

    Log in to FineOps as the admin, click a project, and choose Maintenance > Backup Management.

    1. Selecting Backup Content:

    Project Type

    Selection

    Backup Content

    FineOps-deployed Projects

    Deselecting Image Backup

    For details about backing up contents of the project mounting directory and the cluster file server, see:

    Installation Directory Preparation

    iconNote:

    1. The following contents of the project or file server are not backed up.

    • Templates of previous versions: /assets/vcs

    • Snapshots of previous versions: /dpworks/records

    • Excel source files: /assets/temp_attach

    • Data storage: bi-minio

    2. For the projects deployed via FineOps, the self-prepared components will not be backed up and cannot be restored.

    You are advised to manually back up these components during project backups, and to restore them synchronously when performing a restoration.

      Selecting Image Backup

      1. You can back up the current version of the project components' image files.

      2. For details about backing up all the contents of the project mounting directory and the cluster file server, see:

      Installation Directory Preparation

      iconNote:

      1. For 2.7.0 and above versions, the following contents of the project or file server will not be backed up.

      • Templates of previous versions: /assets/vcs

      • Snapshots of previous versions: /dpworks/records

      • Excel source files: /assets/temp_attach

      • Data storage: bi-minio

      2. For the projects deployed via FineOps, the self-prepared components will not be backed up and cannot be restored.

      You are advised to manually back up these components during project backups, and to restore them synchronously when performing a restoration.

        Non-FineOps Deployed Projects

        Deselecting JAR Package Backup

        You can back up the current configuration file of the project, including the following content of each project node and file server: assets, classes, config, embed, plugins, reportlets, and resources.

        iconNote:
        For 2.7.0 and above versions, the following contents of the project or file server will not be backed up.
        • Templates of previous versions: /assets/vcs

        • Snapshots of previous versions: /dpworks/records

        • Excel source files: /assets/temp_attach

        • Data storage: bi-minio

        Selecting JAR Package Backup

        1. You can back up the current version of the project's JAR package files

        2. You can back up the current configuration file of the project, including the following content of each project node and file server: assets, classes, config, embed, plugins, reportlets, and resources.

        iconNote:
        For 2.7.0 and above versions, the following contents of the project or file server will not be backed up.
        • Templates of previous versions: /assets/vcs

        • Snapshots of previous versions: /dpworks/records

        • Excel source files: /assets/temp_attach

        • Data storage: bi-minio

        2. Starting the Backup

        You can start backing up the project manually by clicking Start Backup, setting the name of the backup, and clicking OK.

        After starting the backup, you can switch to other pages for operations, as the backup process can run in the background.

        iconNote:

        1. If the number of manual backups exceeds the upper limit, a prompt will appear: "There are already X manual backups of this project. This backup will overwrite the earliest manual backup. Do you want to continue?"

        2. If the remaining available space in the backup save directory is less than the limit set in section "Setting Backup Limit", the backup will fail.

        3. Backup file names must be unique to prevent duplication.


        Scheduled Automatic Backup

        Log in to FineOps as the admin, click a project, and choose Maintenance > Backup Management.

        1. Selecting Backup Content:

        Project Type

        Selection

        Backup Content

        FineOps-deployed Projects

        Deselecting Image Backup

        For details about backing up all the contents of the project mounting directory and the cluster file server, see:

        Installation Directory Preparation

        iconNote:

        For the projects deployed via FineOps, the self-prepared components will not be backed up and cannot be restored.

        You are advised to set the same frequency of automatic backups for these components when configuring project backups, and to restore them synchronously when performing a restoration.

        Selecting Image Backup

        1. You can back up the current version of the project components' image files.

        2. For details about backing up all the contents of the project mounting directory and the cluster file server, see:

        Installation Directory Preparation

        iconNote:

        For the projects deployed via FineOps, the self-prepared components will not be backed up and cannot be restored.

        You are advised to set the same frequency of automatic backups for these components when configuring project backups, and to restore them synchronously when performing a restoration.

          Non-FineOps Deployed Projects

          Deselecting JAR Package Backup

          You can back up the current configuration file of the project, including the following content of each project node and file server: assets, classes, config, embed, plugins, reportlets, and resources.

          Selecting JAR Package Backup

          1. You can back up the current version of the project's JAR package files

          2. You can back up the current configuration file of the project, including the following content of each project node and file server: assets, classes, config, embed, plugins, reportlets, and resources.

          2. Starting the Backup

          Enable the Automatic Backup button and set Backup Frequency. At the specified time, the O&M platform will automatically back up the project.

          The name of the automatically generated backup will be the time of backup.

          iconNote:
          1. If the number of automatic backup exceeds the upper limit set in section "Setting Backup Limit", the earliest backup file will be automatically deleted.

          2. If the remaining available space in the backup save directory is less than the limit set in section "Setting Backup Limit", the automatic backup will not continue.

          Backup Management

          Backup Generation Location

          The content generated by automatic or manual backups is stored in the O&M platform's mounting directory /ops/resources/backup. You cannot modify the backup location.

          You can separate the servers for the O&M platform and projects to realize backups on different machines.

          Displaying Backup Information

          Details of each backup are displayed in a detail table under Full Backup. The remaining available space in the backup save directory is displayed in the upper right corner.

          Item

          Description

          Backup Name

          The name of the backup file

          Backup Type

          The type of backup, including: manual backup and automatic backup

          Start Time

          The time when the backup started (to the second)

          End Time

          The time when the backup ended (to the second)

          Backup Size

          The size of the backup file

          Deleting Backup

          Select the to-be-deleted backup, and click the Delete button to remove it. See the following figure:

          Renaming Backup

          Click the Edit button next to a backup to rename it, and click OK to apply the new name.

          iconNote:

          Backup file names must be unique to prevent duplication.


          Record of Backup Failure and Restoration

          Click Record of Backup Failure and Restoration to view the detail table of failed backup and restoration records. See the following figure:

          Viewing Backup Directory Name

          For non-containerized deployments, manually generated backups are displayed as IDs in the corresponding directory of the O&M platform. You can hardly identify the front-end display content corresponding to each backup file, creating inconvenience during restoration.

          For non-containerized deployments, you can view the backup directory name by hovering the cursor over manually generated backups. You can copy the name to the clipboard by clicking the button.

          Attachment List


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