...
The engine is configured via two main mechanismsseveral mechanisms. The preferred mechanism is via spring configuration through spring cloud config server. There are also a number of (deprecated) environment variables that affect the behavior, as well as an application.json
file that can be configured with credentials the engine may need when interacting with external services.
Environment Variables
Spring Config | Deprecated Environment Variable | Example Values | Description | ||
---|---|---|---|---|---|
modelop.runtime.log-level | MODELOP_LOG_LEVEL | debug, info (default), warning, error | Log level of the engine | ||
modelop.gateway-url | MODELOP_GATEWAY_LOCATION | http://gateway:8090 gateway:8090 | The host:port of the MOC gateway | ||
spring.application.name | MODELOP_ENGINE_NAME | engine-3 | The name of the runtime that will be used to identify it in the registry | ||
modelop.runtime.group | MODELOP_RUNTIME_GROUP | modelop | The group name that owns the runtime. | ||
MODELOPmodelop.runtime.initial-tags | MODELOP_RUNTIME_INITIAL_TAGS | “tag1, tag2” | A comma separated list of runtime tags that MOC should apply to the engine when it is first discovered. | ||
server.port | MODELOP_API_PORT | 8003 (default) | The port that the runtime will listen on | ||
modelop.runtime.roundtrip-default-timeout | MODELOP_ROUNDTRIP_DEFAULT_TIMEOUT | 5000 (default) | The default timeout (in milliseconds) for roundtrip REST calls | ||
eureka.instance.ip-address | MODELOP_ENGINE_IP | 0.0.0.0 | The IP address the engine should use to identify itself to the registry | ||
eureka.instance.hostname | MODELOP_ENGINE_HOSTNAME | engine-3 | The hostname the engine should use to identify itself to the registry | ||
MODELOP_ENGINE_USE_HTTPS | true, false (default) | Indicates whether the engine uses SSL | |||
MODELOP_EUREKA_HOSTNAME | registry | The hostname of the registry | |||
MODELOP_EUREKA_PORT | 8761 (default) | The port on which the registry is listening | |||
MODELOP_RUNTIME_LOG_LOCATION | /tmp/logs | The directory where engine logs are stored | |||
MODELOP_LOGSTASH_LOCATION | logstash:8093 | The host:port where logstash messages should be sent. NOTE: the port is a UDP port, not a TCP port. | |||
MODELOP_RUNTIME_CONFIG_FILE | /config/application.json (default) | The location of the application.json config file | |||
MODELOP_REPORTING_SERVICE_MESSAGES_PATH | /reporting-service/messages (default) | The path on the configured gateway to send internal messages | |||
MODELOP_OAUTH_SERVER_URL | The URI of the oauth server (if present) | ||||
MODELOP_OAUTH_CLIENT_ID | moc-runtime | The OAuth client id (populates the ‘client_id’ header) | MODELOP_OAUTH_CLIENT_SECRET | The OAuth client secret (populates the ‘client_secret’) header) | MODELOP_OAUTH_SCOPE | The OAuth client scope (populates the ‘scope’ header) |
MODELOP_ENGINE_DEFAULT_LISTENER_IDLE_TIMEOUT | 60000 (default), infinity | Number of milliseconds (or ‘infinity’) to wait before timing out incoming REST calls on the default control port (the one specified by MODELOP_API_PORT) | |||
MODELOP_ENGINE_ROUNDTRIP_LISTENER_IDLE_TIMEOUT | 60000 (default), infinity | Just like MODELOP_ENGINE_DEFAULT_LISTENER_IDLE_TIMEOUT, but for the roundtrip REST listenereureka.instance.instanceId | The instance id to register with eureka (NOT TYPICALLY SET) | ||
eureka.instance.health-check-url | {hostname:port}/1/health | Health check url (NOT TYPICALLY SET) | |||
eureka.instance.home-page-url | {hostname:port}/ | Root api url (NOT TYPICALLY SET) | |||
eureka.instance.status-page-url | {hostname:port}/1/platforms | Status check url (NOT TYPICALLY SET) | |||
server.ssl.enabled | MODELOP_ENGINE_USE_HTTPS | true, false (default) | Indicates whether the engine uses SSL | ||
eureka.client.service-url.defaultZone | MODELOP_EUREKA_HOSTNAME and MODELOP_EUREKA_PORT | http://registry:8761 | url indicating the registry’s hostname and port | ||
MODELOP_EUREKA_HOSTNAME | registry | The hostname of the registry | |||
MODELOP_EUREKA_PORT | 8761 (default) | The port on which the registry is listening | |||
modelop.runtime.log-location | MODELOP_RUNTIME_LOG_LOCATION | /tmp/logs | The directory where engine logs are stored | ||
modelop.runtime.log-file-max-size | MODELOP_RUNTIME_LOG_FILE_MAX_SIZE | 2097152 | Max engine log file size | ||
logstash.location | MODELOP_LOGSTASH_LOCATION | logstash:8093 | The host:port where logstash messages should be sent. NOTE: the port is a UDP port, not a TCP port. | ||
modelop.runtime.config-file | MODELOP_RUNTIME_CONFIG_FILE | /config/application.json (default) | The location of the application.json config file | ||
reporting-service.websocket.url | MODELOP_REPORTING_SERVICE_MESSAGES_PATH | http://gateway:8090/reporting-service/messages | The url where internal messages should be sent | ||
MODELOP_REPORTING_SERVICE_MESSAGES_PATH | /reporting-service/messages (default) | The path on the configured gateway to send internal messages | |||
modelop.provider.token-uri | MODELOP_OAUTH_SERVER_URL | The URI of the oauth server (if present) | |||
modelop.runtime.client-id | MODELOP_OAUTH_CLIENT_ID | moc-runtime | The OAuth client id (populates the ‘client_id’ header) | ||
modelop.runtime.client-secret | MODELOP_OAUTH_CLIENT_SECRET | The OAuth client secret (populates the ‘client_secret’) header) | |||
modelop.runtime.scope | MODELOP_OAUTH_SCOPE | The OAuth client scope (populates the ‘scope’ header) | |||
modelop.runtime.default-listener-idle-timeout | MODELOP_ENGINE_DEFAULT_LISTENER_IDLE_TIMEOUT | 60000 (default), infinity | Number of milliseconds (or ‘infinity’) to wait before timing out incoming REST calls on the default control port (the one specified by MODELOP_API_PORT) | ||
modelop.runtime.roundtrip-listener-idle-timeout | MODELOP_ENGINE_ROUNDTRIP_LISTENER_IDLE_TIMEOUT | 60000 (default), infinity | Just like MODELOP_ENGINE_DEFAULT_LISTENER_IDLE_TIMEOUT, but for the roundtrip REST listener | ||
modelop.runtime.allow-dynamic-library-installation | true (default) | Whether or not to attempt to install libraries identified by assets with a role of REQUIRED_LIBRARIES | |||
modelop.runtime.max-input-file-size-bytes | MODELOP_RUNTIME_MAX_INPUT_FILE_SIZE_BYTES | 1048576000 | The max size of a file being used as an input to a batch job | ||
modelop.runtime.log-input-to-stomp | false (default) | Whether or not to log input records to the STOMP queue | |||
modelop.runtime.log-output-to-stomp | false (default) | Whether or not to log output records to the STOMP queue | |||
modelop.runtime.odbc-enable-bulk-inserts | MODELOP_ODBC_ENABLE_BULK_INSERTS | true (default) | Whether or not to convert individual insert commands into bulk insert commands | ||
modelop.runtime.s3-credentials.stored-credentials |
| A list of credentials | |||
modelop.runtime.s3-credentials.eks-service-account-credentials |
| A list of credentials | |||
modelop.runtime.s3-https-proxy | MODELOP_S3_HTTPS_PROXY | proxy_host:port | The https proxy to use when talking to s3 | ||
modelop.runtime.s3-http-proxy | MODELOP_S3_HTTP_PROXY | proxy_host:port | The http proxy to use when talking to s3 | ||
modelop.runtime.sts-https-proxy | MODELOP_AWS_STS_HTTPS_PROXY | proxy_host:port | The https proxy to use when talking to sts | ||
modelop.runtime.sts-http-proxy | MODELOP_AWS_STS_HTTP_PROXY | proxy_host:port | The http proxy to use when talking to sts | ||
modelop.runtime.sql-credentials |
| A list of credentials |
moc-builder
When leveraging moc-builder
to generate a MOC environment, your environment’s config/config.json
file can be updated with the desired values for the aforementioned environment variables. A subsequent compose
command will use the values in the config.json
when building kubernetes manifests.
...