@nsshunt/stsconfig 1.12.0 → 1.16.0

package/.env-default

@@ -0,0 +1,222 @@
+# ==================================================================================================
+# Default configuration settings
+# ==================================================================================================
+# Log error messages to the console within the microservice
+CONSOLE_LOG_ERRORS=false
+# Database username.
+DB_USER=postgres
+# Database password.
+DB_PASSWORD=password
+# Database password file
+#DB_PASSWORD_FILE
+# Database host
+DB_HOST=localhost
+# Database port
+DB_PORT=5432
+# Database name.
+DB_DATABASE=stsrestmsdb01
+# Database connection string to be used in production mode
+#DATABASE_URL=
+# Database script(s) folder
+DB_SCRIPT_FOLDER=/var/lib/sts/stsglobalresources/db-scripts
+
+# The maximum pool size for pg. There will be one pool per thread.
+POOL_SIZE=500
+# Maximum number of CPUs (incl. logical processors) to use within the Microservice. 
+# Use -1 to use all available within the runtime container. Each CPU will spawn a node work thread.
+MAX_CPU=-1
+# Automatically re-spawn a worker thread if one dies.
+RESPAWN=false
+# Default number of entries to create for a fresh database.
+DEFAULT_DB_ENTRIES=10000
+# Microservice listen port.
+USE_REDIS=false
+# Use redis for Microservice.
+USE_L1_REDIS=false
+# Automatically flush the redis cache when terminating the Microservice.
+REDIS_END_FLUSH=false
+# Redis server port.
+REDIS_PORT=6379
+# Redis server endpoint.
+REDIS_SERVER=localhost
+# Default K6 test script path
+K6SCRIPTPATH=.
+# Default number of entries to create for a fresh database.
+DEFAULT_DATABASE_MIN_EXTRA_DATA_SIZE=0
+# Default number of entries to create for a fresh database.
+DEFAULT_DATABASE_MAX_EXTRA_DATA_SIZE=2000
+
+# STSREST01 Server endpoint
+REST01_ENDPOINT=http://localhost
+# STSREST01 Server port (listen port for the service)
+REST01_HOST_PORT=3003
+# STSREST01 Server port (client port to access the service)
+REST01_PORT=3003
+# STSREST01 Server endpoint
+REST01_APIROOT=/stsrest01/v1
+# STSREST01 Prometheus metric support
+REST01_PROM_SUPPORT=true
+# STSREST01 Cluster Server port (port used for cluster prometheus scrapes). Service will listen on this port at mount point /metrics
+REST01_PROM_CLUSTER_PORT=3013
+# STSREST01 Service Name
+REST01_SERVICE_NAME=STSRest01
+# STSREST01 Service Version
+REST01_SERVICE_VERSION=1.0.0
+
+# STS Instrument Manager Service endpoint
+IM_ENDPOINT=http://localhost
+# STS Instrument Manager Service listen port (listen port for the service)
+IM_HOST_PORT=3001
+# STS Instrument Manager Service client access port (client port to access the service)
+IM_PORT=3001
+# STS Instrument Manager Service endpoint
+IM_APIROOT=/stsinstrumentmanager/v1
+# STS Instrument Manager Prometheus metric support
+IM_PROM_SUPPORT=true
+# STS Instrument Manager Cluster Server port (port used for cluster prometheus scrapes)
+IM_PROM_CLUSTER_PORT=3011
+# STS Instrument Manager Service Name
+IM_SERVICE_NAME=STSInstrumentManager
+# STS Instrument Manager Service Version
+IM_SERVICE_VERSION=1.0.0
+
+# STS Test Orchestrator Service endpoint
+TO_ENDPOINT=http://localhost
+# STS Test Orchestrator Service listen port (listen port for the service)
+TO_HOST_PORT=3004
+# STS Test Orchestrator Service client access port (client port to access the service)
+TO_PORT=3004
+# STS Test Orchestrator Service endpoint
+TO_APIROOT=/ststestorchestrator/v1
+# STS Test Orchestrator Prometheus metric support
+TO_PROM_SUPPORT=true
+# STS Test Orchestrator Cluster Server port (port used for cluster prometheus scrapes)
+TO_PROM_CLUSTER_PORT=3014
+# STS Test Orchestrator Service Name
+TO_SERVICE_NAME=STSTestOrchestrator
+# STS Test Orchestrator Service Version
+TO_SERVICE_VERSION=1.0.0
+
+# Auth Server endpoint
+AS_ENDPOINT=http://localhost
+# Auth Server host port (listen port for the service)
+AS_HOST_PORT=3002
+# Auth Server port (client port to access the service)
+AS_PORT=3002
+# Auth Server endpoint
+AS_APIROOT=/stsauth/v1
+# Auth Server Prometheus metric support
+AS_PROM_SUPPORT=true
+# Auth Prometheus Cluster Server port (port used for cluster prometheus scrapes)
+AS_PROM_CLUSTER_PORT=3012
+# STSAuth Service Name
+AS_SERVICE_NAME=STSAuth
+# STSAuth Service Version
+AS_SERVICE_VERSION=1.0.0
+# Auth Server - JWKS Public End Point.
+AS_JWKS_JSON_PATH=/.well-known/jwks.json
+# Auth Server - JWKS key rotation time (seconds).
+AS_JWKS_KEY_ROTATION_TIME=86400
+# Auth Server - JWKS key purge time offset (seconds). Old keys (current keys are considered 'old' immediately after a key rotation) will be kept
+# for asaccesstokenexpire + asjwkskeypurgetimeoffset seconds before purging from the JWKS.
+AS_JWKS_KEY_PURGE_TIME_OFFSET=300
+# Auth Server - JWKS key count. Defines the number of active keys within the JWKS. Note that the actual key count may be double this value as current
+# keys are rotated to old keys prior to old key purge. Old keys will be kept for asaccesstokenexpire + asjwkskeypurgetimeoffset seconds before removal from the JWKS.
+# This is to ensure that any tokens signed by a current key that is then expired can still be validated within the life of the issued token.
+AS_JWKS_KEY_COUNT=4
+# Auth Server - JWKS Access token timeout.
+AS_ACCESS_TOKEN_EXPIRE=43200
+# Auth Server - Private Key (when using JWT)
+AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key
+# Auth Server - Public Key (when using JWT)
+AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key
+
+# STS Test Runner Prometheus metric support
+TR_PROM_SUPPORT=true
+# STS Test Runner Cluster Server port (port used for cluster prometheus scrapes)
+TR_PROM_CLUSTER_PORT=3015
+# STS Test Runner Service Name
+TR_SERVICE_NAME=STSRestRunner
+# STS Test Runner Service Version
+TR_SERVICE_VERSION=1.0.0
+
+# Duration (in ms) between each publish event.
+PUBLISH_INTERVAL=1000
+
+# The maximum time (in ms) to wait before timeout error when publishing instruments. Ideally, this should always be lower than the publishinterval frequency
+# to avoid cascading http build up errors.
+PUBLISH_TIMEOUT=750
+
+# If true, instrument publish failures will be logged to debug output.
+PUBLISH_DEBUG=false
+
+# Transport(s) to use for sending instrumentation data to the instrumentation server
+TRANSPORT=RESTAPI
+
+# Use secure cookies option when passing back cookies from STS services (such as STSAuth service).
+# This setting will be ignore for production mode. In production mode services will always use secure cookies.
+USE_SECURE_COOKIES=false
+
+# keepAlive <boolean> Keep sockets around even when there are no outstanding requests, so they can be used for future requests without having to reestablish a 
+# TCP connection. Not to be confused with the keep-alive value of the Connection header. The Connection: keep-alive header is always sent when using an agent
+# except when the Connection header is explicitly specified or when the keepAlive and maxSockets options are respectively set to false and Infinity, in which
+# case Connection: close will be used. Default: false.
+# Reference: https://nodejs.org/api/http.html#class-httpagent
+KEEP_ALIVE=true
+
+# maxSockets <number> Maximum number of sockets to allow per host. If the same host opens multiple concurrent connections, each request will use new socket until the
+# maxSockets value is reached. If the host attempts to open more connections than maxSockets, the additional requests will enter into a pending request queue, and will
+# enter active connection state when an existing connection terminates. This makes sure there are at most maxSockets active connections at any point in time, 
+# from a given host. Default: Infinity.	
+# Reference: https://nodejs.org/api/http.html#class-httpagent
+MAX_SOCKETS=10
+
+# maxTotalSockets <number> Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.
+# Reference: https://nodejs.org/api/http.html#class-httpagent
+MAX_TOTAL_SOCKETS=20
+
+# maxFreeSockets <number> Maximum number of sockets per host to leave open in a free state. Only relevant if keepAlive is set to true. Default: 256.
+# Reference: https://nodejs.org/api/http.html#class-httpagent
+MAX_FREE_SOCKETS=256
+
+# timeout <number> Socket timeout in milliseconds. This will set the timeout when the socket is created.
+# Reference: https://nodejs.org/api/http.html#class-httpagent
+TIMEOUT=10000
+
+# Maximum payload size allowed for express server calls
+MAX_PAYLOAD_SIZE='50mb'
+
+# Instrumentation Config Settings
+# -------------------------------
+# Generic interval (ms) to make on observation for instrumentation objects.
+INSTRUMENTATION_OBSERVATION_INTERVAL=1000
+
+# Generic sliding time window (seconds) for instrumentation objects that process telemetry over time (e.g. P(x) instruments).
+INSTRUMENTATION_TIME_WINDOW=600
+
+# Service Specific Config Settings
+# --------------------------------
+# STSAuth
+# -------
+# Define the valid age for a JWT access token (in ms). Default 10 minutes.
+AUTH_JWT_ACCESS_TOKEN_TIMEOUT=600
+
+# Define the valid age for a JWT refresh token (in ms). Default 24 hours.
+AUTH_JWT_REFRESH_TOKEN_TIMEOUT=86400
+
+# Define the valid age for an authentication/session cookie. Default 24 hours.
+AUTH_COOKIE_TIMEOUT=86400
+
+# STSAppFramework (library)
+# -------------------------
+# Define the time (ms) to wait prior to exiting the application (using process.exit(0))
+MASTER_PROCESS_EXIT_TIME=500
+
+# Define the time (ms) to wait prior to exiting the application (using process.exit(0))
+CHILD_PROCESS_EXIT_TIME=500
+
+# Define the interval (ms) to collect system information for instrumentation purposes
+SYSTEM_INFORMATION_INTERVAL=1000
+
+# Ignore socket.io REST api calls and/or WebSocket calls when collecting telemetry for instrumentation purposes.
+IGNORE_SOCKETIO=true

