Directory Structure

This section outlines the structure and purpose of directories and files created during the installation of HVR Hub and HVR Agent.

Making any changes to the hvr_home directory or its subdirectories is strictly prohibited. This directory must remain unchanged to ensure security and integrity during updates or upgrades. User-specific configurations and runtime data should be stored in the hvr_config directory, which is associated with the HVR repository.

HVR Hub

The installation directory may include the following directories, each serving a specific role in HVR Hub's operation and configuration:

hvr_home: Contains executables and files essential for running the HVR Hub.

Expand to see the directories and files in hvr_home


📁 hvr_home
│
├─ 📁 api        --  REST API documentation
│
├─ 📁 bin        --  Executable files and shared libraries (dynamic-link 
│                    libraries on Windows) for running the HVR Hub
│
├─ 📁 dbms       --  Database-specific SQL files and templates
│
├─ 📁 etc        --  Configuration files and other miscellaneous files
│  │
│  ├─ 📁 cert    --  Bundled certificates, such as root CAs
│  │
│  ├─ 📁 snmp    --  SNMP MIB file
│  │
│  ├─ 📁 xml     --  DTD of XML-serialized data streams in HVR
│  │
│  ├─ 📄 constsqlexpr.pat            --  SQL expressions treated as constants to
│  │                                     optimize replication performance
│  │
│  ├─ 📄 hvrosaccess_example.conf    --  Sample configuration for allowing HVR to
│  │                                     run plugins from non-standard directories
│  │
│  └─ 📄 purge.manifest              --  Manifest file (see hvrstrip -m)
│
├─ 📁 examples       --  Sample channel definitions
│
├─ 📁 jre            --  Bundled Java Runtime for Fivetran Proxy
│
├─ 📁 lib            --  Shared libraries and database drivers
│
├─ 📁 plugin         --  Plugins shipped (installed) with HVR Hub
│  │
│  ├─ 📁 agent
│  │
│  └─ 📁 transform
│
├─ 📁 plugin_examples    --  Sample plugins. To use a sample plugin, save
│  │                         it in the 'hvr_config/plugin' directory
│  ├─ 📁 agent
│  │
│  ├─ 📁 authentication
│  │
│  ├─ 📁 rewrite
│  │
│  └─ 📁 transform
│
├─ 📁 proxy          --  Bundled Fivetran Proxy
│
├─ 📁 sbin           --  Manually created trusted executables
│
├─ 📁 script         --  Internal HVR script files
│
├─ 📁 www            --  HVR UI-related files
│
├─ 📄 hvr.3rdparty   --  License agreements, copyrights, versions, and
│                        notices for third-party software used by HVR.
│
├─ 📄 hvr.rel        --  HVR Release Notes
│
└─ 📄 hvr.ver        --  HVR version number

hvr_config: Contains directories and files associated with the HVR Hub configuration.

Expand to see the directories and files in hvr_config


📁 hvr_config    --  Directories and files for the HVR Hub configuration
│
├─ 📁 download   --  Temporary files generated during large-file transfers
│
├─ 📁 etc        --  Configuration files for the HVR Hub
│
├─ 📁 hubs       --  Directories and files associated with the hubs, channels, 
│  │                 locations, etc
│  └─ 📁 hub
│     │
│     ├─ 📁 alerts               -- HVR alert configuration and state files
│     │
│     ├─ 📁 channels             --  Channel-specific data
│     │  │
│     │  └─ 📁 channel
│     │     │
│     │     ├─ 📁 control        --  Control files (see hvrcontrol)
│     │     │
│     │     ├─ 📁 jobcache       --  Cached job data, such as activation state
│     │     │
│     │     ├─ 📁 jobgen         --  Generated job scripts
│     │     │
│     │     ├─ 📁 jobstate       --  State files for Compare/Refresh jobs
│     │     │
│     │     └─ 📁 locs           --  Location-specific data
│     │        │
│     │        └─ 📁 location
│     │           │
│     │           ├─ 📁 capckp          --  Capture checkpoint files
│     │           │
│     │           ├─ 📁 capckpretain    --  Retained capture checkpoint files
│     │           │
│     │           ├─ 📁 enroll          --  Capture enroll information
│     │           │
│     │           └─ 📁 router          --  Router files for replication
│     │              │
│     │              └─ 📁 loc_target   --  Capture transaction data
│     │
│     ├─ 📁 download        --  Hub-specific temporary files generated during
│     │                         large-file transfers
│     │
│     ├─ 📁 logarchives     --  Archives of Hub-specific and job-specific log files
│     │
│     ├─ 📁 logs            --  Hub-specific and job-specific log files
│     │
│     └─ 📁 stats           --  Statistics state and temporary data
│
├─ 📁 intermediate    --  Temporary files for Compare/Refresh jobs
│
├─ 📁 logarchives     --  Archives of Hub Server-level logs, shared across all hubs
│
├─ 📁 logs            --  Hub Server-level logs, shared across all hubs
│
├─ 📁 metering        --  Metered usage data for Consumption-based license
│
├─ 📁 plugin          --  User-installed plugins (see 'hvr_home/plugin_examples/')
│  │
│  ├─ 📁 agent
│  │
│  └─ 📁 transform
│
├─ 📁 public    --  Log file retention information
│
├─ 📁 run       --  Runtime state, like .pid files
│
├─ 📁 tmp       --  Temporary files (default, if HVR_TMP is not defined)
│
└─ 📁 wallet    --  Security wallet for bootstrap to get to the repository database

