Directory Structure - DSS 6 | Data Source Solutions Documentation
Documentation: Directory Structure - DSS 6 | Data Source Solutions Documentation
Directory Structure
This section outlines the structure and purpose of directories and files created during the installation of DSS Hub and DSS Agent.
Making any changes to the dss_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 dss_config directory, which is associated with the DSS repository.
DSS Hub
The installation directory may include the following directories, each serving a specific role in DSS Hub's operation and configuration:
-
dss_home: Contains executables and files essential for running the DSS Hub.
Expand to see the directories and files in dss_home
📁 dss_home │ ├─ 📁 api -- REST API documentation │ ├─ 📁 bin -- Executable files and shared libraries (dynamic-link │ libraries on Windows) for running the DSS 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 DSS │ │ │ ├─ 📄 constsqlexpr.pat -- SQL expressions treated as constants to │ │ optimize replication performance │ │ │ ├─ 📄 dssosaccess_example.conf -- Sample configuration for allowing DSS to │ │ run plugins from non-standard directories │ │ │ └─ 📄 purge.manifest -- Manifest file (see dssstrip -m) │ ├─ 📁 examples -- Sample channel definitions │ ├─ 📁 jre -- Bundled Java Runtime for Data Source Solutions Proxy │ ├─ 📁 lib -- Shared libraries and database drivers │ ├─ 📁 plugin -- Plugins shipped (installed) with DSS Hub │ │ │ ├─ 📁 agent │ │ │ └─ 📁 transform │ ├─ 📁 plugin_examples -- Sample plugins. To use a sample plugin, save │ │ it in the 'dss_config/plugin' directory │ ├─ 📁 agent │ │ │ ├─ 📁 authentication │ │ │ ├─ 📁 rewrite │ │ │ └─ 📁 transform │ ├─ 📁 proxy -- Bundled Data Source Solutions Proxy │ ├─ 📁 sbin -- Manually created trusted executables │ ├─ 📁 script -- Internal DSS script files │ ├─ 📁 www -- DSS UI-related files │ ├─ 📄 dss.3rdparty -- License agreements, copyrights, versions, and │ notices for third-party software used by DSS. │ ├─ 📄 dss.rel -- DSS Release Notes │ └─ 📄 dss.ver -- DSS version number -
dss_config: Contains directories and files associated with the DSS Hub configuration.
Expand to see the directories and files in dss_config
📁 dss_config -- Directories and files for the DSS Hub configuration │ ├─ 📁 download -- Temporary files generated during large-file transfers │ ├─ 📁 etc -- Configuration files for the DSS Hub │ ├─ 📁 hubs -- Directories and files associated with the hubs, channels, │ │ locations, etc │ └─ 📁 <em>hub</em> │ │ │ ├─ 📁 alerts -- DSS alert configuration and state files │ │ │ ├─ 📁 channels -- Channel-specific data │ │ │ │ │ └─ 📁 <em>channel</em> │ │ │ │ │ ├─ 📁 control -- Control files (see dsscontrol) │ │ │ │ │ ├─ 📁 jobcache -- Cached job data, such as activation state │ │ │ │ │ ├─ 📁 jobgen -- Generated job scripts │ │ │ │ │ ├─ 📁 jobstate -- State files for Compare/Refresh jobs │ │ │ │ │ └─ 📁 locs -- Location-specific data │ │ │ │ │ └─ 📁 <em>location</em> │ │ │ │ │ ├─ 📁 capckp -- Capture checkpoint files │ │ │ │ │ ├─ 📁 capckpretain -- Retained capture checkpoint files │ │ │ │ │ ├─ 📁 enroll -- Capture enroll information │ │ │ │ │ └─ 📁 router -- Router files for replication │ │ │ │ │ └─ 📁 loc_<em>target</em> -- 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 'dss_home/plugin_examples/') │ │ │ ├─ 📁 agent │ │ │ └─ 📁 transform │ ├─ 📁 public -- Log file retention information │ ├─ 📁 run -- Runtime state, like .pid files │ ├─ 📁 tmp -- Temporary files (default, if DSS_TMP is not defined) │ └─ 📁 wallet -- Security wallet for bootstrap to get to the repository database -
dss_tmp (optional): Contains temporary files associated with the DSS Hub.
DSS Agent
The installation directory may include the following directories, each serving a specific role in DSS Agent's operation and configuration:
-
dss_home: Contains executables and files essential for running the DSS Agent.
Expand to see the directories and files in dss_home
📁 dss_home │ ├─ 📁 api -- REST API documentation │ ├─ 📁 bin -- Executable files and shared libraries (dynamic-link │ libraries on Windows) for running the DSS 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 DSS │ │ │ ├─ 📄 constsqlexpr.pat -- SQL expressions treated as constants to │ │ optimize replication performance │ │ │ ├─ 📄 dssosaccess_example.conf -- Sample configuration for allowing DSS to │ │ run plugins from non-standard directories │ │ │ └─ 📄 purge.manifest -- Manifest file (see dssstrip -m) │ ├─ 📁 examples -- Sample channel definitions │ ├─ 📁 lib -- Shared libraries and database drivers │ ├─ 📁 plugin -- Plugins shipped (installed) with the DSS Agent │ │ │ ├─ 📁 agent │ │ │ └─ 📁 transform │ ├─ 📁 plugin_examples -- Sample plugins. To use a sample plugin, save │ │ it in the 'dss_config/plugin' directory │ ├─ 📁 agent │ │ │ ├─ 📁 authentication │ │ │ ├─ 📁 rewrite │ │ │ └─ 📁 transform │ ├─ 📁 sbin -- Manually created trusted executables │ ├─ 📁 script -- Internal DSS script files │ ├─ 📁 www -- DSS UI-related files │ ├─ 📄 dss.3rdparty -- License agreements, copyrights, versions, and │ notices for third-party software used by DSS │ ├─ 📄 dss.rel -- DSS Release Notes │ └─ 📄 dss.ver -- DSS version number -
dss_config: Contains directories and files associated with the DSS Agent configuration.
Expand to see the directories and files in dss_config
📁 dss_config -- Directories and files for the DSS Agent configuration │ ├─ 📁 etc -- Configuration files for the DSS Agent │ ├─ 📁 intermediate -- Temporary files for Compare/Refresh jobs │ ├─ 📁 logs -- DSS Agent-level log files │ ├─ 📁 plugin -- User-installed plugins (see 'dss_home/plugin_examples/') │ │ │ ├─ 📁 agent │ │ │ └─ 📁 transform │ ├─ 📁 public -- Log file retention information │ ├─ 📁 run -- Runtime state, such as `.pid` files │ └─ 📁 tmp -- Temporary files (default, if DSS_TMP is not defined) -
dss_tmp (optional): Contains temporary files associated with the DSS Agent.
To reduce the dss_home directory size and retain only the essential commands required for operating the DSS Agent, you can use the dssstrip -r command.