# Upgrading from Omnisci to HEAVY.AI 6.0

This section is giving a recipe to upgrade from Omnisci platform 5.5+ to HEAVY.AI 6.0.

<Warning>
  If the version of **Omnisci is older than 5.5** an intermediate upgrade step to the 5.5 version is needed.\
  Check the docs on how to do the [upgrade](https://docs.heavy.ai/v/v5.5.6/installation-and-configuration/installation/upgrading-omnisci).
</Warning>

## Considerations when Upgrading from Omnisci  to HEAVY.AI Platform

If you are upgrading from Omnisci to HEAVY.AI, there are a lot of additional steps compared to a simple sub-version upgrade.

### Before Upgrading to Release 6.0

<Warning>
  **IMPORTANT -  Before you begin, stop all the running services / docker images** of your Omnisci installation and **create a backup \$OMNISCI\_STORAGE folder** (typically /var/lib/omnisci). \
  \
  A backup is essential for recoverability; **do not proceed with the upgrade without confirming that a full and consistent backup is available and ready to be restored.**
</Warning>

The `omnisci` the database will not be automatically renamed to the new default name `heavyai`.This will be done manually and it's documented in the upgrade steps.

<Warning>
  All the dumps created with the dump command on Omnisci cannot be restored after the database is upgraded to this version.
</Warning>

### Essential Changes for release 6.0 of HEAVY.AI compared to Omnisci

The following table describes the changes to environment variables, storage locations, and filenames in Release 6.0 compared to Release 5.x. Except where noted, revised storage subfolders, symlinks for old folder names, and filenames are created automatically on server start.

Change descriptions in **bold** require user intervention.

<table>
  <thead><tr><th width="267.2970379172567">Description</th><th width="254">Omnisci 5.x</th><th width="296">HEAVY.AI 6.0</th><th data-hidden /></tr></thead>

  <tbody><tr><td>Environmental variable for storage location</td><td>$OMNISCI_STORAGE</td><td>$HEAVYAI_BASE</td><td /></tr><tr><td><strong>Default location for $HEAVYAI_BASE / $OMNISCI_STORAGE</strong></td><td>/var/lib/omnisci</td><td>/var/lib/heavyai</td><td /></tr><tr><td>Fixed location for Docker $HEAVYAI_BASE / $OMNISCI_STORAGE  </td><td>/omnisci-storage</td><td>/var/lib/heavyai</td><td /></tr><tr><td><strong>The folder containing catalogs for $HEAVYAI_BASE / $OMNISCI_STORAGE</strong></td><td>data/</td><td>storage/</td><td /></tr><tr><td>Storage subfolder - data</td><td>data/mapd_data</td><td>storage/data</td><td /></tr><tr><td>Storage subfolder - catalog</td><td>data/mapd_catalogs</td><td>storage/catalogs</td><td /></tr><tr><td>Storage subfolder - import</td><td>data/mapd_import</td><td>storage/import</td><td /></tr><tr><td>Storage subfolder - export</td><td>data/mapd_export</td><td>storage/export</td><td /></tr><tr><td>Storage subfolder - logs</td><td>data/mapd_log</td><td>storage/log</td><td /></tr><tr><td>Server INFO logs</td><td>omnisci_server.INFO</td><td>heavydb.INFO</td><td /></tr><tr><td>Server ERROR logs</td><td>omnisci_server.ERROR</td><td>heavydb.ERROR</td><td /></tr><tr><td>Server WARNING logs</td><td>omnisci_server.WARNING</td><td>heavydb.WARNING</td><td /></tr><tr><td>Web Server ACCESS logs</td><td>omnisci_web_server.ACCESS</td><td>heavy_web_server.ACCESS</td><td /></tr><tr><td>Web Server ALL logs</td><td>omnisci_web_server.ALL</td><td>heavy_web_server.ALL</td><td /></tr><tr><td>Install directory</td><td>/omnisci (Docker) <br />/opt/omnisci (bare metal)</td><td>/opt/heavyai/ <br />(Docker and bare metal)</td><td /></tr><tr><td>Binary file - core server (located in install directory)</td><td>bin/omnsici_server</td><td>bin/heavydb</td><td /></tr><tr><td>Binary file - web server (located in install directory)</td><td>bin/omnisci_web_server</td><td>bin/heavy_web_server</td><td /></tr><tr><td>Binary file - command- line SQL utility</td><td>bin/omnisql</td><td>bin/heavysql</td><td /></tr><tr><td>Binary file - JDBC jar</td><td>bin/omnisci-jdbc-5.10.2-SNAPSHOT.jar</td><td>bin/heavydb-jdbc-6.0.0-SNAPSHOT.jar</td><td /></tr><tr><td>Binary file - Utilities (SqlImporter) jar</td><td>bin/omnisci-utility-5.10.2-SNAPSHOT.jar</td><td>bin/heavydb-utility-6.0.0-SNAPSHOT.jar</td><td /></tr><tr><td>HEAVY.AI Server service (for bare metal install)</td><td>omnisci_server</td><td>heavydb</td><td /></tr><tr><td>HEAVY.AI Web Server service (for bare metal install)</td><td>omnisci_web_server</td><td>heavy_web_server</td><td /></tr><tr><td><strong>Default configuration file</strong></td><td>omnisci.conf</td><td>heavy.conf</td><td /></tr></tbody>
</table>

## Upgrade Instructions

<Warning>
  The order of these instructions is significant. To avoid problems, follow the order of the instruction provided and don't skip any step.
</Warning>

### Assumptions

This upgrade procedure is assuming that you are using the default storage location for both Omnisci and HEAVY.AI.

| **\$OMNISCI\_STORAGE** | **\$HEAVYAI\_BASE** |
| ---------------------- | ------------------- |
| /var/lib/omnisci       | /var/lib/heavyai    |

### Upgrading Using Docker

Stop all containers running Omnisci services.

In a terminal window, get the Docker container IDs:

```bash
sudo docker container ps --format "{{.Id}} {{.Image}}" \
-f status=running | grep omnisci\/
```

You should see an output similar to the following. The first entry is the container ID. In this example, it is `9e01e520c30c`:

```bash
9e01e520c30c omnisci/omnisci-ee-gpu
```

Stop the HEAVY.AI Docker container. For example:

```bash
sudo docker container stop 9e01e520c3
```

Backup the Omnisci data directory (typically `/var/lib/omnisci`).

```bash
tar zxvf /backup_dir/omnisci_storage_backup.tar.gz /var/lib/omnisci
```

Rename the Omnisci data directory to reflect the HEAVY.AI naming scheme.

```bash
sudo mv /var/lib/omnisci /var/lib/heavyai
sudo mv /var/lib/heavyai/data /var/lib/heavyai/storage
```

Create a new configuration file for heavydb changing the data parameter to point to the renamed data directory.

```bash
cat /var/lib/heavyai/omnisci.conf | \
sed "s/^\(data.*=.*\)/#\1\\ndata = \"\/var\/lib\/heavyai\/storage\"/" | \
sed "s/^\(frontend.*=.*\)/#\1\\nfrontend = \"\/opt\/heavyai\/frontend\"/" 
>/var/lib/heavyai/heavy.conf
```

Rename the Omnisci license file **(EE and FREE only)**.

```bash
mv /var/lib/heavyai/storage/omnisci.license \
/var/lib/heavyai/storage/heavyai.license
```

Download and run the 6.0 version of the HEAVY.AI Docker image.

Select the tab depending on the Edition (**Enterprise**, **Free**, or **Open Source**) and execution Device (**GPU** or **CPU**) you are upgrading.

<Tabs>
  <Tab title="EE GPU">
    ```bash
    sudo docker run -d --gpus=all \
    -v /var/lib/heavyai:/var/lib/heavyai \
    -p 6273-6278:6273-6278 \
    heavyai/heavyai-ee-cuda:v6.0.0
    ```
  </Tab>

  <Tab title="EE CPU">
    ```bash
    sudo docker run -d \
    -v /var/lib/heavyai:/var/lib/heavyai \
    -p 6273-6278:6273-6278 \
    heavyai/heavyai-ee-cpu:v6.0.0
    ```
  </Tab>

  <Tab title="OS GPU">
    ```bash
    sudo docker run -d --gpus=all \
    -v /var/lib/heavyai:/var/lib/heavyai \
    -p 6273-6278:6273-6278 \
    heavyai/core-os-cuda:v6.0.0
    ```
  </Tab>

  <Tab title="OS CPU">
    ```bash
    sudo docker run -d \
    -v /var/lib/heavyai:/var/lib/heavyai \
    -p 6273-6278:6273-6278 \
    heavyai/core-os-cpu:v6.0.0
    ```
  </Tab>
</Tabs>

Check that Docker is up and running using a `docker ps` command:

```bash
sudo docker container ps --format "{{.Id}} {{.Image}} {{.Status}}" \
-f status=running | grep heavyai\/
```

You should see output similar to the following:

```bash
9e01e520c30c heavyai/heavyai-ee-cuda Up 48 seconds ago 
```

Using the new container ID rename the default `omnisci` database to `heavyai`:

```bash
sudo docker exec -it 9e01e520c30c \
echo "alter database omnisci rename to heavyai;" \
| bin/heavysql omnisci 
```

Check that everything is running as expected.

## Upgrading to HEAVY.AI Using Package Managers or Tarball

To upgrade an existing system installed with package managers or tarball. \
The commands upgrade HEAVY.AI in place without disturbing your configuration or stored data.

### Back up the Omnisci Database

Stop the Omnisci services.

```bash
sudo systemctl stop omnisci_web_server omnisci_server
```

Backup the Omnisci data directory (typically `/var/lib/omnisci`).

```bash
tar zcvf /backup_dir/omnisci_storage_backup.tar.gz /var/lib/omnisci
```

Create a user named `heavyai` who will be the owner of the HEAVY.AI software and data on the filesystem.

<Tabs>
  <Tab title="Centos/RHEL">
    ```bash
    sudo useradd --shell /bin/bash --user-group --create-home --group wheel heavyai
    ```
  </Tab>

  <Tab title="Ubuntu">
    ```bash
    sudo useradd --shell /bin/bash --user-group --create-home --group sudo heavyai
    ```
  </Tab>
</Tabs>

Set a password for the user. It'll need when sudo-ing.

```bash
sudo passwd heavyai
```

Login with the newly created user

```bash
sudo su - heavyai
```

Rename the Omnisci data directory to reflect the HEAVY.AI naming scheme and change the ownership to heavyai user.

```bash
sudo chown -R heavyai:heavyai /var/lib/omnisci
```

```bash
sudo mv /var/lib/omnisci /var/lib/heavyai
```

```bash
mv /var/lib/heavyai/data /var/lib/heavyai/storage
```

Create the "**semaphore**" catalog directory; we'll have to remove it later "

```bash
mkdir /var/lib/heavyai/storage/catalogs
```

Check that everything is in order and that the "semaphore" directory is created,

```bash
ls -la /var/lib/heavyai/storage/
```

All the directories must belong to the heavyai user, and the directory **`catalogs`** would be present

```bash
total 32
drwxr-xr-x  8 heavyai heavyai 4096 lug 15 16:03 .
drwxr-xr-x  4 heavyai heavyai 4096 lug 15 16:02 ..
drwxrwxr-x  2 heavyai heavyai 4096 lug 15 16:03 catalogs
drwxr-xr-x  2 heavyai heavyai 4096 lug 15 15:54 mapd_catalogs
drwxr-xr-x 52 heavyai heavyai 4096 lug 15 15:54 mapd_data
drwxr-xr-x  2 heavyai heavyai 4096 lug 15 15:54 mapd_export
drwxr-xr-x  2 heavyai heavyai 4096 lug 15 15:54 mapd_log
drwxr-xr-x  2 heavyai heavyai 4096 lug 15 15:54 omnisci_disk_cache
-rw-r--r--  1 heavyai heavyai 1229 lug 15 16:07 omnisci-licence
```

Rename the license file. **(EE and FREE only)**

```bash
mv /var/lib/heavyai/storage/omnisci.license \
/var/lib/heavyai/storage/heavyai.license
```

### Install the HEAVY.AI Software

Install the HEAVY.AI software following all the instructions for your Operative System.\
[CentOS/RHEL](/installation-and-configuration/installation/installing-on-rocky-linux-rhel/heavy.ai-installation-on-rhel) and [Ubuntu](/installation-and-configuration/installation/installing-on-ubuntu/centos-yum-gpu-ee#create-the-heavy.ai-user).

<Warning>
  Please follow all the installation and configuration steps until the Initialization step.
</Warning>

### Update the configuration file and rename the default database

Log in with the heavyai user and ensure the heavyai services are stopped.

```bash
sudo systemctl stop heavy_web_server heavydb
```

Create a new configuration file for heavydb, changing the `data` parameter to point to the `/var/lib/heavyai/storage` directory and the `frontend` to the new install directory.

```bash
cat /var/lib/heavyai/omnisci.conf | \
sed "s/^\(data.*=.*\)/#\1\\ndata = \"\/var\/lib\/heavyai\/storage\"/" | \
sed "s/^\(frontend.*=.*\)/#\1\\nfrontend = \"\/opt\/heavyai\/frontend\"/" \
>/var/lib/heavyai/heavy.conf
```

All the settings of the upgraded database will be moved to the new configuration file.

Now we have to complete the database migration.

Remove the "**semaphore**" directory we previously created. (**this is a fundamental step needed for the omnsci to heavydb upgrade**)

```bash
rmdir /var/lib/heavyai/storage/catalogs
```

To complete the upgrade, start the HEAVY.AI servers.

```bash
sudo systemctl start heavydb heavy_web_server
```

Check if the database migrated, running this command and checking for the `Rebrand migration complete` message.

```bash
sudo systemctl status heavydb
```

![](https://files.buildwithfern.com/heavyai.docs.buildwithfern.com/heavyai/86cf7473df6e5f22a0cc6c5c68c81c3e32724a8750f1ae1f95efed4b538d0eb1/docs/assets/image-11.png)

Rename the default `omnisci` database to `heavyai.`\
Run the command using an administrative user (typically `admin`) with his password (default  HyperInteractive)

```bash
echo "alter database omnisci rename to heavyai;" \
| /opt/heavyai/bin/heavysql -p HyperInteractive -u admin omnisci 
```

Restart the database service and check that everything is running as expected.

### Remove Omnisci Software from the System

After all the checks confirmed that the upgraded system is stable, clean up the system to remove the Omnisci install and relative system configuration.\
\
Remove permanently the configuration of the services.

```bash
sudo rm /lib/systemd/omnisci_server*.service
sudo rm /lib/systemd/omnisci_web_server*.service
sudo systemctl daemon-reload
sudo systemctl reset-failed
```

Remove the installed software.

```bash
sudo rm -Rf /opt/omnisci
```

Delete the YUM or APT repositories.

<Tabs>
  <Tab title="YUM">
    ```bash
    sudo rm /etc/yum.repos.d/omnisci.repo
    ```
  </Tab>

  <Tab title="APT">
    ```bash
    sudo rm /etc/apt/sources.list.d/omnisci.list
    ```
  </Tab>
</Tabs>