Upgrading and migrating from synchronized to shared persistence

You can upgrade and migrate from synchronized persistence to shared persistence if the existing deployment is running Qlik Sense version 3.1 SR2 or later. For more information about persistence models, see Persistence.

The files that are persisted in a Qlik Sense deployment must be available to all nodes via the file share. They can be stored on any of the nodes in the cluster, or on another server. If you are migrating from a synchronized persistence deployment to a shared persistence deployment, you must first create the file share to use as shared storage, and copy your data from the synchronized persistence deployment into the file share folders. For instructions on how to create a file share, see Creating a file share.

Before you upgrade Qlik Sense, do the following:

Backing up a synchronized persistence site

Proceed as follows to backup a Qlik Sense site deployed with the synchronized persistence model:

  1. Make a backup of the certificates used to secure the Qlik Sense services. This only needs to be done once.
  2. Backing up certificates

  3. Stop all Qlik Sense services except the Qlik Sense Repository Database (QRD).
  4. Make a backup of the repository database.
    1. Open a Command Prompt with administrator privileges in Microsoft Windows.

    2. Produce a dumpfile for the repository database (that is, a single file for the entire database):
      1. Navigate to the installation location.

        %ProgramFiles%\Qlik\Sense\Repository\PostgreSQL\<database version>\bin

      2. pg_dump.exe -h localhost -p 4432 -U postgres -b -F t -f "c:\QSR_backup.tar" QSR
      3. If you are prompted for the PostgreSQL super user password, enter the password that was given during the installation of Qlik Sense.

        To avoid being prompted for the password (for example, if you want to automate the Qlik Sense backup process), you can use the pgpass functionality in PostgreSQL. See the PostgreSQL documentation for more information.
    3. Make a backup of the dumpfile for the repository database.
  5. Make a backup of log and application data in the following folders:
    • %ProgramData%\Qlik\Sense\Log
    • %ProgramData%\Qlik\Sense\Apps
    • %ProgramData%\Qlik\Sense\Repository\Content
    • %ProgramData%\Qlik\Sense\Repository\Extensions
    • %ProgramData%\Qlik\Sense\Repository\AppContent (if available)
  6. Make a backup of any locations where content that supports the Qlik Sense environment may be kept (for example, QVD files created by load scripts).
  7. Start the Qlik Sense services. If the services are started manually, start them in the following order:
    1. Qlik Sense Repository Service (QRS)

      If the user running Qlik Sense services is not local administrator on the machine, you need to start Repository.exe from an elevated command prompt using the -bootstrap parameter.

      Services

    2. Qlik Sense Proxy Service (QPS), Qlik Sense Engine Service (QES), Qlik Sense Scheduler Service (QSS), and Qlik Sense Printing Service (QPR) in no specific order

    The order is important because the QRS is dependent on the QRD and the rest of the services are dependent on the QRS.

Upgrading to a shared persistence deployment

Do the following:

  1. Create a file share, see Creating a file share.
  2. Create the following sub-folders in the file share:

    • Apps
    • ArchivedLogs
    • CustomData
    • StaticContent
  3. Copy following content from your synchronized persistence deployment to the file share:

    Content Copy from To subfolder
    Apps ..\ProgramData\Qlik\Sense\Apps Apps
    Logs (optional) ..\ProgramData\Qlik\Sense\Repository\Archived Logs ArchivedLogs
    Static content

    ..\ProgramData\Qlik\Sense\Repository\AppContent

    ..\ProgramData\Qlik\Sense\Repository\Content

    ..\ProgramData\Qlik\Sense\Repository\DefaultContent

    ..\ProgramData\Qlik\Sense\Repository\Extensions

    ..\ProgramData\Qlik\Sense\Repository\DefaultApps

    Each of these folders must be added as a sub-folder of the StaticContent folder.
    StaticContent
  4. Ensure that all Qlik Sense nodes are synchronized, and take all nodes offline by stopping the Qlik Sense services in Windows.
  5. Upgrade your central node by launching the Qlik Sense setup file (Qlik_Sense_setup.exe).
  6. Accept the license agreement and click Next.
  7. On the Shared persistence storage page, enter the path or URL to your file share folders that you prepared and click Next.
  8. On the Database service listener page, if you have a multi-node deployment, enter the following:
    • Listen addresses - add the addresses that the database service should listen to.

      You can enter a comma separated list of IPv4 or IPv6 addresses, or 0.0.0.0 (for all IPv4 addresses), ::/0 (for all IPv6 addresses) or * (for all addresses).

    • IP ranges - add a subnet specification that covers the IP addresses of all nodes in your site.

      Either add one row for each node, using /32 as suffix for each address, or add a subnet that covers all addresses using, for example, /24 as suffix. To allow all servers to access the repository database, use 0.0.0.0/0. You can also enter a comma separated list of multiple IP addresses.

    • Max connections - specify the maximum number of concurrent connections to the database. The default value is 100 multiplied by the number of nodes in the cluster (this field is only available in Qlik Sense February 2018, and later).
  9. On the Service Credentials page, enter the Username , and Password for your WindowsQlik Sense service user account.

    If the user is member of a domain, enter the service account as <domain>\<username>. See: User accounts.

  10. On the Repository Database Superuser Password page, enter the password for your repository database superuser. See: User accounts.
    If you cannot find the password, see the troubleshooting topic:Cannot find the repository database superuser password
  11. On the Ready to upgrade page, select the appropriate check boxes if you want the setup to create desktop shortcuts and automatically start the Qlik Sense services when the setup is complete, and click Upgrade.
  12. Check that all of the Qlik Sense services have started successfully.
  13. Check that all apps have been migrated successfully on the central node. If migration has failed for one or more apps, resolve the issues before continuing.

    If the node running the app migration goes offline, migration will stop. It will not restart automatically. In a single node environment, all apps will have Migration status set to Unknown. See: Migrating apps. In a multi-node environment with failover nodes, the primary node will be replaced by the next available node, but migration will not restart. See: Failover. To resume migration, you will need to restart the following services, in order: Qlik Sense Service Dispatcher (QSD) and Qlik Sense Repository Service (QRS). See: Services.
  14. In a multi-node deployment, uninstall Qlik Sense on each of the rim nodes. Select the option to remove certificates and data folders when you uninstall on the rim nodes.

  15. Install Qlik Sense with shared persistence on the remaining nodes, and join the existing cluster created when you upgraded the central node.

    Installing Qlik Sense in a multi-node site

Did this information help you?

Can you tell us why it did not help you and how we can improve it?

Thanks for helping us improve!