Prepare your environment for upgrade

If your environment has repo clusters, you need to prepare it before upgrading to CPSH.

Prerequisites

  • You have downloaded the Collibra Platform Self-Hosted installer on all nodes of your environment.
  • The status of your repository is green or orange. If the status of the repository is Red, do not start the upgrade procedure but contact Collibra Support.

Steps

  1. Open Collibra Console with a user profile that has at least the ADMIN role.

    Collibra Console opens with the Infrastructure page.

    1. In the main menu, click Console Export Files.

      The Console Export Files page appears.

    2. In the upper right corner, click Create Console Export File.

      Note If you have one or more Edge sites in this Collibra environment, you need to create a backup for each Edge site.

    3. Enter the required information.
      OptionDescription
      EnvironmentThe Collibra environment for which to create an export file.
      Include

      You can create a full export file by selecting all of the options or a partial file by excluding some of the options.

       Data

      The core database data of the Collibra environment. This encompasses all data related to communities, domains, assets, users, operating model, and similar objects.

       History

      Data activity and snapshot-related information. This can result in a very large file, depending on the activity in Collibra.

      If you exclude the data history when creating an export file, you export a subset of the database content. This results in a much smaller file that still provides a complete picture of the current content. This is useful when attaching a backup to a technical support ticket, allowing support to reproduce a problem.

      Warning If you apply an export file from a 5.7.x version or older without history, the data quality metrics do not work correctly. To resolve this issue, apply the file in your latest environment, upgrade the data, create a new export file, and apply the new file in the same environment.

       Configuration
      		The Data Governance Center service configuration options.

      Note The configuration is always included in export files for consistency and reliability.

       Customizations

      Customization files such as custom modules, styling, page definitions, and email templates.

      This includes files that are located in the Collibra user home directory and files that are used to customize the Collibra environment (/opt/collibra_data/console/config), such as the ones in:

      • email-templates
      • groovy-lib
      • images
      • page-definitions
      • security
      • styling
      • translations
      • modules (if available)
      Name

      The name of the file. You can only use the following characters in the export file name:

      • Letters
      • Numbers
      • Hyphen -
      • Underscore _
      • Period .
      DescriptionThe description of the export file.
      Retain for

      The retention period for the export file, after which the file is automatically removed:

      • 7 days (default)
      • 30 days
      • 60 days
    4. Click Create Export File.
      A dialog box with a progress bar is displayed. You can let the export continue in the background.
  3. On the Infrastructure page, click the environment that you want to stop.
  4. Click Stop.
    The Stop environment dialog box appears.
  5. Click Stop environment.
    All services in the environment are stopped.
  6. When all services are stopped, delete all secondary [replica] repo services from the repository cluster.
  7. Start all repo services that were used as replica.
  8. Stop all repo services again.

What's next

You can now upgrade your environment to CPSH.