Upgrade 5.6.5 or newer to 5.9.2

In this section, we describe the upgrade procedure of a an on-premises Collibra Data Governance Center 5.6.5 or newer environment to 5.9.2 by overwriting the current version with the 5.9.2 version.

To see the upgrade procedure by video, click here.

Important

If your environment is configured with repository clusters, do not follow the steps in this section but follow this procedure instead.
If your environment is FIPS enabled (Federal Information Processing Standards), then you have to upgrade first to 5.7.13 and then upgrade to 5.9.1.

Diagram of upgrade path by installing 5.9 over an existing environment

Note You must upgrade with the same user account that was used for the installation, both on Linux and Windows. If the user account is no longer active, see Upgrade an environment with another user account in the Troubleshooting section.

Prerequisites

You have enough free disk space in the volume that hosts the data folder, collibra_data. The free disk space must be at least the size of the current data.
For example, if your data in the data folder takes 5 GB, you need at least 5 GB of free disk space on that volume to upgrade.
Stop the environment and the agent and Console services.
If your environment is hosted on Linux nodes, you have installed PostgreSQL 14.9.

The node that will run the Search service, must pass the following bootstrap checks:

Type	Check description	Minimum value	Applies for installation type	Setting name
User limit	Maximum number of open file descriptors	65536	Without root permissions With root permissions, using System V init daemon	nofile
	Maximum number of open threads/processes	4096		nproc
	Maximum file size	unlimited		fsize
Kernel parameter	Maximum virtual memory areas	262144	All	vm.max_map_count

For more information on these settings, see the Settings section.

The status of your repository is Green or Orange.
Warning If the status of the repository is Red, do not start the upgrade procedure but contact Collibra Support.

Steps

Linux
Windows

Stop the environment:
2. Open Collibra Console with a user profile that has at least the ADMIN role.
  Collibra Console opens with the Infrastructure page.
3. Click the environment that you want to stop.
4. Click Stop.
  The Stop environment dialog box appears.
5. Click Stop environment.
6. Wait until all the nodes of the environment show Stopped.
7. Stop Collibra Console and the Collibra DGC Agent. In the terminal of the node that runs Collibra Console:
  1. As root:
```
service collibra-agent stop
service collibra-console stop
```
  2. Manual stop of the services:
```
/opt/collibra/console/bin/console stop
/opt/collibra/agent/bin/agent stop
```
Install PostgreSQL 14.9:
Tip If the server on which you want to install PostgreSQL 14.9 does not have Internet access, follow the instructions in this article.
- RHEL/CentOS/Rocky Linux 9
- Debian/Ubuntu
- Suse Linux Enterprise
1. Install PostgreSQL 14.9 with the following commands.
  Important Run the commands as root.
```
#Clean the YUM cache and update existing packages for your current Linux repository. Note that this makes system changes.
 
yum clean all && yum update -y

#Prepare the PostgreSQL repository and packages:
yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-$(rpm -E %{rhel})-x86_64/pgdg-redhat-repo-latest.noarch.rpm

#Update the packages in the repository:
yum -y update

#Install the PostgreSQL 14.9 packages:
yum -y install postgresql14 postgresql14-server postgresql14-contrib
```
2. Update the file /usr/lib/tmpfiles.d/postgresql-14.conf to set the correct permissions for some PostgreSQL folders. Open the file for editing, for example with vim or nano and update the line d /run/postgresql 0755 postgres postgres - to:
```
d /run/postgresql 2777 postgres postgres - -
```
  Important Do not use the chmod command on any directories or files, edit this configuration file instead.
3. If you are upgrading from version 5.8.x to 5.9, you also have to update the configuration file of PostgreSQL 11 (/usr/lib/tmpfiles.d/postgresql-11.conf) as described in the previous step.
4. Reboot the server.
Tip The default PostgreSQL 14 path on RHEL/Rocky/CentOS is /usr/pgsql-14.
1. Install PostgreSQL 14.9 with the following commands:
  Important Run the commands as root.
