Merge branch 'all-config-with-env' of https://github.com/ntia/scos-se…

…nsor into all-config-with-env

.github/workflows/github-actions-test.yml

@@ -75,7 +75,6 @@ jobs:
           source ./env.template
           export MOCK_SIGAN=1
           export MOCK_SIGAN_RANDOM=1
-          export SSD_DEVICE=/dev/nvme0n1
           docker-compose build --no-cache
           docker-compose up -d
 

README.md

@@ -314,6 +314,8 @@ settings in the environment file:
 - ADMIN_EMAIL: Email used to generate admin user. Change in production.
 - ADMIN_NAME: Username for the admin user.
 - ADMIN_PASSWORD: Password used to generate admin user. Change in production.
+- API_SHM_SIZE: Size to allocate shared memory (`/dev/shm`) in the API container. This
+  is currently used to allocate shared memory for parallel processing of IQ data with Ray.
 - AUTHENTICATION: Authentication method used for scos-sensor. Supports `TOKEN` or
   `CERT`.
 - BASE_IMAGE: Base docker image used to build the API container. These docker
@@ -379,6 +381,9 @@ settings in the environment file:
   [WebRelay](https://github.com/NTIA/Preselector) that may be used to power cycle
   the signal analyzer if necessary. Note: specifics of power cycling behavior
   are implemented within the signal analyzer implementations or actions.
+- SSD_DEVICE: The device (e.g., `/dev/sda/`) which is mapped to `/dev/nvme0n1` within
+  the API container. This is currently only used to retrieve SSD SMART diagnostics (in
+  SCOS Actions).
 - SSL_CA_PATH: Path to a CA certificate used to verify scos-sensor client
   certificate(s) when authentication is set to CERT.
 - SSL_CERT_PATH: Path to server SSL certificate. Replace the certificate in the

compose.yaml

@@ -58,8 +58,8 @@ services:
       - IN_DOCKER=1
       - IPS
       - MAX_DISK_USAGE
-      - MOCK_SIGAN=1
-      - MOCK_SIGAN_RANDOM=1
+      - MOCK_SIGAN
+      - MOCK_SIGAN_RANDOM
       - PATH_TO_CLIENT_CERT
       - PATH_TO_VERIFY_CERT
       - POSTGRES_PASSWORD