...
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 | ||
spring.cloud.config.uri | http://sccs:1234 | The uri of the spring cloud config server from whence to acquire configuration (MUST BE SET LOCALLY) | |||
spring.profiles.active | profile1,profile2,profile3 | The spring profiles that contain the desired configuration (MUST BE SET LOCALLY) | |||
modelop.runtime.group | MODELOP_RUNTIME_GROUP | modelop | The group name that owns the runtime. | ||
modelop.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 | ||
eureka.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 | |||
modelop.runtime.monitoring-package | false (default) | Set to ‘true’ to enable the monitoring package | |||
MODELOP_RUNTIME_PIP3_FREEZE | Set to ‘true’ to run pip freeze before and after installing python requirements attached to a model | ||||
MODELOP_RUNTIME_PIP3_UPGRADE | Set to ‘true’ to attempt to upgrade pip before installing python requirements attached to a model |
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.
application.json
...
language | json |
---|
...
modelop.runtime.in-production | false (default) | Informs the initial value of the Engine inProduction field | |
modelop.runtime.environment-name | Informs the initial value of the Engine environmentName field | ||
modelop.runtime.pre-3.0-startup | false (default) | Set to ‘true’ to use the older/deprecated mechanism for retrieving a deployed model upon runtime startup. Newer runtimes, by default, use an API on Model Manage that doesn’t exist on pre 3.0 versions. |
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.
application.json
Code Block | ||
---|---|---|
| ||
{ "sql-credentials": [ { "host": "sql-server-abc", "username": "my_user", "password": "my_password" }, { "host": "sql-other-server-def", "username": {"from_file": "/config/the-username"}, "password": {"from_env": "THE_ENV_VAR_WHERE_MY_PASSWORD_IS"} } ], "s3-credentials": { "storedCredentials": [ "password": "my_password"{ }, "path": "", { "hostauthenticationType": "sql-other-server-defBASIC", "usernameaccessKeyId" : {"frommy_filekey": "/config/the-username"},, "passwordsecretAccessKey": {"from_env": "THE_ENV_VAR_WHERE_MY_PASSWORD_IS"}my_secret" } } ], "s3-credentials": { ], "storedCredentialseksServiceAccountCredentials": [ { "path": "s3.us-east-2.amazonaws.com", "authenticationTyperoleArnEnvVariable" : "BASICTEST_ROLE_ARN", "accessKeyIdwebIdentityTokenFileEnvVariable" : "myTEST_TOKEN_keyFILE", "secretAccessKeysessionPrefix" : "my_secrettestprefixABC" } ] }, "azure-credentials": { "eksServiceAccountCredentialsstoredCredentials": [ { "pathaccount": "s3.us-east-2.amazonaws.commy_account", "roleArnEnvVariableauthenticationType" : "TESTSHARED_ROLE_ARNKEY", "webIdentityTokenFileEnvVariablepath" : "TEST_TOKEN_FILE", "sessionPrefixsharedKey" : "testprefixABCmysharedkey==" } ] } } |
The ‘sql-credentials’ section allows username and password credentials to be associated with specific sql database hosts. Credentials can be hardcoded directly in the config file, located in a file, or located in an environment variable.
...
Open the ModelOp Runtime to which you want to add endpoints
...
2. Select the “Create Endpoint” button for either the input or output endpoints
...
3. Select Click the button on the right to add either an Input endpoint , or Output endpoint. Choose either REST or Kafka:
...
REST Endpoints
Add a Name, optional Description, Encoding type, and optional port. Select “Save Endpoint”
...
Kafka endpoints require several fields, as detailed in the screenshot and table below.
...
Field | Type | Description | Example |
---|---|---|---|
Name |
| A user-supplied name for the endpoint | “MyKafkaEndpoint1” |
Description |
| A user-supplied description for the endpoint | “Kafka Endpoint for consumer transactions” |
Encoding |
| The encoding used for serialization/deserialization of the kafka messages | json |
BootstrapServers |
| The name and port of the Kafka bootstrap servers. | "kafka1:9002" |
Group (Consumer Group) (optional) |
| To provide a horizontally scalable solution, a Consumer Group can be used to allow load balancing of requests across multiple ModelOp runtimes. By defining a Consumer Group, ModelOp Center ensures that only one ModelOp runtime in the Consumer Group services a given message. | "fastscore-1" |
Principal (optional) |
| An authenticated user in a secure cluster | "kafka/kafka@REALM" |
Topic |
| The Kafka topic to consume or push to, depending on if input vs. output endpoint | "MyKafkaTopic" |
Keyfile (optional) |
| The location of the keytab file containing pairs of Kerberos principals and encrypted keys | "/fastscore.keytab" |
...