```
sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -

apt-get update && apt-get upgrade -y

apt-get install -y postgresql-14
```
2. Update the file /usr/lib/tmpfiles.d/postgresql-common.conf to set the correct permissions for some PostgreSQL folders. Open the file for editing, for example with vim or nano and update the line d /run/postgresql 1775 postgres postgres - to:
```
d /run/postgresql 2777 postgres postgres - -
```
3. Reboot the server.
Tip The default PostgreSQL 14 path on Debian/Ubuntu is /usr/lib/postgresql/14.
1. Install PostgreSQL 14.9 with the following commands:
  Important Run the commands as root. In the first of the following commands, the packages are for Suse 15, replace "15" by your used major version, for example 12. You can check your Suse version with the command: cat /etc/os-release.
```
zypper addrepo https://download.postgresql.org/pub/repos/zypp/repo/pgdg-sles-15-pg14.repo

zypper refresh

zypper install postgresql14 postgresql14-server postgresql14-contrib
```
2. Update the file /usr/lib/tmpfiles.d/postgresql-14.conf to set the correct permissions for some PostgreSQL folders. Open the file for editing, for example with vim or nano and update the line d /run/postgresql 0755 postgres postgres - to:
```
d /run/postgresql 2777 postgres postgres - -
```
3. If you are upgrading from version 5.8.x to 5.9, you also have to update the configuration file of PostgreSQL 11 (/usr/lib/tmpfiles.d/postgresql-11.conf) as described in the previous step.
4. Reboot the server.
Tip The default PostgreSQL 14 path on Suse is /usr/lib/pgsql-14.
If you don't update the PostgreSQL configuration file, you get an error that a test file could not be written.

Start the installer and follow the instructions.

Note

The path to your PostgreSQL 14.9 installation differs per Linux operating system. In the following example, the path is of a default installation on CentOS 7.
The amount of time it takes to upgrade your environment depends on the size of your repository. The larger the database, the more time it takes to upgrade.

# ./dgc-linux-5.9.2-2.sh 
Verifying archive integrity...  100%   All good.
Uncompressing DGC Installer  100%  
Specify the installation directory [/opt/collibra]:

/opt/collibra contains a previous installation. Do you want to perform an update? [y/N]
y
Before you can schedule an upgrade, you need to:
 - Create a backup of the entire environment.
 - In Collibra Console, stop all running services on this node.
Have you completed these steps? [yes,NO]

yes
Specify the postgresql 11 path [/usr/pgsql-11]:

2022-09-16 10:32:51.581 - SUCCESS - Check umask settings
2022-09-16 10:32:51.592 - SUCCESS - Create installation and data directories
2022-09-16 10:32:51.597 - SUCCESS - Check Search system requirements
2022-09-16 10:32:52.030 - SUCCESS - Remove Agent system service
2022-09-16 10:32:52.280 - SUCCESS - Remove Console system service
2022-09-16 10:32:54.773 - SUCCESS - Extract JRE
2022-09-16 10:32:54.893 - SUCCESS - Copy server files
2022-09-16 10:32:54.894 - SUCCESS - Create PostgreSQL temporary directories
2022-09-16 10:32:54.896 - SUCCESS - Move old postgresql files to temporary directory
2022-09-16 10:32:54.897 - SUCCESS - Install PostgreSQL configuration files to temporary directory
2022-09-16 10:33:12.658 - SUCCESS - Update postgresql
2022-09-16 10:33:12.706 - SUCCESS - Update postgresql path in configuration files
2022-09-16 10:33:12.711 - SUCCESS - Remove tracing directories
2022-09-16 10:33:12.790 - SUCCESS - Prepare for jobserver update
2022-09-16 10:33:12.790 - SUCCESS - Create spark directories
2022-09-16 10:33:14.324 - SUCCESS - Extract Spark
2022-09-16 10:33:14.333 - SUCCESS - Replace variables in spark files
2022-09-16 10:33:14.342 - SUCCESS - Set permissions on Spark directory

...

