OvalEdge Migration Process
      Back to home
      1. Knowledge Base
      2. Architecture, Security & Releases
      3. OvalEdge Migration Process

      Release6.3 Migration Process for Container-Based Model

      This document provides guidance on migrating from previous versions to the latest 6.3 version.

      Prerequisites for Migration

      Before initiating the migration process, ensure that the following prerequisites are met:

      Supporting Application Configurations 

      • Upgrade Infrastructure (Optional)

        Ensure that the applications and the operating system support the upgraded amount of RAM and have sufficient space on the new SSD for optimal performance.

      • Upgrade Database Version

        Upgrade the database to the below-mentioned versions for software performance and security. The previous versions of MySQL are no longer supported. 

      • Upgrade MariaDB Version to 10.6.x or 10.10.x. 

      • Pre Upgradation

        • Take Database Backup

          Ensure a comprehensive backup of the Database (MySQL or MariaDB) is taken. Refer to the following document for backup instructions. For more information, OvalEdgeDB Backup Process

        • Table Row Count Validation

          Validate the row count of all database entities to confirm the success of the migration process. Detailed instructions are available in the provided document. DB Migration Checklist

      Application Backups

      Before commencing the migration, execute the following backup and validation procedures:

      Database Backup

      Before starting the migration, ensure a comprehensive backup of the Database (MySQL or MariaDB) is taken.

      Image Backup 

      Backing up the image ensures that if the primary image becomes corrupted or lost during migration, it can be rolled back to the previous state if needed.

      Helm Charts Backup

      Helm charts contain the configuration details necessary to deploy and manage applications within Kubernetes clusters. Backing up these charts ensures the deployment environment is protected in case of any issues during migration.

      System Settings Backup

      Take the backup of the system settings table from the OvalEdge database in XLSX format to ensure the configured default settings are available to reflect in the new version.

      Migration Process

      For Container-based systems, the migration process involves updating the YAML (value.yaml) properties by replacing the older image name with a new one and uploading lineage and CSP jars if they are read from EFS. Refer to the document for more information EFS Volume Mount with Access point.


      Note: Lineage and csp-lib jars should be placed in third-party jars mounted on the EFS service, as referred to in the EFS Mount document. Please refer to the document to configure oasis.properties 6.1 to 6.2 Changes in oasis.properties file.

      oasis.properties to Migrate from 6.2 to 6.3

      Please note that the following configurations are included in the Master DB Instance and the Read Replica Instance Sections.

      Master DB Instance Section

      # Mysql 8.0.x Driver and Url for Azure Entra ID authentication

      #driverClassName=com.mysql.cj.jdbc.Driver

      #url=jdbc:mysql://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false&allowPublicKeyRetrieval=true&authenticationPlugins=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin


      # MariaDB 10.x.x Driver and Url for Azure Entra ID authentication

      #driverClassName=org.mariadb.jdbc.Driver

      #url=jdbc:mariadb://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false&authenticationPlugins=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin

      Read Replica Instance Section

      # MySQL 8.0.x Url for Azure Entra ID authentication

      #read.url=jdbc:mysql://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false&allowPublicKeyRetrieval=true&authenticationPlugins=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin


      # MariaDB 10.x.x Url for Azure Entra ID authentication

      #read.url=jdbc:mariadb://localhost:3306/ovaledgedb?useUnicode=true&character_set_server=utf8mb4&useSSL=false&allowPublicKeyRetrieval=true&authenticationPlugins=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin

      Governance App Configurations 

      These configurations are crucial to redirect users to governance-related applications using email or direct links.  Refer to the document to configure the Governance application. Governance App Configuration

      Configure One Pod at a Time

      It's crucial to emphasize bringing one pod at a time.

      As shown in the screenshot below, the job pod should be set to zero during deployment.

      The jobdeployment.yaml & uideployment.yaml file should contain the below parameters as comments as shown in the screenshot until the migration process is complete. 


      Note: Post Migration, uncomment the above parameters and restart the deployment. 

      Post Migration Checks

      Tables & Row Count Validation

      Conduct a thorough verification of Tables & data row counts in the post-migration environment.

      Ensure that the actual counts match the pre-upgradation counts to identify and rectify any discrepancies. This will serve as a key indicator of a successful migration.

      The SQL scripts can be used to validate row and table counts.

      Download the scripts from the following S3 link: Tables and Row Count Validation Scripts. 

      Verify Application

      Verify that the latest enhancements and features are successfully deployed in the application post-migration.

      Run the Migration Advance Jobs

      This involves running the Migration Advance Jobs, which are essential processes for ensuring the proper functioning of OvalEdge in its upgraded state. Detailed instructions are in Appendix A of the migration documentation.

      Verify System Settings

      The migration process does not mandate adjustments to any system settings. However, it's important to note that for Release 6.3, new system settings have been introduced, some have been deprecated, and others have undergone modifications. For more information, please refer to the appendices below.

      Appendix A: Migration Advanced Jobs

      While migrating to Release6.3, the following advanced jobs must be run

      Run the same advanced job that was run for Release6.2 migration and additionally run the below listed advanced job to migrate to Release6.3. 

      A1: 6.3 Migration Advanced Job Checklist 

      Advanced Job Name

      Module Name

      Description

      INSERT_NOTIFICATION_PREFERENCE

      User Notification Preferences Manager

      This job enables the addition of new modules and submodules in the notification preference table of the My Profile section for all users. 

      METADATA_CURATION_SCORES_TO_DENORMALIZED_TABLES

      Meta Data Curation Scores 

      This migration job helps to calculate the metadata curation score for existing objects in version 6.2 and saves the metadata curation score values in denormalized tables(ext) associated with the objects.

      UPDATE_CODE_SORTORDER

      Helpful Resources

      This job helps to migrate helpful resources from 6.2 to 6.3. It lets users move the previously added helpful resources using the drag-and-drop option in the updated version.

      Note: This job sorts the order of existing helpful resources for customers migrating from 6.1/6.2 to 6.3. A fresh installation does not require this job.

      RestoreBusinessGlossaryObjectsSourceInfo

      Business Glossary

      This job helps to migrate source information for associated objects in the business glossary for previously added objects.

      Note: 

      • From Release6.3, the source information for associated objects is automatically generated.
      • This job is used to restore the BG source info for the customers migrating from 6.1/6.2 to 6.3. A fresh installation does not require this job.

      QUESTIONWALL_MIGRATION

      QuestionWall Migration

      This job helps to migrate the questions and answers (replies) previously found in Question Wall > Inbox to Question Wall > General Wall.

      LOAD_DATA

      Data Stories Migration

      This Advanced Job is designed to transfer Data Stories from one environment to another. It lets users download Data Stories from the source environment and upload them to the target environment using the same job. 

      Attributes: 

      Attr1: Specify ""Upload"" or ""Download"" based on the action. For Downloads, use Attr1 = ""Download""; for Uploads, use Attr1 = ""Upload"". 

      Attr2 - Enter File Server Connection Id (optional).

      Attr3 - Enter the file path. 

      Attr4 - Enter Story Zone Names or IDs with comma-separated values (optional)

      Attr5 - Enter Story Names or IDs with Comma-separated values (optional).

      POWERBI_MIGRATION

      Reports

      This job helps move the existing report columns and their curated information to their related report columns, dataset columns, and page columns, which in turn move to report columns.

      Note: This job must run if the client has a PowerBI connection created in versions before 6.3.

      FILL_CRON_AND_ASSOCIATION_DESC

      Schedule 

      This job helps to include the filter icon options for the Schedule > Cron type column in the administration and improves the search functionality in the Data Catalog > Codes > Associations > Associate objects column.

      PROJECT_STATUS_SYNC

      Projects

      This advanced job syncs old and new project statuses and stats in the updated version, required for migrating the current application to version 6.0.

      Attributes: No attributes needed.

      Appendix B: New System Settings Added in Release6.3

      The latest release introduces new configurations that provide users with even greater control over the application's behavior. The newly added configurations are shown below.

      Key

      Description

      assetmanager.virusscan.enabled

      Configure to enable virus scan for the uploaded files.

      Parameters:

      The default value is False.

      If set to True, virus scan on files is enabled.

      If set to False, virus scan on files is disabled.

      assetmanager.storage.service

      Configure to upload a file from the Governance Apps and store it in the mentioned storage service.

      Parameters:

      The default value is Empty.

      Enter the storage service name.

      assetmanager.storage.connId

      Configure to enter the connection ID of the storage service.

      Parameters:

      The default value is Empty.

      Enter the connection ID.

      assetmanager.storage.service.bucketname

      Configure to enter the bucket name of the storage service.

      Parameters:

      The default value is Empty.

      Enter the storage service bucket name.

      oe.crawl.excludeTables

      Configure to hide the tables.

      Parameters:

      The default value is Empty.

      Enter the table names separated by a comma.

      smtp.oauth2.tenantid

      Enter Tenant ID for OAuth Token Validation and SMTP Server Authentication.

      Parameters: 

      By default, this setting is Empty.

      Enter a tenant ID in the field provided to validate an OAuth token and set up SMTP Server Authentication.

      smtp.oauth2.clientid

      Enter Client ID for OAuth Token Validation and SMTP Server Authentication.

      Parameter: 

      By default, this setting is Empty.

      Enter a Client ID in the field provided to validate an OAuth token and set up SMTP Server Authentication.

      smtp.oauth2.clientsecret

      Enter Client Secret for OAuth Token Validation and SMTP Server Authentication.

      Parameter: 

      By default, this setting is Empty. 

      Enter a Client Secret in the field provided to validate an OAuth token and set up SMTP Server Authentication.

      smtp.oauth2.cloud.name

      Enter Cloud Name for OAuth Token Validation and SMTP Server Authentication.

      Parameter: 

      By default, this setting is Empty. 

      Enter a Cloud Name in the field provided to validate an OAuth token and set up SMTP Server Authentication.

      Copyright © 2024, OvalEdge LLC, Peachtree Corners, GA USA