Intranet-Based O&M Project Upgrade

Version 

Application Scenario 

FineReport/FineBI is continually updated to meet new customer requirements and improve on 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 updates 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 component-oriented update function.

1. It allows for updating the component to the latest and specified version.

2. It maintains the security of intranet updates by pushing the image.

3. Any failed updates can be automatically rolled back.

Validity 

This function applies to intranet updates only, where the project component can be updated to the specified and latest version by the image pushed through the FineKey tool.

Note:

1. Finekey of the latest version does not include FineBI 6.0-related images by default. Therefore, this solution does not apply to minor version upgrades of FineBI 6.0.

2. To upgrade FineBI to FineBI 6.0.x using the intranet, contact FanRuan technical support personnel through the service platform to obtain image packages. For details about how to contact technical support personnel, see Technical Support Channel Introduction.

Containerized Deployment 

The FineOps's Update 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 to be updated.

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 update.

You cannot perform updates if no backup from the past 24 hours is detected. A prompt will appear, saying "Failed to update the component. Ensure a backup in the past 24 hours before updates. 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.

Note:

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.

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. 

To contact our technical support, you can send an email to international@fanruan.com.

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.

tar zxvf finekey-operation.tar.gz

The extracted files are shown in the following table.

Configuring the YAML File 

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

Replace 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 them into the new finekey.yaml file in the finetkey/conf path of the new FineKey deployment tool one by one.

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 update. 

./finekey update

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.

You can update the components after image preparation.

Notes

1. When updating the O&M project components, you can update multiple components in batches or update 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 update all project components to those of the latest versions to improve project security. 

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

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

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

Procedure

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

You are advised to update all project components to those of the latest versions to improve project security.

Single Component Update

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 updated and click Update.

Note:

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

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

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

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

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

Batch Component Update

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

Choose Start Update > OK. You do not need to enter the version number. All components will be updated to those of the latest versions.

• When an update is triggered, all components will stop running and be updated to those of 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.