2022-09-16 10:33:36.422 - SUCCESS - Create installation configuration file
2022-09-16 10:33:36.468 - SUCCESS - Create uninstall script
2022-09-16 10:33:36.473 - SUCCESS - Cleanup temporary directories
2022-09-16 10:33:36.474 - SUCCESS - Cleanup old Postgres binaries
2022-09-16 10:33:36.679 - SUCCESS - Make sure all permissions are correct
2022-09-16 10:33:37.089 - SUCCESS - Install Agent system service
2022-09-16 10:33:37.312 - SUCCESS - Install Console system service
2022-09-16 10:33:41.431 - SUCCESS - Start Agent
2022-09-16 10:33:45.620 - SUCCESS - Start Console
2022-09-16 10:33:45.620 - COMPLETED - Installation finished in 54352ms.

Start Collibra Console and the Collibra DGC Agent. In the terminal of the node that runs Collibra Console:
1. As root:
```
service collibra-agent start
service collibra-console start
```
2. Manual start of the services:
```
/opt/collibra/console/bin/console start
/opt/collibra/agent/bin/agent start
```
Start the environment:
1. Open Collibra Console with a user profile that has at least the ADMIN role.
  Collibra Console opens with the Infrastructure page.
2. Click the name of an environment to show its details.
3. Click Start.
The start of the environment will be interrupted and your environment will be partially running.
Click the orange Upgrade button to continue the upgrade.
In the Upgrade dialog box, click Upgrade.
Your environment is being upgraded. When all services are up and running again, the upgrade process has completed.
Tip
- In this phase, a backup of the current database will be created. If the creation would take too much time, it will time out and the upgrade will fail. Increase the backup timeout in that case and restart the upgrade.
- If the environment ends up in Error state, it is most likely because starting the Collibra service takes too much time. See Environment in error state after during the upgrade.
- If your environment is configured with SAML and it is no longer functional after the upgrade, consult the troubleshooting section.

Stop the environment.
2. Open Collibra Console with a user profile that has at least the ADMIN role.
  Collibra Console opens with the Infrastructure page.
3. Click the environment that you want to stop.
4. Click Stop.
  The Stop environment dialog box appears.
5. Click Stop environment.
6. Wait until all the nodes of the environment show Stopped.
7. Stop Collibra Console and the Collibra DGC Agent via the Windows services window. The services to be stopped are Agent and Management Console.
Double-click setup.bat of the 5.9.2 installer.
Note The Windows installer includes PostgreSQL 14.9 and will automatically upgrade the database.
Click Next.
Select the installation directory of the old version and click Update.
Note If you select a different installation directory, you will add a new Collibra DGC installation next to the existing installation.
Click Yes to confirm that you have created a backup and that all the services are stopped on the node.
The Component selection dialog box appears, indicating which services are installed on the node.
Select the services that you want to add to the node and click Next.
If you have selected new services in the previous step, you have to configure the services in the next dialog boxes. After the last configuration dialog box, click Update.
The installed services on the node are upgraded and newly selected services are installed.
Click Exit.
Note
- If you have a multinode installation, repeat the previous steps for every node of the environment until you have upgraded all nodes.
- Make sure that you have installed the Search and Monitoring services on one of the nodes.
Start Collibra Console via the Windows services window.
Start the environment:
1. Open Collibra Console with a user profile that has at least the ADMIN role.
  Collibra Console opens with the Infrastructure page.
2. Click the name of an environment to show its details.
3. Click Start.
The start of the environment will be interrupted and your environment will be partially running.
Click the orange Upgrade button to continue the upgrade.
In the Upgrade dialog box, click Upgrade.
Your environment is being upgraded. When all services are up and running again, the upgrade process has completed.
Tip
- In this phase, a backup of the current database will be created. If the creation would take too much time, it will time out and the upgrade will fail. Increase the backup timeout in that case and restart the upgrade.
- If the environment ends up in Error state, it is most likely because starting the Collibra service takes too much time. See Environment in error state after during the upgrade.
- If your environment is configured with SAML and it is no longer functional after the upgrade, consult the troubleshooting section.
Reindex Collibra.
Optionally, upgrade the activity history.