O&M Project Update with Intranet

  • Last update: 2024-04-28
  • Overview 

    Version 

    FineOps VersionFunctional Change
    V1.5.5
    /
    V1.12.0

    The requirements of backups for upgrading O&M projects are reduced. An O&M project can be upgraded with a backup generated in the past 24 hours.

    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.

    Prerequisite 

    Containerized Deployment 

    The FineOps Update function is only valid for projects deployed in a containerized manner, and 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.

    Project Backup 

    You are advised to back up the whole project before updating components to prevent uncontrollable accidents during the update. Log in to FineOps as the admin, select the required project, and choose Maintenance > Backup Management.

    You are advised to tick Image Backup. Click Start Backup to back up the whole project.

    Image Pushing 

    Saving the Original YAML File 

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

    Obtaining the FineKey of 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 installation 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.


    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.

    Folder/File

    Description

    finekey/bin

    An executable file for running the FineKey tool.

    finekey/conffinekey.yaml

    The configuration file of newly deployed FineOps.

    finekey.push.yaml

    Used to pull the image of the configuration file.

    finekey/resourcesThe 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 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 directory 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

    Checking the Repository Image

    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 Update 

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

    2. Find the component to be updated, click Update, enter the version number (the one in the repository), and click Start Updating.   

    • If there is a backup within 24 hours, no backup operation is needed. Update the component directly.

    • If there is no backup within 24 hours and the FineOps disk space is sufficient, back up the project first, and then update the component.

    • If there is no backup within 24 hours and the FineOps disk space is insufficient, clean up or expand the disk before updating the component.

    Attachment List


    Theme: 项目管理
    Previous
    Next
    • Helpful
    • Not helpful
    • Only read