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 Backups.
      The backups page appears.
    2. In the upper right corner, click Create backup.

      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 Data Intelligence Platform environment that you want to back up.
      Include

      You can create:

      • a full backup: Includes all backup options.
      • a partial backup: Includes only a couple of the backup options.
       Data

      The core (database) data contained in the Collibra environment. This is all the data related to communities, domains, assets, users, operating model and so on.

       History

      The history of the data (activity and snapshot-related). This can result in a very large file, depending on the activity in Collibra.

      If you create a backup of the data and exclude the data history, you are taking a backup of a subset of the database content. This results in a much smaller backup file, but it still contains a complete picture of the current content. This is useful when attaching a backup to a technical support ticket, if support has to reproduce a problem.

      Warning If you restore a backup that does not include history and was made from a version older than 5.7.x, the data quality metrics will not work correctly. To solve this issue, after you restore the backup in your latest environment, upgrade the data, create a new backup and restore the new backup in the same environment.

       Configuration

      The configuration of the Collibra environment.

       Customizations

      The customizations such as custom modules, styling, page-definitions and email template files.

      This will add 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). This concerns all the files located in the following directories:

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

      Name

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

      • letters
      • numbers
      • hyphen ( - )
      • underscore ( _ )
      • period ( . )
      DescriptionThe description to provide more information on the backup.
    4. Click Create backup.
      A dialog box with a progress bar is displayed. You can let the backup 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.