package/.env-test-file-2

@@ -1,167 +1,121 @@
-#.env
-# ==================================================================================================
-# Development Settings
-# ==================================================================================================
-# Database username
-DB_USER=postgres
-# Database password
-#DB_PASSWORD=somepassword
-# Database password file. To create, use 'echo -n [password] > /home/marcusbettens/projects/dbpassword'
-# This will set the database password to the contents of the dbpassword file without the trailing /cr character.
-DB_PASSWORD_FILE=/home/marcusbettens/projects/dbpassword
-# Database host
-DB_HOST=localhost
-# Database port
-DB_PORT=5432
-# Database name
-DB_DATABASE=testdb17
-# Maximum pool size for database connections (per thread)
-POOL_SIZE=200
-# Database Script Folder
-DB_SCRIPT_FOLDER=/var/lib/sts/stsglobalresources/db-scripts
-# sudo mkdir /var/run/sts
-# sudo chown marcusbettens /var/run/sts 
-#PORT=/var/run/sts/stsrest01.sock
+NODE_ENV=production
+CONSOLE_LOG_ERRORS=true
+DB_USER=postgres-c
+DB_PASSWORD=password-c
+DB_PASSWORD_FILE=testpasswordfile
+DB_HOST=localhost-c
+DB_PORT=54320
+DB_DATABASE=stsrestmsdb01-c
+DATABASE_URL=-c
+DB_SCRIPT_FOLDER=/var/lib/sts/stsglobalresources/db-scripts-c
 
-PUBLISH_DEBUG=false
-PUBLISH_TIMEOUT=750
-PUBLISH_INTERVAL=1000
+POOL_SIZE=5000
+MAX_CPU=-10
+RESPAWN=true
+DEFAULT_DB_ENTRIES=100000
+USE_REDIS=true
+USE_L1_REDIS=true
+REDIS_END_FLUSH=true
+REDIS_PORT=63790
+REDIS_SERVER=localhost-c
+K6SCRIPTPATH=.-c
+DEFAULT_DATABASE_MIN_EXTRA_DATA_SIZE=1
+DEFAULT_DATABASE_MAX_EXTRA_DATA_SIZE=20000
 
-# STSRest01 service host and connection details
-REST01_ENDPOINT=http://localhost
-REST01_HOST_PORT=3003
-REST01_PORT=3003
-REST01_APIROOT=/stsrest01/v1
-REST01_EMAIL=K6TestUser@sts
-#REST01_PASSWORD=somepassword
-REST01_PASSWORD_FILE=/home/marcusbettens/projects/rest01passwordfile
-REST01_SERVICE_NAME=STSRest01
-REST01_SERVICE_VERSION=1.0.0
-REST01_PROM_SUPPORT=true
-REST01_PROM_CLUSTER_PORT=3013
+REST01_ENDPOINT=http://localhost-c
+REST01_HOST_PORT=30030
+REST01_PORT=30030
+REST01_APIROOT=/stsrest01/v1-c
+REST01_PROM_SUPPORT=false
+REST01_PROM_CLUSTER_PORT=30130
+REST01_SERVICE_NAME=STSRest01-c
+REST01_SERVICE_VERSION=1.0.0-c
+REST01_API_IDENTIFIER=xyz
+REST01_API_IDENTIFIER_FILE=testapiidentifierFile
+REST01_CLIENT_ID=xyz
+REST01_CLIENT_ID_FILE=testclientidfile
+REST01_CLIENT_SECRET=xyz
+REST01_CLIENT_SECRET_FILE=testclientsecretfile
 
-# STSInstrumentManager service host and connection details
-IM_ENDPOINT=http://localhost
-IM_HOST_PORT=3001
-IM_PORT=3001
-IM_APIROOT=/stsinstrumentmanager/v1
-IM_EMAIL=K6TestUser@sts
-#IM_PASSWORD=K6TestUserPassword
-IM_PASSWORD_FILE=/home/marcusbettens/projects/impasswordfile
-IM_SERVICE_NAME=STSInstrumentManager
-IM_SERVICE_VERSION=1.0.0
-IM_PROM_SUPPORT=true
-IM_PROM_CLUSTER_PORT=3011
+IM_ENDPOINT=http://localhost-c
+IM_HOST_PORT=30010
+IM_PORT=30010
+IM_APIROOT=/stsinstrumentmanager/v1-c
+IM_PROM_SUPPORT=false
+IM_PROM_CLUSTER_PORT=30110
+IM_SERVICE_NAME=STSInstrumentManager-c
+IM_SERVICE_VERSION=1.0.0-c
+IM_API_IDENTIFIER=xyz
+IM_API_IDENTIFIER_FILE=testapiidentifierFile
+IM_CLIENT_ID=xyz
+IM_CLIENT_ID_FILE=testclientidfile
+IM_CLIENT_SECRET=xyz
+IM_CLIENT_SECRET_FILE=testclientsecretfile
 
-# STSAuth service host and connection details
-AS_ENDPOINT=http://localhost
-AS_HOST_PORT=3002
-AS_PORT=3002
-AS_APIROOT=/stsauth/v1
-AS_EMAIL=K6TestUser@sts
-#AS_PASSWORD=K6TestUserPassword
-AS_PASSWORD_FILE=/home/marcusbettens/projects/aspasswordfile
-AS_SERVICE_NAME=STSAuth
-AS_SERVICE_VERSION=1.0.0
-AS_PROM_SUPPORT=true
-AS_PROM_CLUSTER_PORT=3012
+TO_ENDPOINT=http://localhost-c
+TO_HOST_PORT=30040
+TO_PORT=30040
+TO_APIROOT=/ststestorchestrator/v1-c
+TO_PROM_SUPPORT=false
+TO_PROM_CLUSTER_PORT=30140
+TO_SERVICE_NAME=STSTestOrchestrator-c
+TO_SERVICE_VERSION=1.0.0-c
+TO_API_IDENTIFIER=xyz
+TO_API_IDENTIFIER_FILE=testapiidentifierFile
+TO_CLIENT_ID=xyz
+TO_CLIENT_ID_FILE=testclientidfile
+TO_CLIENT_SECRET=xyz
+TO_CLIENT_SECRET_FILE=testclientsecretfile
 
-# STS Test Orchestrator service host and connection details
-TO_ENDPOINT=http://localhost
-TO_HOST_PORT=3004
-TO_PORT=3004
-TO_APIROOT=/ststestorchestrator/v1
-TO_EMAIL=K6TestUser@sts
-#TO_PASSWORD=somepassword
-TO_PASSWORD_FILE=/home/marcusbettens/projects/topasswordfile
-TO_SERVICE_NAME=STSTestOrchestrator
-TO_SERVICE_VERSION=1.0.0
-TO_PROM_SUPPORT=true
-TO_PROM_CLUSTER_PORT=3014
+AS_ENDPOINT=http://localhost-c
+AS_HOST_PORT=30020
+AS_PORT=30020
+AS_APIROOT=/stsauth/v1-c
+AS_API_IDENTIFIER=xyz
+AS_API_IDENTIFIER_FILE=testapiidentifierFile
+AS_PROM_SUPPORT=false
+AS_PROM_CLUSTER_PORT=30120
+AS_SERVICE_NAME=STSAuth-c
+AS_SERVICE_VERSION=1.0.0-c
+AS_CLIENT_ID=xyz
+AS_CLIENT_ID_FILE=testclientidfile
+AS_CLIENT_SECRET=xyz
+AS_CLIENT_SECRET_FILE=testclientsecretfile
+AS_JWKS_JSON_PATH=/.well-known/jwks.json-c
+AS_JWKS_KEY_ROTATION_TIME=864000
+AS_JWKS_KEY_PURGE_TIME_OFFSET=3000
+AS_JWKS_KEY_COUNT=40
+AS_ACCESS_TOKEN_EXPIRE=432000
+AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key-c
+AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key-c
 
-# STS Test Runner service host and connection details
-TR_EMAIL=K6TestUser@sts
-#TR_PASSWORD=somepassword
-TR_PASSWORD_FILE=/home/marcusbettens/projects/trpasswordfile
-TR_SERVICE_NAME=STSRestRunner
-TR_SERVICE_VERSION=1.0.0
-TR_PROM_SUPPORT=true
-TR_PROM_CLUSTER_PORT=3015
+TR_PROM_SUPPORT=false
+TR_PROM_CLUSTER_PORT=30150
+TR_SERVICE_NAME=STSRestRunner-c
+TR_SERVICE_VERSION=1.0.0-c
+TR_CLIENT_ID=xyz
+TR_CLIENT_ID_FILE=testclientidfile
+TR_CLIENT_SECRET=xyz
+TR_CLIENT_SECRET_FILE=testclientsecretfile
 
-# Auth Server public and private key paths
-AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key
-AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key
-
-# Node runtime environment
-NODE_ENV=debug
-# Default K6 test script path
-K6SCRIPTPATH=.
-# Redis server end point
-REDIS_SERVER=localhost
-# Redis server port
-REDIS_PORT=6379
-# Use redis for Microservice
-USE_REDIS=false
-# Use redis as a layer 1 cache
-USE_L1_REDIS=false
-# Automatically flush the redis cache when terminating the Microservice
-REDIS_END_FLUSH=false
-# Log error messages to the console within the microservice
-CONSOLE_LOG_ERRORS=false
-# Maximum number of CPUs (incl. logical processors) to use within the Microservice. 
-# Use -1 to use all available within the runtime container. Each CPU will spawn a node work thread.
-MAX_CPU=2
-# Automatically re-spawn a worker thread if one dies.
-RESPAWN=false
-# Default number of entries to create for a fresh database
-DEFAULT_DB_ENTRIES=10000
-# Default flag to automatically copy from the source RESFK_ records to the working set RESCP_ records
-# during initial fresh database creation.
-DEFAULT_DB_POPULATE=true
-# Default flag to automatically populate the redis cache (if enabled) with the current RESCP_ records
-# as they are being created. Only valid when DEFAULT_DB_POPULATE = true AND USE_REDIS = true.
-DEFAULT_REDIS_POPULATE=true
-# Default number of entries K6 should test against.
-DEFAULT_K6_ENTRIES=10000
-# Default microservice end-point for K6 tests.
-DEFAULT_K6_MS_HOST=localhost
-# Default microservice port for K6 tests.
-DEFAULT_K6_MS_PORT=3000
-# Default ratio (%) that each test should be an update rather than just a read.
-DEFAULT_K6_UPDATE_RATIO=2
-# Default ratio (%) that for an update, this update will actually be a delete. Only valid when
-# DEFAULT_K6_UPDATE_RATIO is > 0
-DEFAULT_K6_DELETE_RATIO=0
-# Default flag to always create a new record for each interation during K6 test runs. The new
-# record will contain a UUID for the ID to ensure uniqueness.
-DEFAULT_K6_ALWAYS_ADD=false
-# Default number of virtual CPUs to use on each testing node.
-DEFAULT_K6_VCPU=20
-# Default duration each test node should run the K6 test.
-DEFAULT_K6_DURATION=30s
-# ==================================================================================================
-# Production Settings
-# ==================================================================================================
-#PORT=3000
-#NODE_ENV=production
-#DATABASE_URL=postgresql://postgres:02740274@192.168.0.160:5432/testdb
-#REDIS_SERVER=192.168.0.160
-#REDIS_PORT=6379
-#USE_REDIS=true
-#REDIS_END_FLUSH=false
-#CONSOLE_LOG_ERRORS=false
-#
-# Only use for self signed certificates, otherwise remove from .env file
-#NODE_TLS_REJECT_UNAUTHORIZED=0
-#
-# To run PROD from command line
-# PORT=3000 NODE_ENV=production DATABASE_URL='postgresql://postgres:02740274@192.168.0.27:5432/testdb' node app
-#
-# To run DEV from command line
-# PORT=3000 NODE_ENV=debug DB_USER=postgres DB_PASSWORD=02740274 DB_HOST=192.168.0.27 DB_PORT=5432 DB_DATABASE=testdb node app
-
-MONITOR = false
-TRANSPORT = RESTAPI
-
-#MONITOR = true
-#TRANSPORT = RESTAPI
+PUBLISH_INTERVAL=10000
+PUBLISH_TIMEOUT=7500
+PUBLISH_DEBUG=true
+TRANSPORT=RESTAPI-c
+USE_SECURE_COOKIES=true
+KEEP_ALIVE=false
+MAX_SOCKETS=100
+MAX_TOTAL_SOCKETS=200
+MAX_FREE_SOCKETS=2560
+TIMEOUT=100000
+MAX_PAYLOAD_SIZE=50mb-c
+INSTRUMENTATION_OBSERVATION_INTERVAL=10000
+INSTRUMENTATION_TIME_WINDOW=6000
+AUTH_JWT_ACCESS_TOKEN_TIMEOUT=6000
+AUTH_JWT_REFRESH_TOKEN_TIMEOUT=864000
+AUTH_COOKIE_TIMEOUT=864000
+MASTER_PROCESS_EXIT_TIME=5000
+CHILD_PROCESS_EXIT_TIME=5000
+SYSTEM_INFORMATION_INTERVAL=10000
+IGNORE_SOCKETIO=false
+MODEL_PURGE_UPDATE_TIMEOUT=50000

package/.github/dependabot.yml

@@ -8,4 +8,4 @@ updates:
   - package-ecosystem: "npm" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "monthly"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsconfig",
-  "version": "1.12.0",
+  "version": "1.16.0",
   "description": "",
   "main": "stsconfig.js",
   "dependencies": {