Merge pull request #54 from dell/release/v5.5.0

Release 5.5.0

Author: mikehorgan-dell

VERSION

@@ -1 +1 @@
-5.4.3
+5.5.0

engine/README.md

@@ -155,7 +155,7 @@ docker run --rm ghcr.io/dell/storage-performance-tool:latest \
 # Run with your custom scenario
 docker run --rm \
   -v $(pwd):/workspace \
-  -v $(pwd)/logs:/home/spt/log \
+  -v $(pwd)/logs:/opt/spt/log \
   ghcr.io/dell/storage-performance-tool:latest \
   --run-scenario=/workspace/my-scenario.js
 
@@ -166,24 +166,43 @@ make docker-scenarios
 make docker-scenario SCENARIO=example-scenario.js
 ```
 
+#### Docker Image Layout
+
+The SPT Docker image uses `/opt/spt` as its working directory:
+
+```
+/opt/spt/
+├── spt.jar          # Main application JAR
+├── ext/             # Extension JARs (storage drivers, load patterns)
+├── scenarios/       # Built-in example scenarios
+├── entrypoint.sh    # Container entrypoint
+└── log/             # Log output (created at runtime)
+```
+
 #### Docker Volumes
 
 The SPT Docker image supports several volume mount points:
 
-- `/home/spt/log` - Log files output directory
+- `/opt/spt/log` - Log files output directory
 - `/workspace` - Custom scenarios and data files
-- `/data` - Input/output data files
 
-Example with all volumes:
+Example with volumes:
 ```bash
 docker run --rm \
   -v $(pwd)/scenarios:/workspace \
-  -v $(pwd)/logs:/home/spt/log \
-  -v $(pwd)/data:/data \
+  -v $(pwd)/logs:/opt/spt/log \
   ghcr.io/dell/storage-performance-tool:latest \
   --run-scenario=/workspace/my-test.js
 ```
 
+#### Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `SPT_HOME` | (ephemeral temp dir) | Override the engine's app-home directory. Set this to a persistent path if you need to preserve extracted config/resources across runs. |
+| `SPT_JAVA_OPTS` | `-Xshare:off -XX:UseAVX=2` | Additional JVM options appended to the default JAVA_OPTS. |
+| `JAVA_OPTS` | (see entrypoint.sh) | Full JVM options override. Default includes ZGC, 4GB heap, NUMA, and NFS compatibility flags. |
+
 #### Docker Compose
 
 A `docker-compose.yml` example is provided in the `bundle/` directory that includes:

engine/bundle/docker-compose.yml

@@ -26,7 +26,7 @@ services:
       - --item-data-size=1MB
       - --load-op-limit-count=1000
     volumes:
-      - ./logs:/home/spt/log
+      - ./logs:/opt/spt/log
 
   # Spt with custom scenario from local filesystem
   spt-custom:
@@ -39,7 +39,7 @@ services:
       - --storage-auth-secret=${SPT_S3_SECRET_KEY:-your-secret-key}
     volumes:
       - ./scenarios:/workspace:ro  # Mount local scenarios directory as read-only
-      - ./logs:/home/spt/log
+      - ./logs:/opt/spt/log
       - ./data:/data               # For input/output files
 
   # Spt with weighted load scenario
@@ -52,7 +52,7 @@ services:
       - --storage-auth-uid=${SPT_S3_ACCESS_KEY:-your-access-key}
       - --storage-auth-secret=${SPT_S3_SECRET_KEY:-your-secret-key}
     volumes:
-      - ./logs:/home/spt/log
+      - ./logs:/opt/spt/log
       - ./data:/data
     environment:
       - JAVA_OPTS=-Xmx4g -XX:+UseG1GC
@@ -67,7 +67,7 @@ services:
       - --item-data-size=1MB
       - --load-op-limit-count=1000
     volumes:
-      - ./logs:/home/spt/log
+      - ./logs:/opt/spt/log
       - ./data:/data
 
 # Usage examples:

engine/config/defaults.yaml

@@ -21,8 +21,9 @@ required/supplementary files are already installed and their content is the same
 
 ### Stages
 
-0. Installer loads the default configuration from the resources to determine the version. The version is used to
-determine the Spt home path (a temporary directory used for extracted resources).
+0. Installer loads the default configuration from the resources to determine the version (used for the startup
+banner). The Spt home path is resolved independently: if the `SPT_HOME` environment variable is set it is used;
+otherwise a temporary directory is created and automatically removed on JVM shutdown.
 
 1. Installer copies the required and supplementary files into the Spt home. These files are default configuration,
 custom content files, scenarios and extensions.

engine/core/spt-base/doc/design/installer/README.md

@@ -78,7 +78,7 @@ reference.
 | run-port                                       | Integer > 0 | 9999               | Port for REST API
 | server-metrics-expose_fleet                    | Boolean | true                   | Controls whether the entry node exposes the `/metrics/cluster/json` endpoint (and the legacy `/metrics/fleet/json` alias).
 | run-scenario                                   | Path | null                      | The default file scenario to run, null means invoking the default.js scenario bundled into the distribution
-| run-version                                    | String | 4.2.15                  | The Spt version
+| run-version                                    | String | (current)               | The Spt version (set automatically from defaults.yaml)
 | run-id                                         | long | 0                         | The run identifier (see Runs API). If not specified, it takes the value of timestam
 | storage-auth-file                              | Path | null                      | The path to a credentials list file, containing the lines of comma-separated item path, user id and secret key
 | storage-auth-uid                               | String | null                    | The authentication identifier

engine/core/spt-base/doc/usage/input/configuration/README.md

@@ -115,7 +115,7 @@ run:
   node: false
   port: 9999
   scenario: null
-  version: 5.4.3
+  version: 5.5.0
 
 log:
   level: info