hvr_tmp (optional): Contains temporary files associated with the HVR Hub.

HVR Agent

The installation directory may include the following directories, each serving a specific role in HVR Agent's operation and configuration:

hvr_home: Contains executables and files essential for running the HVR Agent.

Expand to see the directories and files in hvr_home


📁 hvr_home
│
├─ 📁 api        --  REST API documentation
│
├─ 📁 bin        --  Executable files and shared libraries (dynamic-link 
│                    libraries on Windows) for running the HVR Agent
│
├─ 📁 dbms       --  Database-specific SQL files and templates
│
├─ 📁 etc        --  Configuration files and other miscellaneous files
│  │
│  ├─ 📁 cert    --  Bundled certificates, such as root CAs
│  │
│  ├─ 📁 snmp    --  SNMP MIB file
│  │
│  ├─ 📁 xml     --  DTD of XML-serialized data streams in HVR
│  │
│  ├─ 📄 constsqlexpr.pat            --  SQL expressions treated as constants to
│  │                                     optimize replication performance
│  │
│  ├─ 📄 hvrosaccess_example.conf    --  Sample configuration for allowing HVR to
│  │                                     run plugins from non-standard directories
│  │
│  └─ 📄 purge.manifest              --  Manifest file (see hvrstrip -m)
│
├─ 📁 examples       --  Sample channel definitions
│
├─ 📁 lib            --  Shared libraries and database drivers
│
├─ 📁 plugin         --  Plugins shipped (installed) with the HVR Agent
│  │
│  ├─ 📁 agent
│  │
│  └─ 📁 transform
│
├─ 📁 plugin_examples    --  Sample plugins. To use a sample plugin, save
│  │                         it in the 'hvr_config/plugin' directory
│  ├─ 📁 agent
│  │
│  ├─ 📁 authentication
│  │
│  ├─ 📁 rewrite
│  │
│  └─ 📁 transform
│
├─ 📁 sbin           --  Manually created trusted executables
│
├─ 📁 script         --  Internal HVR script files
│
├─ 📁 www            --  HVR UI-related files
│
├─ 📄 hvr.3rdparty   --  License agreements, copyrights, versions, and
│                        notices for third-party software used by HVR
│
├─ 📄 hvr.rel        --  HVR Release Notes
│
└─ 📄 hvr.ver        --  HVR version number

hvr_config: Contains directories and files associated with the HVR Agent configuration.

Expand to see the directories and files in hvr_config


📁 hvr_config    --  Directories and files for the HVR Agent configuration
│
├─ 📁 etc        --  Configuration files for the HVR Agent
│
├─ 📁 intermediate    --  Temporary files for Compare/Refresh jobs
│
├─ 📁 logs            --  HVR Agent-level log files
│
├─ 📁 plugin          --  User-installed plugins (see 'hvr_home/plugin_examples/')
│  │
│  ├─ 📁 agent
│  │
│  └─ 📁 transform
│
├─ 📁 public    --  Log file retention information
│
├─ 📁 run       --  Runtime state, such as `.pid` files
│
└─ 📁 tmp       --  Temporary files (default, if HVR_TMP is not defined)

hvr_tmp (optional): Contains temporary files associated with the HVR Agent.

To reduce the hvr_home directory size and retain only the essential commands required for operating the HVR Agent, you can use the hvrstrip -r command.