Documentation

Documentation

  • Getting Started
  • Core Concepts
  • Using Fivetran
  • Usage-Based Pricing
  • Connectors
  • Applications
  • Databases
    • Connection Options
    • Databases Troubleshooting
      • Deleted Column in Destination
      • Test Reverse SSH Tunnel Connection
      • Choose Database Connection Option
      • Redshift Source Connector
      • Add Multiple Public Keys
      • How to Upgrade High-Volume Agent
      • Recreate Your Connector With a Different Table Name
      • Tables Re-syncing Without Being Triggered
      • Authentication failure while connecting via SSH
      • Null Pointer Exception Error
      • Database Naming Conventions
      • Change in TLS Certificate Detected
      • Revalidate TLS Certificate
      • How are Alters Handled in Fivetran
      • Is It Possible To Start Sync From a Certain Date
      • Views Not Being Replicated
      • Communications Link Failure
      • Require TLS through Tunnel
      • Low Log Retention Period
      • Trust TLS Certificate
      • Table Record Size Limitation
      • Source Restored From Backup
      • Remove a Certificate
      • Database Collation
      • Auth Fail Error
      • Connection Attempt Failed Error
      • Connection Attempt Failed Error with SSH Server
      • Unable To Modify Column Selection
      • Unsupported Data Type
    • BigQuery
    • Convex
    • Cosmos DB
    • Db2 for i
    • DocumentDB
    • DynamoDB
    • Elasticsearch
    • Firebase
    • MariaDB
    • MongoDB
    • MySQL
    • OpenSearch
    • Oracle
    • PlanetScale
    • PostgreSQL
    • Redshift
    • SAP ERP
    • Snowflake
    • SQL Server
    • Release Notes
  • Files
  • Events
  • Functions
  • Destinations
  • Partner-Built
  • Transformations
  • Logs
  • Security
  • REST API
  • Local Data Processing (HVR 6)
  • Release Notes
RSS
Release notes RSS
HVR 5 Documentation
HVR 5 Documentation
  • Support
  • Sign In
Edit on GitHub

How to Upgrade High-Volume Agentlink

Updated 13 days ago

Follow the instructions below to upgrade your High-Volume Agent installation.

NOTE: A new version of HVA can be downloaded from your HVA connector's setup form.

Upgrading HVA on Linuxlink

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Linux.

Requirementslink

  • HVA installation file
  • Before upgrading HVA, it is recommended to take a full backup of theHVR_HOME directory.

Upgrade stepslink

  1. Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.

  2. Stop the Agent Listener service:

    • If you configured the agent using systemd, stop the socket.

      sudo systemctl stop hvr.socket
      content_copy
    • If you configured the agent to run as a daemon process, stop the service using command hvragentlistener.

      hvragentlistener -k <agent_port_number>
      content_copy
  3. Install the new version of HVA; uncompress the HVA installation file into the HVR_HOME directory.

    cd $HVR_HOME
    tar -zxzf <hva_installation_file>.tar.gz
    content_copy
  4. Start the Agent Listener service:

    • If you configured the agent using systemd, start the socket.

      sudo systemctl start hvr.socket
      content_copy
    • If you configured the agent to run as a daemon process, start the service using command hvragentlistener.

      hvragentlistener -d <agent_port_number>
      content_copy

Upgrading HVA on Windowslink

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Windows.

Requirementslink

  • HVA installation file
  • Before upgrading HVA, it is recommended to take a full backup of the HVR_HOME directory.

Upgrade stepslink

  1. Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.

  2. Stop the Agent Listener service (refer to Microsoft Windows documentation for steps to configure services).

  3. Install the new version of the agent using either of the following methods:

    Install HVA on Windows using EXE file

    Perform the following steps as the user that runs the HVA. We recommend running the HVA as an Administrator user or a user that has permissions to access the .ldf and .mdf files generated by your SQL Server database.

    Windows user account permissions:

    NOTE: HVA's installation file for Windows is available in the .exe and .zip formats. The compressed file (.zip) distribution is normally used as an alternative for the Windows executable based (.exe) distribution. The steps to install HVA are also different for both formats.

    1. Run the downloaded .exe file (for example, hvr-6.1.0_10-hub_and_agent-windows-x64-64bit_ga_patch-setup.exe).

    2. In the setup wizard dialog, click Next.

      Welcome.png

    3. Read the License Agreement, select I accept the agreement and then click Next.

      LicenseAgreement.png

    4. Specify the HVA installation directories and click Next.

      DestinationDirectories.png

    5. Click Next to create a program folder for HVA.

      ProgramFolder.png

    6. Select High-Volume Agent (HVA) and click Next.

      InstallationRoleAgent.png

    7. Enter a value for Agent Listener Port and click Next.

      AgentListenerPort.png

    8. Select the user account to run the HVA service.

      • If you select Specified user, enter the values for User, Password, Confirm Password and click Next.

        NOTE: For user with Windows authentication (if applicable), specify your Active Directory domain and username in the format <domain>\<username>.

        ServicesUserAccount_Specific.png

      • If you select Local System account, click Next.

        ServicesUserAccount_Local.png

    9. Select Add HVR_HOME, HVR_CONFIG, and HVR_TMP (if required) and click Next.

      This is to set the environment variables HVR_HOME, HVR_CONFIG, and HVR_TMP in your operating system. These variables point to the corresponding directories created in step 4 above.

      AdditionalConfiguration_Agent.png

    10. Click Next to initiate the installation.

      ReadytoInstall.png

    11. Click Finish to start the HVA service.

      CompletedAgent.png

      Once the installation is complete, the HVA and all required components are installed into the $HVR_HOME directory (C:\hvr\hvr_home).

      NOTE: The size of the installation is less than 150 MB. After installing (extracting), you can delete the installation file as it is no longer required.

    Install HVA on Windows using ZIP file

    Uncompress (unzip) the HVA installation file into the HVR_HOME directory.

  4. Start the Agent Listener service (refer to Microsoft Windows documentation for steps to configure services).

Upgrading HVA on Unixlink

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Unix (Solaris, AIX, HP-UX).

Requirementslink

  • HVA installation file
  • Before upgrading HVA, it is recommended to take a full backup of the HVR_HOME directory.

Upgrade stepslink

  1. Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.

  2. Stop the Agent Listener service:

    • If you configured the agent using inetd, stop the inetd service (refer to the OS instructions).

    NOTE: If you are on Solaris and used Service Management Facility (SMF), run the following command to refresh the service:

    svcadm refresh inetd
    content_copy
    • If you configured the agent to run as a daemon process, stop the service using command hvragentlistener.

      hvragentlistener -k <agent_port_number>
      content_copy
  3. Install the new version of HVA; uncompress the HVA installation file into the HVR_HOME directory.

    cd $HVR_HOME
    gzip -dc <hva_installation_file>.tar.gz | tar xf -
    content_copy
  4. Start the Agent Listener service:

    • If you configured the agent using inetd, reload the inetd service to apply the changes (refer to the OS instructions).

    • If you configured the agent to run as a daemon process, start the service using command hvragentlistener.

      hvragentlistener -d <agent_port_number>
      content_copy

Questions?

We're always happy to help with any other questions you might have! Send us an email.

    Thanks for your feedback!
    Was this page helpful?