Prepare Funnelback for upgrade

This feature is not available to users of the Squiz Experience Cloud version of Funnelback.

Before Funnelback can be upgraded it needs to be placed in a clean state to allow the upgrade to commence smoothly.

This is usually performed by logging in to the administration interface, but it can also be triggered via the admin API.

Prepare for upgrade

Funnelback administration interface

Log in to the Funnelback administration interface, and select prepare Funnelback for upgrade from the system menu.

Click run.

Admin API

Access to the administration interface is not always possible when working on a Funnelback installation.

The following can be used to prepare Funnelback for upgrade without access to the administration interface.

Call to the push-api directly via HTTP

This is the preferred way to prepare for an upgrade if you don’t have access to the administration interface (via a web browser). There are two API calls that can be used when preparing Funnelback for upgrade.

The following API call checks to see if the Funnelback has been prepared for upgrade:

POST /push-api/v1/upgrade/prepare/status

This API call will return a 503 response code if the upgrade task has not been started.

The following API call is used to prepare Funnelback for upgrade:

POST /push-api/v1/upgrade/prepare

An interface to access these calls directly is available within Funnelback’s UI (https://<host name>:<admin port>/search/admin/api-ui/) under the Push API tab in the push-api-collection section.

The API can also be called by accessing the API endpoint directly. e.g. use curl to to access the prepare for upgrade API call:

curl -X POST https://funnelback-server:8443/push-api/v1/upgrade/prepare.
Jetty must be running on the server for this call to work.

Once the prepare for upgrade API call completes you can run the installer.

Revert/undo prepare for upgrade

If you need to revert the prepare for upgrade step then this can be done by restarting the Jetty web server.