Skip to main content

Proposed Directory Structure

Expected installation locations

  • Linux/Solaris: /opt/waratek
  • Windows: There is no specific directory recommendation for Windows

By default, Waratek uses the following layout for its root directory.

$ tree waratek-upgrade-19.x.x-bxxx/
├── agent
│ ├── aix-ppc32
│ │ └── libwaratek.so
│ ├── aix-ppc64
│ │ └── libwaratek.so
│ ├── compiler11.jar
│ ├── compiler8.jar
│ ├── guest.jar
│ ├── host.jar
│ ├── linux-i586
│ │ └── libwaratek.so
│ ├── linux-x64
│ │ └── libwaratek.so
│ ├── module_patch.jar
│ ├── solaris-sparc
│ │ └── libwaratek.so
│ ├── solaris-sparcv9
│ │ └── libwaratek.so
│ ├── waratek.jar
│ ├── windows-i586
│ │ └── waratek.dll
│ └── windows-x64
│ └── waratek.dll
├── conf_1
│ ├── rules.armr
│ └── waratek.properties
├── conf_2
│ ├── rules.armr
│ └── waratek.properties
├── doc
│ ├── Waratek Enterprise Install Guide 2019-09.pdf
│ ├── Waratek Enterprise User Guide 2019-09.pdf
│ └── Waratek JLP Install Guide 2019-09.pdf
├── launcher
│ ├── waratek-jlp-aix-ppc32
│ ├── waratek-jlp-aix-ppc64
│ ├── waratek-jlp-linux-i586
│ ├── waratek-jlp-linux-x64
│ ├── waratek-jlp-solaris-sparc
│ ├── waratek-jlp-solaris-sparcv9
│ ├── waratek-jlp-windows-i586
│ └── waratek-jlp-windows-x64
└── scripts
└── waratek-deploy.sh

Directories used

  • agent: Location of Waratek agent installation.
  • conf_*: Each configuration folder contains a separate configuration for an instance of the Application. The name of the configuration folder can be changed according to the user's requirements. Files will be modified in this directory and therefor write access must be permitted
  • doc: Location of the product documentation
  • launcher: Java Launcher Pack (this is for Java Upgrade only)
  • keystore: Directory for location of optional Keystore (HTTPS/SSL configuration)

conf folder structure​

logProps.xml​

This is the standard logging configuration XML file where the user can specify the mode of the logs, the name of the log file and the max size of the log files, etc Here is an example:-

<logProps-array>
  <logProps>
    <logMode>LOCAL</logMode>
    <logFile>SECURITYLOG</logFile>
    <fileName>path_to_rules_filename</fileName>
    <priorityLevel>DEBUG</priorityLevel>
    <maxFileSize>20MB</maxFileSize>
    <maxBackupIndex>10</maxBackupIndex>
  </logProps>
</logProps-array>

waratek.properties​

This is the main configuration for the agent, where the user can specify a variety of properties. Here is an example:-

com.waratek.rules.local=/opt/waratek/conf[1..20]/jvc.rules
com.waratek.log.properties=/opt/waratek/conf[1..20]/logProps.xml
com.waratek.rules.autoreload=true

instance.waratek.properties​

When an agent on-boards to the Portal for the first time, it will create a file called instance.waratek.properties. The Portal uses this file to save credentials (node ID and password) to uniquely identify an agent after connection to the Portal.