v1.0.0 ORJarInstall: OpenROAD Server Application Installer

Summary:

This release introduces orjarinstall.py, a Python script designed to simplify the deployment of OpenROAD server applications from a single, portable archive. This tool automates the process of extracting and placing various application components—such as shared libraries, configuration files, and application images—into their correct directories within your OpenROAD environment.

Usage

Deploy an OpenROAD application by running the script with the path to your .zip archive.

python orjarinstall.py orjarfile

• orjarfile: The path to the .zip archive containing the server application and other resources. An example archive, orserver-add-l2pserver.zip, is attached to this release as a sample orjarfile.

Supported Archive Directories

The orjarinstall.py script automatically processes the following subdirectories found within your application archive:

• libu3gl: Shared libraries/DLLs
• netutil: Netutil command scripts
• orjsonconfig: JSON configuration files for server applications
• orserveradm_removeapp: JSON files for the orserveradm.py RemoveApp command
• orserveradm_addapp: JSON files for the orserveradm.py AddApp command
• resource: Additional resource directories for deployment
• w4glapps: OpenROAD Server application images

Preconditions

Before running the script, ensure the following are configured in your environment:

• II_SYSTEM: The environment variable II_SYSTEM must be set.
• COMPUTERNAME: This must be set if you don't provide a "serverlocation" when using the AddApp command.
• orjarinstall_cfg.json: This optional JSON configuration file should exist in $II_SYSTEM/ingres/files. It can be used to customize the deployment directories for various components. If this file doesn't exist, the script uses default locations.

The JSON configuration file can contain the following members:

• libu3gldir: Directory for shared libraries/DLLs.
• orjsonconfigdir: Directory for JSON config files.
• resourcedir: Directory for resource files.
• w4glappsdir: Directory for 4GL image files.

v0.0.1 Python script to deploy OpenROAD Server Applications from an archive

• Usage: python orjarinstall.py [-h] orjarfile

• positional arguments:
  orjarfile archive containing the server application and other resources required, see attached orserver-add-l2pserver.zip
  This archive can have the following subdirectories that will be processed:
  - libu3gl - shared libraries/DLLs
  - netutil - netutil command scripts
  - orjsonconfig - JSON config files for OpenROAD server applications
  - orserveradm_removeapp - JSON file to be used by the "orserveradm.py" script with RemoveApp command
  - orserveradm_addapp - JSON file to be used by the "orserveradm.py" script with AddApp command
  - resource - Additional resource directories to be deployed
  - w4glapps - OpenROAD Server application images

• optional arguments:
  -h, --help show help message and exit

• Preconditions:

  • Environment variables II_SYSTEM must be set.
  • The COMPUTERNAME needs to be set if not providing a "serverlocation" when using AddApp
  • The JSON file orjarinstall_cfg.json should exist in $II_SYTEM/ingres/files directory.
    This file should contain a JSON object {...} with the following members (all optional):
    • "libu3gldir" - the directory shared libraries/DLLs are deployed into.
      This directory should be contained in LD_LIBRARY_PATH (Linux) or PATH (Windows); default: $II_SYTEM/ingres/lib (Linux) or %II_SYSTEM%\ingres\bin (Windows)
    • "orjsonconfigdir" - the directory JSON config files for OpenROAD server applications are deployed into (default: $II_SYTEM/ingres/files/orjsonconfig)
    • "resourcedir" - the directory "resource" directories (and their contents) are deployed into (default: $II_SYTEM/ingres)
    • "w4glappsdir" - the directory 4GL image files are deployed into; directory should be contained in II_W4GLAPPS_DIR (default: $II_SYTEM/ingres/w4glapps)