Upgrading O&M Projects on the Internal Network

  • Last update: 2026-07-21
  • Overview 

    Version 

    FineOps VersionFunctional Change
    V1.5.5
    /
    V2.12.0

    Reduced backup requirements for upgrading O&M projects by allowing upgrading O&M projects with a backup generated in the past 24 hours.

    V2.15.0 

    Added a Batch Upgrade function for components.

    Application Scenario 

    FineReport/FineBI is continually updated to meet new customer requirements and improve some features of previous releases.

    After deploying the containerized FR/BI projects, you need to update and upgrade the projects regularly, but you may encounter some problems with the traditional upgrade approach.

    1. The minor upgrades of FineReport (intranet)/FineBI require manually replacing JAR packages, which is challenging.

    2. You may need to upgrade the project to a specified version rather than the latest version due to compatibility issues. It requires manually replacing JAR packages, which is challenging. 

    3. Upgrading FineReport (extranet) requires manually restarting the project or all nodes of the cluster, which is troublesome.

    4. A failed upgrade cannot be rolled back automatically, causing risks.

    Function Description 

    FineOps provides a project-oriented upgrade function.

    For projects in environments with only access to the internal network, use the full FineKey deployment package to upgrade FineOps, push the latest project component images to the local image repository, and then use FineOps to upgrade the project to the latest version.

    1. It enables upgrades to the latest or specified version.

    2. It implements secure upgrades via the internal network by pushing the image.

    3. Rollback is executed automatically upon upgrade failure.

    Notes

    1. This solution applies to FanRuan projects deployed in the internal network environment. To upgrade projects with access to the Internet to the latest version, see Upgrading O&M Projects over the Internet.

    2. Although FineOps can push a single image to the local image repository, you are advised to use FineKey to push all component images into the repository. 

        This ensures that the latest versions of images of all components in the project are available, so you (the admin) can upgrade all these components to the latest versions.

    3. The latest FineKey package does not include FineBI 6.x-related images, so this solution cannot be used for upgrades within minor versions of FineBI 6.x

        To achieve upgrades within minor versions of FineBI 6.x, contact FanRuan technical support through the service platform to obtain the required image package. For details about how to contact technical support personnel, see Technical Support Channel Introduction.

    Prerequisite 

    Containerized Deployment 

    FineOps's upgrade function is only valid for projects deployed in a containerized manner. Projects of non-containerized deployment do not support the relevant operations of this document.

    Project Version Confirmation 

    Check the current project version first.

    Log in to the FineReport/FineBI project as the admin and choose System Management > Registration Management > Version Information to view the project version number.

    Check the update logs of FineReport or FineBI, check the latest version number released by FanRuan, and confirm the version to which the project needs upgrading.

    Cluster Configuration Inspection

    Before upgrading multi-application clusters, ensure Cluster Management of all nodes has been configured. (Note that all FineBI 6.1 projects are considered clusters even if they have only a single application node.)

    Ensure that each project node is properly connected to the file server, the state server, the data storage component, and the external configuration database.

    If connections are abnormal or interrupted, permanent loss of project files may occur after upgrades, where templates and data will be unrecoverable.


    Project Backup 

    You are advised to back up the whole project before updating components to prevent uncontrollable accidents during the upgrade.

    You cannot perform upgrades if no backup from the past 24 hours is detected. A prompt will appear, saying "Failed to upgrade the component. Ensure a backup in the past 24 hours before upgrades. Try again after backing it up."

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

    Tick Image Backup (recommended). Click Start Backup to back up the whole project.

    iconNote:

    Some files are not backed up (such as files in /assets/temp_attach). Back up these files yourself.

     For details about the backup content, see Project Backup.

    Image Pushing 

    Saving the Original YAML File 

    Obtain the finekey.yaml file in the finekey/conf path of the original containerized deployment tool.

    Obtaining FineKey of a Specified Version 

    Latest Version

    Contact the technical support personnel to get the installation package.

    Specified Version

    Paid users contact the technical support personnel to request the image file of a specified version. You need to provide the minor version number of FineReport/FineBI. 

    For details about how to contact technical support, see Technical Support Channel Introduction.

    The technical support personnel will provide the FineKey tool corresponding to the required version, which contains the image package.

    Uploading the FineKey Installation Package 

    Upload the FineKey tool package to the server (Linux OS) where FineOps is located.

    In this document, the package is uploaded to the /home path of the server where FineOps is located, as shown in the following figure.

    Decompressing the FineKey Installation Package 

    1. Use the cd command to enter the folder where the tool package is located.

    2. Use the following command to decompress the package. (Adjust the command according to the actual package name.)

    tar zxvf finekey-amd64-tomcat-all-publish.tar.gz.

    The extracted files are shown in the following table.

    Folder/File

    Description

    finekey/bin

    It is an executable file for running the FineKey tool.

    finekey/conffinekey.yaml

    It is the configuration file of the newly deployed FineOps.

    finekey.push.yaml

    It is used to pull the image of the configuration file.

    finekey/resourcesIt is the resource file, whose image is placed in the images folder.

    Configuring the YAML File 

    The YAML file refers to the finekey.yaml file in the conf folder that controls the entire upgrade process.

    Replacing the finekey.yaml File

    Open the obtained finekey.yaml file of the original FineKey deployment tool, copy the value of each configuration item, and paste it into the new finekey.yaml file in the finetkey/conf path of the new FineKey deployment tool one by one.

    icon

    Note:


    Do not replace the YAML file or copy and paste all the contents of the file, as there may be slight differences in the content of the YAML file of the old version and the new version. Copy and paste the values one by one.

    Pushing the Image 

    1. Use the cd command to enter the /bin directory in the folder where the tool package is located.

    2. Run the following command to start the upgrade

    ./finekey update

    icon

    Note:

    You must use the commands described in the document. Do not replace them with other commands (for example, sudo ./finekey update). Otherwise, deployment failure may occur.

    Checking Images in the Repository

    Log in to FineOps after the successful push and choose Maintenance Center > Image Management to view the new images pushed into the repository. 

    Write down the target version number for subsequent use.

    Version Upgrade 

    You can upgrade the components after image preparation.

    Notes

    1. When updating the O&M project components, you can upgrade multiple components in batches or upgrade a component individually. You cannot update partial containers of a component.

    • This setting ensures version consistency of containers of the same component.

    • You are advised to upgrade all project components to the latest versions to improve project security. 

    2. Some components have an upgrade dependency. For example, updating the FineBI - Application Node component (the master component) will trigger an upgrade of the Engine - Calculation Node component (the slave component).

    • For components with an upgrade dependency, the Upgrade button of the slave component is grayed out, and you can only upgrade the master component.

    • When you upgrade a master component, a prompt will appear, saying "If an upgrade is triggered, Component name will stop and be upgraded to the corresponding version."

    Procedure

    You can upgrade multiple components in batches or upgrade a specific component individually.

    You are advised to upgrade all project components to the latest versions to improve project security.

    Single Component Upgrade

    1. Log in to FineOps as the admin and select the required O&M project. Choose Maintenance > Component Management.

    2. Find the component to be upgraded and click Upgrade.

    icon

    Note:


    For components with an upgrade dependency, the Upgrade button of the slave component is grayed out, and you can only upgrade the master component.

    When you upgrade a master component, a prompt will appear, saying"If an upgrade is triggered, Component name will stop and be upgraded to the corresponding version."

    3. Click Start Upgrade. A prompt will appear, saying "Components will be restarted during an upgrade, which may affect the normal operation of the project. Do not perform this operation during use. Confirm the upgrade?"

    Click Confirm. The component upgrade begins, as shown in the following figure.

    The Component Management page is refreshed automatically after the upgrade is completed, and a prompt is displayed, saying "Upgraded successfully." The message "Already the latest version." is displayed at Lastest Version of the component.

    Batch Component Upgrade

    1. Log in to FineOps as the admin and select the required O&M project. Choose Maintenance > Component Management and click Batch Upgrade.

    Choose Start Upgrade > OK. You do not need to enter the version number. All components will be upgraded to the latest versions.

    • When an upgrade is triggered, all components will stop running and be updated to the latest versions, which may affect the normal operation of the project. Do not perform this operation during use.

    • If there is no backup within 24 hours, the update will be terminated. You can update the project after backing up the project.



    Attachment List


    Theme: Loading/Update/Migration/Capacity Expansion of Exi
    Previous
    Next
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy