Reference

Helm Chart Values

Command Lines

This section shows the command lines for all of the ModelOps servers.

Data Channel Registry

The data channel registry is a server that supports data channel discovery and provides an API for querying available data channels.

The data channel registry is shipped in <product-home>/distrib/tibco/modelops/bin/data-channel.jar

These command line options are supported:

  1. -d,--local-data <zero or more local data files> Operate the server outside a Kubernetes environment, with local data files, for API testing
  2. only
  3. -h,--help Display usage and exit
  4. -l,--logging <Logback configuration file> Set a non-default Logback configuration file to use for logging
  5. -n,--namespace <Kubernetes namespace name> Set a non-default Kubernetes namespace in which the server will operate. Default is no
  6. namespace, option with no argument discovers the namespace.
  7. -p,--listen-port <listen port number> Set a non-default listen port. Default value is 8080.
  8. -t,--request-response-tracing <"enable" | "disable"> Enable or disable request/response tracing
  9. -v,--version Display version and exit

The data channel registry can be started using:

  1. java -jar data-channel.jar

Metrics

The metrics server provides aggregated real-time access to metrics captured in Prometheus. It is a Streaming node hosting LiveView.

The metrics application is shipped as <product-home>/distrib/tibco/modelops/application/metric-application.zip

These substitution variables are supported.

Name Type Description Default
METRIC_DATA_MAX_AGE_MINUTES String Maximum metric age in minutes 5
METRIC_DATA_MAX_TABLE_SIZE_MEGABYTES String Maximum metric table size in megabytes 50
METRIC_DATA_POLLING_SECOND String Metric data polling interval in seconds 30
METRIC_METADATA_POLLING_SECOND String Meta-data polling interval in seconds 60
METRIC_PROMETHEUS_URL String Prometheus server URL http://localhost:9090
METRIC_SHARED_MEMORY_TYPE Enumeration Shared memory type - FILE or SYSTEM_V_SHARED_MEMORY FILE

The real-time metrics server can be started with default configuration values using:

  1. epadmin install node --application metric-application.zip --nodename A.metrics
  2. epadmin --servicename A.metrics start node
  3. epadmin --servicename A.metrics stop node
  4. epadmin --servicename A.metrics remove node

ModelOps

The ModelOps server supports artifact management and provides REST API to access all ModelOps functions.

The ModelOps server is shipped in <product-home>/distrib/tibco/modelops/bin/modelops-server.jar

These command line options are supported:

  1. -b,--backup <directory> backup the database and exit (backup file place in the directory)
  2. -c,--configuration <file> configuration file
  3. -f,--force remove records prior to restore (valid with restore only)
  4. -gs,--generate-secret extract the master secret from the keystore into a file and exit
  5. -h,--help display usage and exit
  6. -kf,--keystore-file <file> keystore file (valid and required for generate-secret only)
  7. -kp,--keystore-password <pass-phrase> keystore password (valid and required for generate-secret only)
  8. -l,--logging <file> change default logging configuration
  9. -ms,--master-secret <file> master secret file (valid and required for generate-secret only)
  10. -r,--restore <file> restores the database from the backup file and exit
  11. -s,--substitutions <name=value,...> substitution values
  12. -sf,--substitution-file <file> substitution file
  13. -t,--request-response-trace enable request/response tracing
  14. -v,--version display version and exit

The ModelOps server can be started using:

  1. java -jar modelops-server.jar

Scheduling

The Scheduling server provides support for starting jobs to execute scoring pipelines and data channels.

The Scheduling server is shipped in <product-home>/distrib/tibco/modelops/bin/scheduling-server.jar

These command line options are supported:

  1. -a,--admin-username <admin user name> Set the admin user name, defaults to admin
  2. -c,--cleanup-age <cleanup time in minutes> Set cleanup time of completed tasks, defaults to 60 minutes
  3. -g,--log-level <Log level> Set log level for the deployed scheduling job, defaults to INFO
  4. -h,--help Display usage and exit
  5. -l,--logging <Logback configuration file> Set a non-default Logback configuration file to use for logging
  6. -n,--namespace <Kubernetes namespace name> Set a non-default Kubernetes namespace in which the server will operate, defaults to current
  7. namespace
  8. -o,--local Operate the server outside a Kubernetes environment, with no scheduling, for API testing only
  9. -p,--listen-port <listen port number> Set a non-default listen port, defaults to 8090
  10. -r,--request-response-trace Enable request/response tracing
  11. -t,--session-timeout <session timeout in seconds> Set login session timeout in seconds, defaults to 3,600,000 seconds
  12. -v,--version Display version and exit

The Scheduling server can be started using:

  1. java -jar scheduling-server.jar

Scoring

The Scoring server supports model execution via model runners.

The Scoring server is shipped in <product-home>/distrib/tibco/modelops/bin/scoring-server.jar

These command line options are supported:

  1. -c,--configuration <file> configuration file
  2. -h,--help display usage and exit
  3. -r,--runners <path,...> model runner directories (default /opt/tibco/distrib/tibco/modelops/runner)
  4. -s,--substitutions <name=value,...> substitution values
  5. -sf,--substitution-file <file> substitution file
  6. -t,--request-response-trace enable request/response tracing
  7. -v,--version display version and exit

The Scoring server can be started using:

  1. java -jar scoring-server.jar