Upgrading FineOps on the Internal Network

Version Description

Application Scenario

FineOps has been constantly updated and iterated to meet customers' new needs and improve some functions of earlier versions.

Users on an internal network are advised to upgrade FineOps with the FineKey tool. The upgrade will not affect the connected projects and historical data.

Note:

1. Users with Internet access can upgrade FineOps using the One-Click Upgrade function. For details, see Upgrading FineOps over the Internet.

2. You can review recent functional changes before upgrading FineOps. 

Confirming Node Connectivity

Make sure that the server of FineOps to be upgraded is connected with the server of the containerized deployment tool FineKey to be uploaded in the "Obtaining the FineKey Installation Package" section.

If the two servers are not connected, the upgrade method introduced in this document cannot be used. (You can upload FineKey to the server where the O&M platform resides.)

Confirming Remaining Disk Space

Confirm that the remaining disk space of the FineOps mounting directory is greater than 100 GB.

If it is less than 100 GB, this upgrade method cannot be used.

Confirming Whether an Upgrade Is Required

If the current version is already the latest, this upgrade method cannot be used.

Log in to FineOps as the admin, choose Platform Management > O&M Component, check the OPS component version, and compare it with the latest version listed in the FineOps update log.

Saving the Original YAML File

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

Obtaining the FineKey Installation Package

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. Users on an internal network should download the "Pure Version/Full Offline Installation Package".

Uploading the FineKey Installation Package

After obtaining the package, upload it to the Linux server where FineOps is located.

The following example shows that the package is uploaded to the /home directory on the FineOps server.

Decompressing the FineKey Installation Package

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

Configuring Finekey.yaml File

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

Replacing YAML File

Open the obtained finekey.yaml file of the original FineKey deployment tool in the "Saving the Original YAML File" section, 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.

Note:

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

Starting the Upgrade

1. Use the cd command to enter the bin directory of the FineKey package extracted in the "Decompressing the FineKey Installation Package" section before running the following command.

2. Start the upgrade with the command: 

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

Executing the Upgrade Process

After starting the upgrade, FineKey will follow these steps to upgrade FineOps. You should wait patiently for the upgrade to be completed.

Step	Content
Check upgrade prerequisites.	The FineKey tool will prioritize checking if the upgrade prerequisites in the "Upgrade Preparation" section are met. If the prerequisites are not met, the upgrade will end directly. If the prerequisites are met, FineKey will proceed to the next step.
Check component versions.	The FineKey tool will automatically check whether the versions of the components to be upgraded match the FineKey image versions. If they match, no upgrade is required, and this step will end directly. If they do not match, FineKey will proceed to the next step.
Back up components automatically.	The FineKey tool will automatically back up data mounted by components that need upgrading. Note: Upgrading specified components may close or back up associated components.
Replace and upgrade the image.	The FineKey tool will automatically change the image for the upgrade.
Restart FineOps.	The FineKey tool will automatically restart FineOps. If the restart is successful, the upgrade is successful. If the restart fails, it will automatically roll back and cancel the upgrade.

Updating O&M Components

After the upgrade of FineOps is completed, the latest images of O&M components that this version depends on will be automatically obtained. The overall upgrade is successful only after all O&M components are successfully upgraded.

After you upgrade 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 upgrade!"

Note:

If the prompt in the previous step does not appear, you need to choose Platform Management > O&M Component and click One-Click Upgrade to upgrade other components.

Checking Whether the Upgrade Is Successful

Log in to FineOps as the admin, and choose Platform Management > Update & Upgrade to view the version. The prompt "Already Latest Version" means the upgrade of FineOps is successful.

Problem Description

During the upgrade process, a Docker engine-related error is reported.

An error occurs (indicating upgrade failure with a non-finekey Docker) when you check the Docker version using the finekey statement.

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 upgrade 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 command, 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 upgrade again with the following command:

./finekey update

Notes

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.