FineOps Version
Functional Change
V1.5.5
V1.9.0
Included detecting and upgrading the docker engine version during the manual upgrade process to prevent functional issues caused by an outdated version.
V2.0.0
Optimized the interaction by adjusting the function entry location.
FineOps has been constantly updated and iterated to meet customers' new needs and improve some functions of earlier versions.
Intranet users can update and upgrade the O&M platform and its components using the containerized deployment tool. The upgrade will not affect the connected projects and historical data.
Make sure that the server of the O&M platform to be updated is connected with the server of the containerized deployment tool FineKey to be uploaded in section "Obtaining the FineKey Installation Package."
If the two servers are not connected, the update method introduced in this document cannot be used. (You can upload FineKey to the server where the O&M platform resides.)
Check whether the remaining disk space of the node to be updated is greater than 100 GB.
If it is less than 100 GB, the update method introduced in this document cannot be used.
Check whether any component of the node needs updating.
If no components need updating, the update method introduced in this document cannot be used.
Obtain the finekey.yaml file in the finekey/conf directory of the original containerized deployment tool.
You can contact the technical support personnel to obtain the installation package of FineOps. For contact methods, see Technical Support Channel Introduction.
There are three types of installation packages. Intranet users should download the "Pure Version/Full Offline Installation Package".
Installation Package Type
Description
Online Installation Package
1. In this type, the server can access the extranet. You can download images of O&M components. The installation package is small in size.
2. You can download images of FineReport/FineBI project components from the cloud, and deploy projects via FineOps visually.
3. You can connect to existing FineReport/FineBI projects.
Pure Offline Installation Package
1. In this type, the server is on the intranet, with built-in images of all O&M components. The installation package is large in size.
2. Images of FineReport/FineBI project components are not built-in, so you cannotdeploy projects via FineOps visually.
3. You can use it to connect to existing FineReport/FineBI projects.
Full Offline Installation Package
2. Images of FineReport/FineBI project components are built-in, so you can deploy projects via FineOps visually.
Upload the FineKey tool package to the Linux system.
In this example, the package is uploaded to the /home directory of CentOS 7.6.1810, as shown in the following figure.
1. Use the cd command to navigate to the folder where the tool package is located.
2. Enter the following command to decompress the package:
tar zxvf finekey-operation.tar.gz
The extracted files are shown in the following table.
Folders/Files
finekey/bin
An executable file for running the FineKey tool.
finekey/conf
finekey.yaml
The configuration file of newly deployed FineOps.
finekey.push.yaml
Used to pull the image of the configuration file.
finekey/resources
The resource file, whose image package is placed in the images folder.
The YAML file refers to the finekey.yaml file in the conf folder that controls the entire update process.
Replacing YAML File
Open the obtained finekey.yaml file of the original FineKey deployment tool in section "Saving the Original YAML File", copy the value of each configuration item and paste them into the new finekey.yaml file in the finetkey/conf directory of the new FineKey deployment tool one by one.
1. Do not replace the YAML file directly, 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. You are advised to copy and paste the values one by one.
2. If the FineKey deployment tool and FineOps are not on the same server, you need to add the IP address, username, and password of the node to be upgraded in the YAML file, and others will be automatically identified by FineKey.
update:nodes: - ip: localhost #Machine IP address port: 22 #Machine SSH port number user: #Node SSH user password: #Node SSH password# - ip: 192.168.101.145# port: 22# user: xxx# password: xxx
1. Use the cd command to enter the /bin directory in the folder where the tool package is located.
2. Start the update with the command: ./finekey update
After starting the update, FineKey will follow these steps to update FineOps. You should wait patiently for the update to be completed.
Step
Content
Check update prerequisite
The FineKey tool will prioritize checking if the update prerequisites in section "Update Preparation" are met.
If the prerequisites are not met, the update will end directly.
If the prerequisites are met, FineKey will proceed to the next step.
Check component version
The FineKey tool will automatically check whether the versions of the components to be updated match the FineKey image versions.
If they match, there is no need to update, and this step will end directly.
If they do not match, FineKey will proceed to the next step.
Back up component automatically
The FineKey tool will automatically back up data mounted by components that need to be upgraded.
Replace and update the image
The FineKey tool will automatically change the image for the update.
Restart FineOps
The FineKey tool will automatically restart FineOps.
If the restart is successful, the update is successful.
If the restart fails, it will automatically roll back and cancel the update.
After the update of FineOps is completed, the latest images of O&M components that this version depends on will be automatically obtained. The overall update is successful only after all O&M components are successfully upgraded.
After you update FineOps online and restart it successfully, when you log in to the platform as the admin, the platform will automatically detect and upgrade components.
Log in to FineOps as the admin, if there are O&M components that need to be upgraded, a one-click upgrade will be automatically performed. A prompt will appear: "The FineOps upgrade is at the final step, and this page will be automatically refreshed after the upgrade is completed. Do not close FineOps during the update!"
Log in to FineOps as the admin, and choose Platform Management > Update to view the version. The prompt "Already Latest Version" means the update of FineOps is successful.
Problem Description
During the update process, a docker engine-related error is reported.
Cause Analysis
There is a corresponding relationship between the docker engine, FineOps, and the ops_agent component of the project.
If you need to manually update FineOps, you must ensure that the server where FineOps is located and the server where the connected project is located both support upgrading the docker engine.
If the system is detected to prohibit upgrading the docker engine during the execution of the finekey update, an error will occur, and the upgrade will be interrupted.
Solution
1. Log in to the server where FineOps is located and each server where the connected projects are located successively and respectively.
2. Execute the command to upgrade the docker engine: ./finekey engine --update.
3. Start the update again with the previously used command: ./finekey update.
Note
When updating FineOps, the container on the server that triggered the docker engine upgrade will be restarted.
This will affect end users using the platform and projects. You are advised to perform upgrades during non-working hours to minimize the impact on your business.