Environment variables

Use this reference to understand environment variables across all Instabase services.

API-SERVER

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

AUTH_TYPE

  • Indiciate the type of authentication to use for user login. Valid values: [basic, saml, ldap]

  • Affected services: [webapp api-server]

  • Tags: [authentication]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BUILD_TIMESTAMP

  • The time the release was built at.

  • Affected services: [apps-server webapp api-server]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DEFAULT_OCR_PROVIDER

  • Affected services: [apps-server api-server celery-app-tasks]

  • Tags: [process-files, ocr]

ENABLE_APP_TASKS_PDF_UTILS

  • Enables pdf processing in app-tasks, replaces the original pdf-service processing.

  • Affected services: [api-server celery-app-tasks]

  • Tags: [pdf-processing, app-tasks, pdf-service]

ENABLE_CLIENT_SIDE_ENCRYPTION

  • Enable client-side encryption across all Instabase drives by default.

  • Affected services: [apps-server webapp api-server]

  • Tags: [file-system, encryption]

ENABLE_CORS

  • Enable CORS policy for external requests to api-server and api-server-apps.

  • Affected services: [api-server]

ENABLE_CUSTOM_HTTP_ENDPOINTS

  • Enable custom HTTP endpoints feature

  • Affected services: [api-server]

  • Tags: [api-server-apps, custom-http-endpoints]

  • Internal config to enable Document Search functionality on the platform (feature is in development).

  • Affected services: [core-platform-service file-tservice api-server search-tservice]

ENABLE_FAST_READER

  • If true, the reader app uses the fast-reader code.

  • Affected services: [api-server]

  • Tags: [reader]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

ENABLE_PROCESS_FILES_SPLIT

  • Split process files task into child tasks to process chunks of a file in parallel.

  • Affected services: [api-server celery-app-tasks]

  • Tags: [process-files]

ENABLE_PROJECT_BUILDER

  • Feature flag that defaults apps to using and expecting projects

  • Affected services: [apps-server webapp api-server]

  • Tags: [flow]

ENABLE_PUBLIC_REPOS

  • Enable public repos which are accessible to everyone without logging in.

  • Affected services: [core-platform-service apps-server api-server]

ENABLE_RAY_MODEL_TRAINING

  • If true, model training requests goes to the Ray cluster otherwise to the Model Training Tasks

  • Affected services: [api-server]

  • Tags: [model-training]

ENABLE_READER_BINARY

  • If true, the reader app uses flow binary to process the documents.

  • Affected services: [api-server]

  • Tags: [reader]

ENABLE_VALIDATIONS_APP

  • Feature flag that defaults Flow Editor to generate a .ibvalidations file whenever a new checkpoint module is created.

  • Affected services: [api-server]

  • Tags: [flow]

ENABLE_WEAVIATE_HA_CLIENT

  • flag to enable HA for weaviate client.

  • Affected services: [api-server model-service]

ENABLE_Z_PAGES

  • Enable z-pages which expose the internal state of a service to aid debugging.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

ENHANCE_RESPONSE_LOGS_ENABLED

  • Generate enhanced response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

FETCH_FILES_STEP_TIMEOUT

  • Configures the maximum time allowed for the Fetcher step to run before timing out the request (in seconds).

  • Affected services: [api-server celery-webdriver-tasks]

  • Tags: [fetcher]

FLOW_DATASTORE_SYNC_PREFIX

  • Configures the cache prefix for Flow Datastore during execution of Flow synchronous APIs.

  • Affected services: [api-server model-service celery-app-tasks]

  • Tags: [flow]

FORCE_LOGIN_USERNAME_EMAIL_TO_LOWERCASE

  • If set true, username and email will converted to lower cases when creating the account

  • Affected services: [webapp api-server]

  • Tags: [webapp]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_MESSAGE_LENGTH_MB

  • Maximum message size that a GRPC channel can receive (in megabytes).

  • Affected services: [api-server ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GUNICORN_MAX_REQUESTS

  • Specify the max. number of requests a Gunicorn worker will process before restarting (default is 250)

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_THREADS_COUNT

  • Set the number of threads per Gunicorn worker (default is 50). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_WORKERS_COUNT

  • Set the number of Gunicorn workers to run (default is 3). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

IGNORE_TRACING_HEADERS

  • Whether backend should ignore tracing headers sent by frontend or not. Valid values are: [true, false].

  • Affected services: [api-server]

  • Tags: [Kubernetes]

INSTABASE_HOSTNAME

  • The Instabase URL hostname (e.g. instabase.com).

  • Affected services: [license-service apps-server webapp api-server server-nginx]

INSTABASE_TEST_ONLY

  • Used only for Instabase’s internal testing.

  • Affected services: [api-server]

INSTALLM_API_KEY

  • The API key for InstaLLM.

  • Affected services: [api-server model-service]

JAEGER_BACKEND

  • The URL endpoint for the Jaeger webpage for tracing information.

  • Affected services: [api-server server-nginx]

  • Tags: [tracing, nginx, api-server-apps]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

LOG_RESPONSE_DATA_ENABLED

  • Enable response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBITMQ_CONSOLE_PASS

  • Password for RABBITMQ_CONSOLE_USER accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_CONSOLE_URL

  • Rabbit MQ console backend URL with port

  • Affected services: [api-server]

  • Tags: [rabbit-mq]

RABBITMQ_CONSOLE_USER

  • Username for accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

REDIS_CONFIGURATION_API_HOST

  • Host at which the redis configuration API can be reached at.

  • Affected services: [api-server]

  • Tags: [control-plane, redis-persistent]

REDIS_CONFIGURATION_API_PORT

  • Port at which the redis configuration API can be reached at.

  • Affected services: [api-server]

  • Tags: [control-plane, redis-persistent]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_CONVERSION_HOST

  • Hostname for conversion-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_CONVERSION_PORT

  • Port for conversion-service.

  • Affected services: [api-server conversion-service celery-app-tasks]

SERVICE_IMAGE_HOST

  • Hostname for image-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_IMAGE_PORT

  • Port for image-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_JOB_HOST

  • Hostname for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_JOB_PORT

  • Port for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_KEY_HOST

  • Hostname for key-service.

  • Affected services: [api-server]

SERVICE_KEY_PORT

  • Port for key-service.

  • Affected services: [file-tservice api-server]

SERVICE_LICENSE_HOST

  • Hostname for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_PORT

  • Port for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_MODEL_HOST

  • Hostname for model-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_MODEL_PORT

  • Port for model-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_MOUNT_HOST

  • Hostname for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_MOUNT_PORT

  • Port for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_SEARCH_HOST

  • Hostname for search-service.

  • Affected services: [api-server]

SERVICE_SEARCH_PORT

  • Port for search-service.

  • Affected services: [api-server]

SERVICE_TABLE_HOST

  • Hostname for table-service.

  • Affected services: [core-platform-service apps-server webapp api-server]

SERVICE_TABLE_PORT

  • Port for table-service

  • Affected services: [core-platform-service table-tservice apps-server webapp api-server]

SERVICE_WEAVIATE_HOST

  • Hostname for weaviate.

  • Affected services: [api-server model-service]

SERVICE_WEAVIATE_PORT

  • Port for weaviate.

  • Affected services: [api-server model-service]

SESSION_AUTO_TIMEOUT_MINUTES

  • If USE_SESSION_AUTO_TIMEOUT is true, this specifies the duration a user session will stay active before the session expires.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]

SESSION_SECRET_KEY

  • The key used to sign generated session keys for user login.

  • Affected services: [core-platform-service apps-server webapp api-server]

SITE_SETTING_DISABLE_SIGNUP

  • A site-wide configuration option to disallow account signup.

  • Affected services: [apps-server webapp api-server]

SITE_SETTING_REQUIRE_MFA

  • A site-wide configuration option to require users to login with MFA.

  • Affected services: [core-platform-service apps-server api-server]

SITE_SETTING_REQUIRE_TOTP

  • A site-wide configuration option to require Authenticator App as the only MFA option.

  • Affected services: [core-platform-service apps-server api-server]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_HTTP_ENABLED

  • Enable http stats collection for web services.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_THRIFT_BUCKET_DISTRIBUTION_MULTIPLIER

  • Multiplier used for constructing histogram buckets for capturing stats data for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_ENABLED

  • Enable stats collection for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_MESSAGE_SIZE_ENABLED

  • Enable stats collection for request/response size for Thrift service

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

USE_GUNICORN

  • Enable Gunicorn to serve Flask apps instead of Gevent. USE_GEVENT needs to be False when USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

USE_NTBK

  • Whether or not Jupyter notebooks are enabled. This flag also determines if CSRF is used.

  • Affected services: [apps-server webapp api-server]

  • Tags: [notebook]

USE_SESSION_AUTO_TIMEOUT

  • Flag to indicate whether or not user sessions should expire after SESSION_AUTO_TIMEOUT_MINUTES and force users to re-login.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

APPS-SERVER

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BUILD_TIMESTAMP

  • The time the release was built at.

  • Affected services: [apps-server webapp api-server]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DEFAULT_OCR_PROVIDER

  • Affected services: [apps-server api-server celery-app-tasks]

  • Tags: [process-files, ocr]

DYNAMIC_PROXY_API_URL

  • Specify the API endpoint for dynamic-proxy and allows dynamic-proxy to update the routes for a given user in the Redis cache.

  • Affected services: [apps-server]

  • Tags: [notebook]

EMAIL_PROVIDER

  • Specify the email provider to use. Valid values are: [SMTP, SES]

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP, SES]

ENABLE_CLIENT_SIDE_ENCRYPTION

  • Enable client-side encryption across all Instabase drives by default.

  • Affected services: [apps-server webapp api-server]

  • Tags: [file-system, encryption]

ENABLE_CSP

  • Enables the Content Security Policy header to block XSS attacks in webapp and apps-server

  • Affected services: [apps-server webapp]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

ENABLE_MARKETPLACE_CONSOLIDATION

  • Enable publishing and viewing ibsolution, models and Python packages in the Marketplace app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_ANNOTATION_ANALYSIS

  • Enable annotation analysis in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_INCREMENTAL_TRAINING

  • Enable evaluation and incremental training of models in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_LIST

  • Enable annotation of lists in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_MODEL_PRUNING

  • Enable model pruning in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_TABLE

  • Enable annotation and extraction of tables in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_ML_STUDIO_TEXT_MULTIPLE_INSTANCES

  • Enable the “Text (Multiple instances)” field type in Machine Learning Studio app.

  • Affected services: [apps-server]

ENABLE_PACKAGE_ACCELERATORS

  • Enable viewing and importing Package Accelerators from within Solution Builder app.

  • Affected services: [apps-server]

ENABLE_PROJECT_BUILDER

  • Feature flag that defaults apps to using and expecting projects

  • Affected services: [apps-server webapp api-server]

  • Tags: [flow]

ENABLE_PUBLIC_REPOS

  • Enable public repos which are accessible to everyone without logging in.

  • Affected services: [core-platform-service apps-server api-server]

  • Feature flag to enable the Spotlight search features in the UI.

  • Affected services: [apps-server webapp]

ENABLE_SOLUTION_ACCELERATORS

  • Enable viewing and importing a Solution Accelerator into a Solution Builder project.

  • Affected services: [apps-server]

ENABLE_TEXT_EDITOR_DEBUG

  • Enables the debugging tool in text editor.

  • Affected services: [apps-server]

ENABLE_Z_PAGES

  • Enable z-pages which expose the internal state of a service to aid debugging.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

ENHANCE_RESPONSE_LOGS_ENABLED

  • Generate enhanced response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GUNICORN_MAX_REQUESTS

  • Specify the max. number of requests a Gunicorn worker will process before restarting (default is 250)

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_THREADS_COUNT

  • Set the number of threads per Gunicorn worker (default is 50). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_WORKERS_COUNT

  • Set the number of Gunicorn workers to run (default is 3). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

INSTABASE_HOSTNAME

  • The Instabase URL hostname (e.g. instabase.com).

  • Affected services: [license-service apps-server webapp api-server server-nginx]

INSTABASE_URI

  • The Instabase URI hostname (e.g. instabase.com) to be used as the root URLs in API requests.

  • Affected services: [file-tservice license-service apps-server webapp]

  • Tags: [scheduler]

INSTABASE_URI_SCHEME

  • The instabase URI schema (e.g. http, https) to be used as the prefix for URLs in API requests.

  • Affected services: [license-service apps-server]

  • Tags: [scheduler]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

LOG_RESPONSE_DATA_ENABLED

  • Enable response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

NB_API_IGNORE_CERT_VERIFICATION

  • Used when setting up Jupyter Notebooks without using the default kubectl proxy to talk to the Kubernetes server, and instead relies on a custom sidecar for generating tokens for Kubernetes API server authentication. This will be used by apps-server and nb-reaper to talk to the Kubernetes API server to startup/take down Notebook pods. Set this to skip validating the Kubernetes API server certficate.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_API_TOKEN_FILEPATH

  • Used when setting up Jupyter Notebooks without using the default kubectl proxy to talk to the Kubernetes server, and instead relies on a custom sidecar for generating tokens for Kubernetes API server authentication. This will be used by apps-server and nb-reaper to talk to the Kubernetes API server to startup/take down Notebook pods. If NB_USE_API_TOKEN=True, this specifies the file path to read the generated authentication token.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_CA_CERT_BUNDLE_FILEPATH

  • Used when setting up Jupyter Notebooks without using the default kubectl proxy to talk to the Kubernetes server, and instead relies on a custom sidecar for generating tokens for Kubernetes API server authentication. This will be used by apps-server and nb-reaper to talk to the Kubernetes API server to startup/take down Notebook pods. If NB_API_IGNORE_CERT_VERIFICATION=false, and NB_USE_CA_CERT_BUNDLE=true this specifies the file path to the Root CA cert to validate the server-side certificate on the Kubernetes API server.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_DOMAIN

  • The domain for Notebooks.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_IMAGE

  • The docker image tag for the Notebook image.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_KUBE_PROXY_HOST

  • If using kubectl proxy, this defaults to the hostname of the proxy (e.g. localhost). If not using kubectl proxy, specify the hostname for the Kubernetes API server

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_KUBE_PROXY_PORT

  • If using kubectl proxy, this defaults to the port to the proxy (e.g. 8001). If not using kubectl proxy, specify the port for the Kubernetes API server

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_KUBE_PROXY_URL_SCHEME

  • If using kubectl proxy, the URL scheme is http. If connecting directly to Kubernetes API server, in all likelihood, the scheme will be https.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_NAMESPACE

  • The Kubernetes namespace for running Jupyter Notebooks.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_POD_CPU_LIMIT

  • Specify the Kubernetes CPU limit for each Jupyter Notebook pod.

  • Affected services: [apps-server]

  • Tags: [notebook, kubernetes]

NB_POD_CPU_REQUEST

  • Specify the Kubernetes CPU request amount for each Jupyter Notebook pod.

  • Affected services: [apps-server]

  • Tags: [notebook, kubernetes]

NB_POD_MEMORY_LIMIT

  • Specify the Kubernetes memory limit for each Jupyter Notebook pod.

  • Affected services: [apps-server]

  • Tags: [notebook, kubernetes]

NB_POD_MEMORY_REQUEST

  • Specify the Kubernetes memory request amount for each Jupyter Notebook pod.

  • Affected services: [apps-server]

  • Tags: [notebook, kubernetes]

NB_TYPE

  • Specify the Notebook type. Valid values: [standalone, with-mounted-disk]

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_USE_API_TOKEN

  • Used when setting up Jupyter Notebooks without using the default kubectl proxy to talk to the Kubernetes server, and instead relies on a custom sidecar for generating tokens for Kubernetes API server authentication. This will be used by apps-server and nb-reaper to talk to the Kubernetes API server to startup/take down Notebook pods. Set this to true to indicate that an API token will be generated to the file path specified by NB_API_TOKEN_FILEPATH.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_USE_CA_CERT_BUNDLE

  • Used when setting up Jupyter Notebooks without using the default kubectl proxy to talk to the Kubernetes server, and instead relies on a custom sidecar for generating tokens for Kubernetes API server authentication. This will be used by apps-server and nb-reaper to talk to the Kubernetes API server to startup/take down Notebook pods. If NB_API_IGNORE_CERT_VERIFICATION=false, set this to true to enable reading the Root CA cert from NB_CA_CERT_BUNDLE_FILEPATH.

  • Affected services: [apps-server]

  • Tags: [notebook]

NB_VERIFY_SSL_CERTS

  • Specify whether to verify SSL certs for Jupyter Notebook connections.

  • Affected services: [apps-server]

  • Tags: [notebook]

NO_REPLY_EMAIL_ADDRESS

  • For emails origination from the platform, the no-reply email address to send from.

  • Affected services: [apps-server webapp celery-app-tasks]

  • Tags: [email]

NUMBER_OF_CHUNKS_TO_CACHE

  • Number of chunks to cache in an ibdoc for a paginated load_record API call.

  • Affected services: [apps-server]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SELENIUM_HUB_RESOLVE_IP

  • Configures the Fetcher app’s connection to Selenium Hub - whether the IP address should be resolved.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SELENIUM_HUB_URL

  • Configures the Fetcher app’s connection to Selenium Hub - the URL to the server.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_JOB_HOST

  • Hostname for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_JOB_PORT

  • Port for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_HOST

  • Hostname for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_PORT

  • Port for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_MOUNT_HOST

  • Hostname for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_MOUNT_PORT

  • Port for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_TABLE_HOST

  • Hostname for table-service.

  • Affected services: [core-platform-service apps-server webapp api-server]

SERVICE_TABLE_PORT

  • Port for table-service

  • Affected services: [core-platform-service table-tservice apps-server webapp api-server]

SESSION_AUTO_TIMEOUT_MINUTES

  • If USE_SESSION_AUTO_TIMEOUT is true, this specifies the duration a user session will stay active before the session expires.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]

SESSION_SECRET_KEY

  • The key used to sign generated session keys for user login.

  • Affected services: [core-platform-service apps-server webapp api-server]

SES_ACCESS_KEY_ID

  • If the EMAIL_PROVIDER=ses, then specify the AWS Access Key ID for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_REGION_NAME

  • If the EMAIL_PROVIDER=ses, then specify the AWS Region for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_SECRET_ACCESS_KEY

  • If the EMAIL_PROVIDER=ses, then specify the AWS Secret Access Key for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SITE_SETTING_DISABLE_SIGNUP

  • A site-wide configuration option to disallow account signup.

  • Affected services: [apps-server webapp api-server]

SITE_SETTING_REQUIRE_MFA

  • A site-wide configuration option to require users to login with MFA.

  • Affected services: [core-platform-service apps-server api-server]

SITE_SETTING_REQUIRE_TOTP

  • A site-wide configuration option to require Authenticator App as the only MFA option.

  • Affected services: [core-platform-service apps-server api-server]

SMTP_HOSTNAME

  • If the EMAIL_PROVIDER=smtp, then specify the hostname of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SMTP_PORT

  • If the EMAIL_PROVIDER=smtp, then specify the port of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SQS_ACCESS_KEY_ID

  • If USE_SQS=true, then specify the AWS Access Key ID for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_IN_QUEUE

  • If USE_SQS=true, then specify the name of the AWS SQS in queue.

  • Affected services: [apps-server]

  • Tags: [SQS]

SQS_OUT_QUEUE

  • If USE_SQS=true, then specify the name of the AWS SQS out queue.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_POLL_MAX_MSGS

  • If USE_SQS=true, this sets the maximum number of messages to retrieve from the AWS SQS receive queue.

  • Affected services: [apps-server]

  • Tags: [SQS]

SQS_POLL_PERIOD

  • If USE_SQS=true, this sets the poll period for (in seconds) on the AWS SQS for checking for messages on the receive queue.

  • Affected services: [apps-server]

  • Tags: [SQS]

SQS_POLL_WAIT_PERIOD

  • If USE_SQS=true, this sets the poll wait period (in seconds) on the AWS SQS receive queue. This is the duration the call will wait for a message to arrive in the queue before returning.

  • Affected services: [apps-server]

  • Tags: [SQS]

SQS_QUEUE_TYPE

  • If USE_SQS=true, then specify the AWS SQS queue type.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_REGION_NAME

  • If USE_SQS=true, then specify the AWS Region for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_SECRET_ACCESS_KEY

  • If USE_SQS=true, then specify the AWS Secret Access Key for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_HTTP_ENABLED

  • Enable http stats collection for web services.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_THRIFT_BUCKET_DISTRIBUTION_MULTIPLIER

  • Multiplier used for constructing histogram buckets for capturing stats data for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_ENABLED

  • Enable stats collection for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_MESSAGE_SIZE_ENABLED

  • Enable stats collection for request/response size for Thrift service

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

SYSTEM_ALERT_EMAIL_ADDRESS

  • The email address for syending system alerts to.

  • Affected services: [apps-server]

  • Tags: [email]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

USE_CPP_IBDOC_CONVERSION

  • Disable python conversion of .ibdoc to JSON and uses cpp module for .ibdoc conversion.

  • Affected services: [apps-server webapp]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

USE_GUNICORN

  • Enable Gunicorn to serve Flask apps instead of Gevent. USE_GEVENT needs to be False when USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

USE_NTBK

  • Whether or not Jupyter notebooks are enabled. This flag also determines if CSRF is used.

  • Affected services: [apps-server webapp api-server]

  • Tags: [notebook]

USE_SESSION_AUTO_TIMEOUT

  • Flag to indicate whether or not user sessions should expire after SESSION_AUTO_TIMEOUT_MINUTES and force users to re-login.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]

USE_SQS

  • Configures whether to use SQS for sending messages.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

CELERY-APP-TASKS

ACRA_FETCHER_DEADLINE

  • Configures the Fetcher app’s timeout for fetching information from ACRA.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

APPLY_REFINER_CHUNK_THRESHOLD_PAGES

  • Defines the maximum number of pages to include in a chunk while chunking for Apply Refiner flow step.

  • Affected services: [celery-app-tasks]

  • Tags: [refiner]

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CLASSIFIER_APP_EXECUTION_TIMEOUT

  • The maximum time in seconds a Classifier training task runs for. If a task runs for longer than this time, it will terminate.

  • Affected services: [celery-app-tasks]

  • Tags: [Classifier]

CONTROL_PLANE_API_TOKEN

  • The API token to validate control plane api requests against.

  • Affected services: [celery-app-tasks]

  • Tags: [control-plane]

CONTROL_PLANE_HOST

  • Hostname for control plane.

  • Affected services: [celery-app-tasks]

CONTROL_PLANE_PORT

  • Port for control plane.

  • Affected services: [celery-app-tasks]

DATASETS_DELETE_FILES_NUM_WORKERS

  • When deleting files from a dataset, the number of parallel workers to delete files.

  • Affected services: [celery-app-tasks]

  • Tags: [datasets]

DEFAULT_OCR_PROVIDER

  • Affected services: [apps-server api-server celery-app-tasks]

  • Tags: [process-files, ocr]

EMAIL_PROVIDER

  • Specify the email provider to use. Valid values are: [SMTP, SES]

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP, SES]

ENABLE_APPLY_REFINER_CHUNKING

  • Enable chunking for Apply Refiner flow step.

  • Affected services: [celery-app-tasks]

  • Tags: [refiner]

ENABLE_APP_TASKS_IMAGE_AND_TEXT_UTILS

  • Enables image rendering and text extraction for pdf processing in app-tasks, replaces the original pdf-service processing.

  • Affected services: [celery-app-tasks]

  • Tags: [pdf-processing, app-tasks, pdf-service]

ENABLE_APP_TASKS_PDF_UTILS

  • Enables pdf processing in app-tasks, replaces the original pdf-service processing.

  • Affected services: [api-server celery-app-tasks]

  • Tags: [pdf-processing, app-tasks, pdf-service]

ENABLE_CELERY_EVENTS

  • Enables the task events in celery services.

  • Affected services: [celery-app-tasks]

  • Tags: [stats]

ENABLE_CONVERSION_SERVICE

  • Enable conversion-service for Microsoft document conversion (e.g. docx, xlsx, pptx).

  • Affected services: [celery-app-tasks]

ENABLE_HEALTH_CHECK

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [kubernetes]

ENABLE_IBDOC_V2

  • Enable new ibdoc v2 structuring where ibdoc is split & stored across multiple files

  • Affected services: [celery-app-tasks]

  • Tags: [process-files, map-records, app-tasks, model-training, reader]

ENABLE_IMAGE_SERVICE

  • Enable image-service functionality in ocr-service for image-processing functionality.

  • Affected services: [ocr-service celery-app-tasks]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

ENABLE_PROCESS_FILES_SPLIT

  • Split process files task into child tasks to process chunks of a file in parallel.

  • Affected services: [api-server celery-app-tasks]

  • Tags: [process-files]

ENABLE_PROCESS_FILES_SPLIT_FOR_NON_PDF_FILES

  • For non pdf files, split process files task into child tasks to process chunks of a file in parallel.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

ENABLE_READER_PAGE

  • If enabled, compact reader page proto representation is used to save app-tasks memory and network traffic.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files, app-tasks]

ENABLE_RUN_EXTRACTION_MODEL_CHUNKING

  • Enable chunking for Run Extraction Model flow step.

  • Affected services: [celery-app-tasks]

  • Tags: [run-extraction-model]

ENABLE_TEXTBOXDETECTION_SERVICE

  • Enable textboxdetection-service for Extracting text bounding boxes from images.

  • Affected services: [celery-app-tasks]

FILENET_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to FileNet - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

FILENET_GATEWAY_URL

  • Configures the Fetcher app’s connection to FileNet - the Gateway URL of FileNet.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

FILENET_SERVER_URL

  • Configures the Fetcher app’s connection to FileNet - The Server URL of FileNet.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

FLOW_DATASTORE_SYNC_PREFIX

  • Configures the cache prefix for Flow Datastore during execution of Flow synchronous APIs.

  • Affected services: [api-server model-service celery-app-tasks]

  • Tags: [flow]

GCLOUD_API_KEY

  • The API key for Google Cloud Services Sentiment Analysis.

  • Affected services: [ocr-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [nlp]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

KAFKA_BROKER_STR

  • Containes the URL for kafka broker(s).

  • Affected services: [celery-app-tasks]

LOGGING_EXPORT_ENDPOINT

  • The export endpoint for flow logs to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MAS_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to MASNet - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

MAX_LOG_LINE_LENGTH

  • The maximum number of characters that a log line can have before it is truncated.

  • Affected services: [celery-app-tasks]

MAX_MEMORY_PER_CHILD_KB

  • Maximum amount of resident memory (in kb) a worker can execute before it’s replaced by a new process.

  • Affected services: [celery-app-tasks]

MAX_TASKS_PER_CHILD

  • Maximum number of tasks processed by a celery-worker before it is replaced

  • Affected services: [celery-app-tasks ray-model-training-worker]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

MSFT_OCR_API_KEY

  • The API key used when using Microsoft OCR services.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

MSFT_OCR_ENDPOINT_LITE

  • The endpoint url called when using Marx OCR v3 Lite.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

MSFT_OCR_ENDPOINT_V3

  • The endpoint url called when using Marx OCR v3.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

MSFT_OCR_LAYOUT_ENDPOINT

  • The endpoint url called when using Microsoft Form Recognizer Layout OCR.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

MSFT_OCR_V3_USE_CONTAINER

  • Marx OCR v3 will use cluster local container or online Azure service. Valid values true|false.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

MSFT_TRANSLATE_API_KEY

  • The API key for using Microsoft Translation Service on Azure cloud.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

MSFT_TRANSLATE_API_REGION

  • The Azure cloud region used for Microsoft Translation Service.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

MSFT_TRANSLATE_ENDPOINT

  • The endpoint url called when using Microsoft Translation Service.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

NO_REPLY_EMAIL_ADDRESS

  • For emails origination from the platform, the no-reply email address to send from.

  • Affected services: [apps-server webapp celery-app-tasks]

  • Tags: [email]

NUM_EXECUTORS

  • The number of celery workers to run in each app-tasks pod.

  • Affected services: [job-service celery-app-tasks]

  • Tags: [celery]

NUM_PARALLEL_ENTITY_REQUESTS

  • Max number of Entity requests that will be sent in parallel for a single document.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

NUM_PARALLEL_OCR_REQUESTS

  • Max number of ocr requests that will be sent in parallel for a single document.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, process-files]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

OCR_ARI_PROVIDER

  • The provider to use for ARI OCR. This should be set to ocr-service, as other providers are deprecated.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr]

OCR_GOOG_PROVIDER

  • The provider to use for Google OCR. Valid values are ocr-service and ocr-goog-direct.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr]

OCR_GOTT_HOST

  • The endpoint for Google OCR.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr]

OCR_MSFT_PROVIDER

  • The provider for Msft OCR. Valid values are ocr-msft-sync and ocr-msft-async.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr]

ORBIS_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to Orbis - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

PROCESS_FILES_SPLIT_SIZE_PAGES

  • Defines the split size of the pdf during process files step.

  • Affected services: [celery-app-tasks]

  • Tags: [process-files]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

READER_PAGES_TOPIC

  • The name of pdf-service’s kafka topic.

  • Affected services: [celery-app-tasks]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

RETRY_MSFT_ERROR

  • If true, retry msft 200 status responses with failed status in the message, otherwise fail the request.

  • Affected services: [celery-app-tasks]

  • Tags: [ocr, ocr-msft-v3, ocr-msft-lite]

RUN_EXTRACTION_MODEL_CHUNK_THRESHOLD_PAGES

  • Defines the maximum number of pages to include in a chunk while chunking for Run Extraction Model flow step.

  • Affected services: [celery-app-tasks]

  • Tags: [run-extraction-model]

SELENIUM_HUB_RESOLVE_IP

  • Configures the Fetcher app’s connection to Selenium Hub - whether the IP address should be resolved.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SELENIUM_HUB_URL

  • Configures the Fetcher app’s connection to Selenium Hub - the URL to the server.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_APISERVER_HOST

  • Hostname for api-server.

  • Affected services: [job-service celery-app-tasks]

SERVICE_APISERVER_PORT

  • Port for api-server.

  • Affected services: [job-service celery-app-tasks]

SERVICE_CONVERSION_HOST

  • Hostname for conversion-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_CONVERSION_PORT

  • Port for conversion-service.

  • Affected services: [api-server conversion-service celery-app-tasks]

SERVICE_DATABASE_HOST

  • Hostname for grpc database service.

  • Affected services: [job-service celery-app-tasks]

SERVICE_DATABASE_PORT

  • Port for grpc database service.

  • Affected services: [job-service celery-app-tasks]

SERVICE_IMAGE_HOST

  • Hostname for image-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_IMAGE_PORT

  • Port for image-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_JOB_HOST

  • Hostname for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_JOB_PORT

  • Port for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_HOST

  • Hostname for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_PORT

  • Port for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_MODEL_HOST

  • Hostname for model-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_MODEL_PORT

  • Port for model-service.

  • Affected services: [api-server celery-app-tasks]

SERVICE_MOUNT_HOST

  • Hostname for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_MOUNT_PORT

  • Port for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_OCR_HOST

  • Hostname for ocr-service.

  • Affected services: [ocr-service celery-app-tasks]

SERVICE_OCR_PORT

  • Port for ocr-service.

  • Affected services: [ocr-service celery-app-tasks]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_TEXTBOXDETECTION_HOST

  • Hostname for textboxdetection-service.

  • Affected services: [celery-app-tasks]

SERVICE_TEXTBOXDETECTION_PORT

  • Port for textboxdetection-service.

  • Affected services: [celery-app-tasks]

SES_ACCESS_KEY_ID

  • If the EMAIL_PROVIDER=ses, then specify the AWS Access Key ID for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_REGION_NAME

  • If the EMAIL_PROVIDER=ses, then specify the AWS Region for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_SECRET_ACCESS_KEY

  • If the EMAIL_PROVIDER=ses, then specify the AWS Secret Access Key for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SMTP_HOSTNAME

  • If the EMAIL_PROVIDER=smtp, then specify the hostname of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SMTP_PORT

  • If the EMAIL_PROVIDER=smtp, then specify the port of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SQS_ACCESS_KEY_ID

  • If USE_SQS=true, then specify the AWS Access Key ID for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_OUT_QUEUE

  • If USE_SQS=true, then specify the name of the AWS SQS out queue.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_QUEUE_TYPE

  • If USE_SQS=true, then specify the AWS SQS queue type.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_REGION_NAME

  • If USE_SQS=true, then specify the AWS Region for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_SECRET_ACCESS_KEY

  • If USE_SQS=true, then specify the AWS Secret Access Key for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_PIPELINE_INTERVAL

  • Timmeout duration to send the stats from internal buffer to stats agent

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_THRIFT_BUCKET_DISTRIBUTION_MULTIPLIER

  • Multiplier used for constructing histogram buckets for capturing stats data for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_ENABLED

  • Enable stats collection for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_MESSAGE_SIZE_ENABLED

  • Enable stats collection for request/response size for Thrift service

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

TESTRUNNER_SINGLE_TEST_TIMEOUT_SECS

  • Polling time in seconds for a single test triggered via Test Runner.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [test-runner]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TSERVICE_PDF_HOST

  • Hostname for pdf-tservice.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

TSERVICE_PDF_PORT

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

USE_AWS_ACCESS_CREDS

  • Configure whether or not AWS access credentials (as opposed to roles-based authentication) are used to connect to AWS S3, SES, SQS and KMS providers.

  • Affected services: [core-platform-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SQS, SES, file-system]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

USE_SQS

  • Configures whether to use SQS for sending messages.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

CELERY-CORE-TASKS

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

ENABLE_HEALTH_CHECK

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [kubernetes]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MAX_UNZIP_SIZE_MB

  • Configures the maximum supported size (in MB) of a file that can be unziped on the platform.

  • Affected services: [celery-core-tasks]

  • Tags: [file-system]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SDLC_THREADPOOL_MAX_WORKERS

  • For SDLC, the maximum number of parallel threads for retriving file information from third-party Git providers.

  • Affected services: [celery-core-tasks]

  • Tags: [sdlc]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_PIPELINE_INTERVAL

  • Timmeout duration to send the stats from internal buffer to stats agent

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

CELERY-WEBDRIVER-TASKS

ACRA_FETCHER_DEADLINE

  • Configures the Fetcher app’s timeout for fetching information from ACRA.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

BING_API_KEY

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

EMAIL_PROVIDER

  • Specify the email provider to use. Valid values are: [SMTP, SES]

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP, SES]

ENABLE_HEALTH_CHECK

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [kubernetes]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

FETCH_FILES_STEP_TIMEOUT

  • Configures the maximum time allowed for the Fetcher step to run before timing out the request (in seconds).

  • Affected services: [api-server celery-webdriver-tasks]

  • Tags: [fetcher]

FILENET_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to FileNet - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

FILENET_GATEWAY_URL

  • Configures the Fetcher app’s connection to FileNet - the Gateway URL of FileNet.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

FILENET_SERVER_URL

  • Configures the Fetcher app’s connection to FileNet - The Server URL of FileNet.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

GCLOUD_API_KEY

  • The API key for Google Cloud Services Sentiment Analysis.

  • Affected services: [ocr-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [nlp]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

LOGGING_EXPORT_ENDPOINT

  • The export endpoint for flow logs to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MAS_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to MASNet - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

ORBIS_FETCHER_DEADLINE

  • Configures the Fetcher app’s connection to Orbis - the timeout on the request.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SELENIUM_HUB_RESOLVE_IP

  • Configures the Fetcher app’s connection to Selenium Hub - whether the IP address should be resolved.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SELENIUM_HUB_URL

  • Configures the Fetcher app’s connection to Selenium Hub - the URL to the server.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [fetcher]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_JOB_HOST

  • Hostname for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_JOB_PORT

  • Port for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_HOST

  • Hostname for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_LICENSE_PORT

  • Port for license-service.

  • Affected services: [apps-server api-server celery-app-tasks celery-webdriver-tasks]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SES_ACCESS_KEY_ID

  • If the EMAIL_PROVIDER=ses, then specify the AWS Access Key ID for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_REGION_NAME

  • If the EMAIL_PROVIDER=ses, then specify the AWS Region for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_SECRET_ACCESS_KEY

  • If the EMAIL_PROVIDER=ses, then specify the AWS Secret Access Key for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SMTP_HOSTNAME

  • If the EMAIL_PROVIDER=smtp, then specify the hostname of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SMTP_PORT

  • If the EMAIL_PROVIDER=smtp, then specify the port of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SQS_ACCESS_KEY_ID

  • If USE_SQS=true, then specify the AWS Access Key ID for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_OUT_QUEUE

  • If USE_SQS=true, then specify the name of the AWS SQS out queue.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_QUEUE_TYPE

  • If USE_SQS=true, then specify the AWS SQS queue type.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_REGION_NAME

  • If USE_SQS=true, then specify the AWS Region for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

SQS_SECRET_ACCESS_KEY

  • If USE_SQS=true, then specify the AWS Secret Access Key for the account with permissions to SQS.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_PIPELINE_INTERVAL

  • Timmeout duration to send the stats from internal buffer to stats agent

  • Affected services: [celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_THRIFT_BUCKET_DISTRIBUTION_MULTIPLIER

  • Multiplier used for constructing histogram buckets for capturing stats data for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_ENABLED

  • Enable stats collection for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_MESSAGE_SIZE_ENABLED

  • Enable stats collection for request/response size for Thrift service

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

TESTRUNNER_SINGLE_TEST_TIMEOUT_SECS

  • Polling time in seconds for a single test triggered via Test Runner.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

  • Tags: [test-runner]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TSERVICE_PDF_HOST

  • Hostname for pdf-tservice.

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

TSERVICE_PDF_PORT

  • Affected services: [celery-app-tasks celery-webdriver-tasks]

USE_AWS_ACCESS_CREDS

  • Configure whether or not AWS access credentials (as opposed to roles-based authentication) are used to connect to AWS S3, SES, SQS and KMS providers.

  • Affected services: [core-platform-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SQS, SES, file-system]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

USE_SQS

  • Configures whether to use SQS for sending messages.

  • Affected services: [apps-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [SQS]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

CONVERSION-SERVICE

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_MAX_CONCURRENT_RPCS

  • The maximum number of concurrent RPCS that can be queued/sent to a GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_MESSAGE_LENGTH_MB

  • Maximum message size that a GRPC channel can receive (in megabytes).

  • Affected services: [api-server ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_RECEIVE_MESSAGE_MB

  • Maximum message size (in megabytes) the GRPC server can receive.

  • Affected services: [ocr-service conversion-service]

  • Tags: [grpc]

GRPC_MAX_WORKERS

  • The maximum number of GRPC workers for a given GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MPLCONFIGDIR

  • Configures the matplotlib’s config directory.

  • Affected services: [conversion-service]

  • Tags: [textbox-detection]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_CONVERSION_PORT

  • Port for conversion-service.

  • Affected services: [api-server conversion-service celery-app-tasks]

CORE-PLATFORM-SERVICE

AMQP_DISABLE_PERSISTENCE

  • Configure Rabbit-MQ to disable persistence of messages in the queue. This means that messages may be lost upon restart of RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_DISABLE_PUBLISH_CONFIRM

  • Configure Rabbit-MQ to disable confirmation of successful publication of a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MAX_ATTEMPTS

  • Configure the maximum number of retries the Rabbit-MQ AMQP broker will retry when publishing a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MAX_WAIT_TIME_IN_MILLIS

  • Configure the maximum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MIN_WAIT_TIME_IN_MILLIS

  • Configure the minimum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_PREFETCH_COUNT

  • Configures how many messages the Rabbit-MQ AMQP broker should pre-fetch. If < 1 defaults to 1.

  • Affected services: [core-platform-service file-tservice job-service search-tservice]

  • Tags: [rabbit-mq]

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

AWS_ACCESS_KEY_ID

  • AWS Access Key ID for an account authorized to connect to AWS services (S3, AWS KMS).

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AWS_SECRET_ACCESS_KEY

  • AWS Secret Access Key for an account authorized to connect to AWS services (e.g. S3, AWS KMS).

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZURE_CONNECTION_STRING

  • Azure Storage Account Connection String for authorizing access to Azure Storage Services

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_AUTH_TYPE

  • The authentication method for the default Instabase Drive if mounted on an Azure Blob Storage Container

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_CLIENT_ID

  • The Client ID (Application ID) of the registered app (service principal) that is authenticating access to the Instabase Drive’s Blob Storage Container

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_CLIENT_SECRET

  • The Client Secret of the registered app (service principal) that is authenticating access to the Instabase Drive’s Blob Storage Container

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_CONTAINER

  • Configures the Azure Blob Storage Container for the default Instabase Drive connection

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_SERVICE_URL

  • The Azure Endpoint for the Blob Service that the Instabase Drive’s Blob Storage Container is provisioned on. E.g. https://.blob.core.windows.net/

  • Affected services: [core-platform-service]

  • Tags: [file-system]

AZ_BLOB_STORE_TENANT_ID

  • The Tenant ID (Directory ID) of the registered app (service principal) that is authenticating access to the Instabase Drive’s Blob Storage Container

  • Affected services: [core-platform-service]

  • Tags: [file-system]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DB_CACHE_PREFIX

  • A prefix for all cache keys in Redis used for database caching.

  • Affected services: [core-platform-service file-tservice job-service license-service]

  • Tags: [redis]

DB_ENABLE_VERBOSE_LOG

  • Enable verbose logging for database queries.

  • Affected services: [core-platform-service job-service]

  • Tags: [database]

DB_MAX_IDLE_CONNS

  • For database connections, specify the maximum number of connections in the idle connection pool.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_OPEN_CONNS

  • For database connections, specify the maximum number of open connections to the database.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DOCUMENT_EXPORT_ENDPOINT

  • The export endpoint that document indexing requests will be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service file-tservice]

ENABLE_DOC_SEARCH

  • Internal config to enable Document Search functionality on the platform (feature is in development).

  • Affected services: [core-platform-service file-tservice api-server search-tservice]

ENABLE_PUBLIC_REPOS

  • Enable public repos which are accessible to everyone without logging in.

  • Affected services: [core-platform-service apps-server api-server]

GCS_BUCKET_NAME

  • Name to the Google Cloud Storage Bucket that will be mounted as the default Instabase Drive.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GCS_CLIENT_EMAIL

  • Client Email to the service account that has ‘Storage Admin’ and ‘Storage Object Admin’ access to GCS_BUCKET_NAME.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GCS_PRIVATE_KEY

  • Private Key to the service account that has ‘Storage Admin’ and ‘Storage Object Admin’ access to GCS_BUCKET_NAME.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GCS_PRIVATE_KEY_ID

  • Private Key ID to the service account that has ‘Storage Admin’ and ‘Storage Object Admin’ access to GCS_BUCKET_NAME.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GCS_SSE_ENCRYPTION_TYPE

  • The type of Server-side encryption used on GCS_BUCKET_NAME. Valid values are: [‘gcs_sse_kms’, ‘gcs_aes256’].

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GCS_SSE_KMS_KEY_ID

  • If GCS_SSE_ENCRYPTION_TYPE is set to gcs_sse_kms’, a value to this field is required, and is taken as the KMS resource ID that will be used to encrypt the content in GCS_BUCKET_NAME.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GO_PROFILER_ENABLED

  • Flag to enable pprof go profiler in go services

  • Affected services: [core-platform-service file-tservice job-service license-service]

GO_PROFILER_PORT

  • If running pprof go profiling, specify port for server to listen on

  • Affected services: [core-platform-service file-tservice job-service license-service]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

HOSTED_ENCRYPTION_TYPE

  • Affected services: [core-platform-service]

  • Tags: [file-system, encryption]

HOSTED_S3_ENCRYPTION_TYPE

  • Configures the default Instabase Drive connection to an S3 bucket that has server-side encryption enabled, set to the encryption algorithm that S3 is configured with. Valid values: [aws_sse_s3, aws_sse_kms, none].

  • Affected services: [core-platform-service]

  • Tags: [file-system, encryption]

HOSTED_S3_SSE_KMS_KEY_ID

  • Determines the KMS Key ID used for server-side encryption of Instabase Drive if kms encryption is enabled

  • Affected services: [core-platform-service]

  • Tags: [file-system, encryption]

HOSTED_STORAGE_TYPE

  • Configures the storage type of the default Instabase Drive. Valid values: [S3, LocalFS].

  • Affected services: [core-platform-service]

  • Tags: [file-system]

HOSTING_BUCKET

  • Configures the S3 bucket for the default Instabase Drive connection.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

HOSTING_DB_CON_PARAMS

  • Configures the database connection parameters for the default Instabase Drive owned mysql database tables.

  • Affected services: [core-platform-service]

  • Tags: [database]

HOSTING_POSTGRES_CON_PARAMS

  • Configures the database connection parameters for the default Instabase Drive owned postgres database tables.

  • Affected services: [core-platform-service]

  • Tags: [database]

INSTABASE_BUCKET

  • The AWS S3 bucket for storing static files uploaded by the user that don’t belong to a specific subspace/repo (e.g. profile pics)

  • Affected services: [core-platform-service]

  • Tags: [file-system]

LOCAL_MOUNT_DIR

  • Configure the default Instabase Drive connection to a NFS file-system. This specifies the directory on the local filesystem for user subspaces/repos to be created in.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MOUNT_PREFIX

  • An optional path prefix to apply to all Instabase Drives.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

PS_PROFILER_SERVER

  • This contains Pyroscope server address, where the profiling data will be sent.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

PS_PROFILER_SERVICE_NAME

  • This contain Pyroscope application name corresponding to specific service.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

REPO_LOCAL_MOUNT_DIR

  • If Local Drives need to be mounted into Repos/Subspaces, this config specifies the root path for all PVCs to be mounted to. This will be the only path accessible by Local Repo/Subspace Drives.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

S3_AWS_REGION

  • Configures the S3 AWS region for connecting to HOSTING_BUCKET for Instabase Drives.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

S3_SERVER_IS_SECURE

  • If the S3_SERVER_URL is set, configures whether or not to use http or https for request to S3.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

S3_SERVER_URL

  • Specify a custom S3 Server endpoint for S3 connections. If unset, will default to https://s3.amazonaws.com.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

S3_SERVER_VALIDATE_CERTS

  • Configures whether or not to validate certificates for requests to S3.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

SERVICE_TABLE_HOST

  • Hostname for table-service.

  • Affected services: [core-platform-service apps-server webapp api-server]

SERVICE_TABLE_PORT

  • Port for table-service

  • Affected services: [core-platform-service table-tservice apps-server webapp api-server]

SESSION_SECRET_KEY

  • The key used to sign generated session keys for user login.

  • Affected services: [core-platform-service apps-server webapp api-server]

SITE_SETTING_REQUIRE_MFA

  • A site-wide configuration option to require users to login with MFA.

  • Affected services: [core-platform-service apps-server api-server]

SITE_SETTING_REQUIRE_TOTP

  • A site-wide configuration option to require Authenticator App as the only MFA option.

  • Affected services: [core-platform-service apps-server api-server]

SITE_SETTING_SITE_ADMIN_CAN_ACCESS_ALL_ORGS

  • A site-wide configuration option to allow site admins to access all organizations across the platform.

  • Affected services: [core-platform-service file-tservice search-tservice]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

USE_AWS_ACCESS_CREDS

  • Configure whether or not AWS access credentials (as opposed to roles-based authentication) are used to connect to AWS S3, SES, SQS and KMS providers.

  • Affected services: [core-platform-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SQS, SES, file-system]

USE_VIRTUAL_STYLE_URL

  • Whether to use virtual style (or path style) URL address for connecting to HOSTING_BUCKET.

  • Affected services: [core-platform-service]

  • Tags: [file-system]

FILE-TSERVICE

AMQP_DISABLE_PERSISTENCE

  • Configure Rabbit-MQ to disable persistence of messages in the queue. This means that messages may be lost upon restart of RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_DISABLE_PUBLISH_CONFIRM

  • Configure Rabbit-MQ to disable confirmation of successful publication of a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_ENABLE_TRACING

  • Enable request tracing through messages published to RabbitMQ.

  • Affected services: [file-tservice]

  • Tags: [rabbit-mq]

AMQP_MAX_ATTEMPTS

  • Configure the maximum number of retries the Rabbit-MQ AMQP broker will retry when publishing a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MAX_WAIT_TIME_IN_MILLIS

  • Configure the maximum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MIN_WAIT_TIME_IN_MILLIS

  • Configure the minimum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_PREFETCH_COUNT

  • Configures how many messages the Rabbit-MQ AMQP broker should pre-fetch. If < 1 defaults to 1.

  • Affected services: [core-platform-service file-tservice job-service search-tservice]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DB_CACHE_PREFIX

  • A prefix for all cache keys in Redis used for database caching.

  • Affected services: [core-platform-service file-tservice job-service license-service]

  • Tags: [redis]

DB_MAX_IDLE_CONNS

  • For database connections, specify the maximum number of connections in the idle connection pool.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_OPEN_CONNS

  • For database connections, specify the maximum number of open connections to the database.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DISABLE_MARKETPLACE_CLIENT_SIDE_ENCRYPTION

  • Disables client side encryption for the marketplace folder in the system drive. This is used to allow publishing and reading large solutions from the marketplace when client side encryption is enabled for hosted drives (Instabase Drive).

  • Affected services: [file-tservice]

  • Tags: [file-system, encryption]

DOCUMENT_EXPORT_ENDPOINT

  • The export endpoint that document indexing requests will be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service file-tservice]

ENABLE_ACTIVITY_LOG

  • Enable logging of all file-system activity, include reads and writes to all files and folders.

  • Affected services: [file-tservice]

  • Tags: [file-system]

ENABLE_DOC_SEARCH

  • Internal config to enable Document Search functionality on the platform (feature is in development).

  • Affected services: [core-platform-service file-tservice api-server search-tservice]

ENABLE_STORAGE_MANAGER

  • Feature flag to enable processing file retention rules on Instabase-managed storage (the Instabase Drive on every subspace) from Admin App > File Storage > File Retention. Retention rules still need to be configured in the app to take effect.

  • Affected services: [file-tservice]

  • Tags: [file-system]

ENABLE_VERBOSE_LOG

  • Enable verbose logging of all requests/responses in the given service. These are S3/Boto logs when set on file-tservice.

  • Affected services: [file-tservice]

  • Tags: [file-system, control-plane]

ENABLE_VERBOSE_STATS_LOGS

  • Enables the verbose logs for the stats exporter. Default - false

  • Affected services: [file-tservice]

  • Tags: [stats]

ENCRYPTION_TYPE

  • Type of encryption used for client-side encryption of files. Valid values: [kms_encryption]

  • Affected services: [file-tservice]

  • Tags: [file-system]

FS_SYSTEM_NAME

  • A unique system name recognized by the file-service to allow list directory operations on all folders across the platform.

  • Affected services: [file-tservice search-tservice]

  • Tags: [file-service]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GO_PROFILER_ENABLED

  • Flag to enable pprof go profiler in go services

  • Affected services: [core-platform-service file-tservice job-service license-service]

GO_PROFILER_PORT

  • If running pprof go profiling, specify port for server to listen on

  • Affected services: [core-platform-service file-tservice job-service license-service]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

INSTABASE_URI

  • The Instabase URI hostname (e.g. instabase.com) to be used as the root URLs in API requests.

  • Affected services: [file-tservice license-service apps-server webapp]

  • Tags: [scheduler]

KMS_DETAILS_ENCRYPTION_KEY_256_BIT

  • Encryption key used for encrypting key management service provider mount details in the database.

  • Affected services: [file-tservice]

  • Tags: [file-system]

KMS_PROVIDER

  • Key management service provider to use for client-side encryption of files. Valid values: [aws]

  • Affected services: [file-tservice]

  • Tags: [file-system]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

PS_PROFILER_SERVER

  • This contains Pyroscope server address, where the profiling data will be sent.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

PS_PROFILER_SERVICE_NAME

  • This contain Pyroscope application name corresponding to specific service.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

READ_FILE_BUFFER_SIZE_MB

  • For grpc file-service, sets the size of the buffer for reading from filesystem

  • Affected services: [file-tservice]

  • Tags: [file-system]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

S3_DELETION_BATCH_SIZE

  • The default batch size for S3 batch deletion requests.

  • Affected services: [file-tservice]

  • Tags: [file-system]

S3_USE_HCP_FS

  • Enable S3 HCP file-system semantics for all drives. If true, non-HCP drives, like native S3, will not be supported.

  • Affected services: [file-tservice]

  • Tags: [file-system]

SERVICE_CORE_PLATFORM_GRPC_MOUNT_PORT

  • Port for grpc-mount-service in core-platform-service.

  • Affected services: [file-tservice]

SERVICE_CORE_PLATFORM_HOST

  • Hostname for core-platform-service.

  • Affected services: [file-tservice]

SERVICE_KEY_PORT

  • Port for key-service.

  • Affected services: [file-tservice api-server]

SERVICE_MOUNT_HOST

  • Hostname for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_MOUNT_PORT

  • Port for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SITE_SETTING_SITE_ADMIN_CAN_ACCESS_ALL_ORGS

  • A site-wide configuration option to allow site admins to access all organizations across the platform.

  • Affected services: [core-platform-service file-tservice search-tservice]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_PORT

  • Port for exposing stats

  • Affected services: [file-tservice model-service]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_SYSTEM_ENABLED

  • Enable system-level stats collection, such as network, CPU/mem etc

  • Affected services: [file-tservice]

  • Tags: [stats, file-system]

STORAGE_MANAGER_RUN_PERIOD_IN_DAY

  • How often the file crawler should run for file retention in days

  • Affected services: [file-tservice]

  • Tags: [file-system]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

USE_STREAM_ENCRYPTION

  • A feature flag to indicate whether or not to use a stream encryption algorithm for client-side encryption.

  • Affected services: [file-tservice]

  • Tags: [file-system]

WRITE_FILE_BUFFER_SIZE_MB

  • For grpc file-service, sets the size of the buffer for writing to filesystem

  • Affected services: [file-tservice]

  • Tags: [file-system]

JAEGER

SAMPLING_STRATEGIES_FILE

  • Path to sampling_strategies.json file for jaeger trace sampling

  • Affected services: [jaeger]

  • Tags: [tracing, jaeger]

SAMPLING_STRATEGIES_RELOAD_INTERVAL

  • Time interval (like 60s) to reload the sampling strategies file

  • Affected services: [jaeger]

  • Tags: [tracing, jaeger]

JOB-SERVICE

AIHUB_RATE_LIMITER_CACHE_PERSISTENCE_URL

  • Configure the URL for cache persistence API of api-server for AIHub Rate Limiter

  • Affected services: [job-service]

  • Tags: [job-service]

AMQP_DISABLE_PERSISTENCE

  • Configure Rabbit-MQ to disable persistence of messages in the queue. This means that messages may be lost upon restart of RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_DISABLE_PUBLISH_CONFIRM

  • Configure Rabbit-MQ to disable confirmation of successful publication of a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MAX_ATTEMPTS

  • Configure the maximum number of retries the Rabbit-MQ AMQP broker will retry when publishing a message to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MAX_WAIT_TIME_IN_MILLIS

  • Configure the maximum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_MIN_WAIT_TIME_IN_MILLIS

  • Configure the minimum wait time the Rabbit-MQ AMQP broker will wait when publishing a mesage to the queue.

  • Affected services: [core-platform-service file-tservice job-service]

  • Tags: [rabbit-mq]

AMQP_PREFETCH_COUNT

  • Configures how many messages the Rabbit-MQ AMQP broker should pre-fetch. If < 1 defaults to 1.

  • Affected services: [core-platform-service file-tservice job-service search-tservice]

  • Tags: [rabbit-mq]

API_IGNORE_CERT_VERIFICATION

  • Disable certificate verfication when issuing API requests.

  • Affected services: [job-service]

  • Tags: [scheduler]

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CELERY_APP_TASKS_REPLICAS

  • Number of celery app-tasks replicas. Used by the task scheduler to control the number of running tasks. Do not change this value independently.

  • Affected services: [job-service]

  • Tags: [job-service]

CELERY_EXPORTER_ENABLE

  • Enable celery stats exposition in job service.

  • Affected services: [job-service]

  • Tags: [stats]

DB_CACHE_PREFIX

  • A prefix for all cache keys in Redis used for database caching.

  • Affected services: [core-platform-service file-tservice job-service license-service]

  • Tags: [redis]

DB_ENABLE_SERVER_STATS

  • Enable collection of statistics from the database server.

  • Affected services: [job-service]

  • Tags: [database]

DB_ENABLE_VERBOSE_LOG

  • Enable verbose logging for database queries.

  • Affected services: [core-platform-service job-service]

  • Tags: [database]

DB_MAX_IDLE_CONNS

  • For database connections, specify the maximum number of connections in the idle connection pool.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_OPEN_CONNS

  • For database connections, specify the maximum number of open connections to the database.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

ENABLE_CRON_SCHEDULER

  • Enable Cron Scheduler functionality.

  • Affected services: [job-service]

  • Tags: [scheduler]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

ENABLE_LOG_SLURPER

  • Enable the log-slurper feature for persisting logs to disk.

  • Affected services: [job-service]

FLOW_JOB_RETENTION_PERIOD

  • Duration for which we retain flow results (seconds). Flows older than this will have their DB table entries, output directory and logs deleted.

  • Affected services: [job-service]

  • Tags: [job-service, flow]

FLOW_LOGS_DIR

  • The location where flow logs are stored in the instabase filesystem.

  • Affected services: [job-service]

  • Tags: [job-service, flow]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GO_PROFILER_ENABLED

  • Flag to enable pprof go profiler in go services

  • Affected services: [core-platform-service file-tservice job-service license-service]

GO_PROFILER_PORT

  • If running pprof go profiling, specify port for server to listen on

  • Affected services: [core-platform-service file-tservice job-service license-service]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

JOB_SERVICE_MAX_RECEIVE_MSG_SIZE

  • Maximum message size (in bytes) the job-service GRPC server can receive.

  • Affected services: [job-service]

  • Tags: [grpc]

JOB_SERVICE_MAX_SEND_MSG_SIZE

  • Maximum message size (in bytes) the job-service GRPC server can send.

  • Affected services: [job-service]

  • Tags: [grpc]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MAX_SCHEDULED_CRON_JOBS

  • Maximum number of cron jobs allowed.

  • Affected services: [job-service]

  • Tags: [job-service]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

NUM_EXECUTORS

  • The number of celery workers to run in each app-tasks pod.

  • Affected services: [job-service celery-app-tasks]

  • Tags: [celery]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

POD_NAME

  • Name of the current pod available as an Env var from Kubernetes object metadata.

  • Affected services: [job-service license-service search-tservice rabbitmq-ha]

  • Tags: [kubernetes]

PS_PROFILER_SERVER

  • This contains Pyroscope server address, where the profiling data will be sent.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

PS_PROFILER_SERVICE_NAME

  • This contain Pyroscope application name corresponding to specific service.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_APISERVER_HOST

  • Hostname for api-server.

  • Affected services: [job-service celery-app-tasks]

SERVICE_APISERVER_PORT

  • Port for api-server.

  • Affected services: [job-service celery-app-tasks]

SERVICE_DATABASE_HOST

  • Hostname for grpc database service.

  • Affected services: [job-service celery-app-tasks]

SERVICE_DATABASE_PORT

  • Port for grpc database service.

  • Affected services: [job-service celery-app-tasks]

SERVICE_RUNNER_HOST

  • Hostname for runner-service.

  • Affected services: [job-service]

SERVICE_RUNNER_PORT

  • Port for runner-service.

  • Affected services: [job-service]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_COLLECTORS

  • List of collectors to run when the stats framework is setup. e.g. fs:–mountPath=/etc,–mountPath=/var/lib,–period=10;collectorX:–arg1=value1,–arg2=value2

  • Affected services: [job-service search-tservice model-service]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TS_LOOKBACK_PERIOD_IN_HRS

  • Configures how old a job we want to recover if job-service restarts. Task scheduler loads jobs with start date [now-lookback_period, now] on startup.

  • Affected services: [job-service]

  • Tags: [job-service]

LICENSE-SERVICE

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DB_CACHE_PREFIX

  • A prefix for all cache keys in Redis used for database caching.

  • Affected services: [core-platform-service file-tservice job-service license-service]

  • Tags: [redis]

DB_TEST_INIT_CONN

  • For database connections, whether to explicitly test the connection to the database when a pod comes up. This assumes all tables have already been created.

  • Affected services: [license-service]

  • Tags: [database]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GO_PROFILER_ENABLED

  • Flag to enable pprof go profiler in go services

  • Affected services: [core-platform-service file-tservice job-service license-service]

GO_PROFILER_PORT

  • If running pprof go profiling, specify port for server to listen on

  • Affected services: [core-platform-service file-tservice job-service license-service]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

INSTABASE_HOSTNAME

  • The Instabase URL hostname (e.g. instabase.com).

  • Affected services: [license-service apps-server webapp api-server server-nginx]

INSTABASE_URI

  • The Instabase URI hostname (e.g. instabase.com) to be used as the root URLs in API requests.

  • Affected services: [file-tservice license-service apps-server webapp]

  • Tags: [scheduler]

INSTABASE_URI_SCHEME

  • The instabase URI schema (e.g. http, https) to be used as the prefix for URLs in API requests.

  • Affected services: [license-service apps-server]

  • Tags: [scheduler]

LICENSE_SERVICE_MAX_RECEIVE_MSG_SIZE

  • Maximum message size (in bytes) the GRPC server can receive.

  • Affected services: [license-service]

  • Tags: [grpc]

LICENSE_SERVICE_MAX_SEND_MSG_SIZE

  • Maximum message size (in bytes) the GRPC server can send.

  • Affected services: [license-service]

  • Tags: [grpc]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

POD_NAME

  • Name of the current pod available as an Env var from Kubernetes object metadata.

  • Affected services: [job-service license-service search-tservice rabbitmq-ha]

  • Tags: [kubernetes]

PS_PROFILER_SERVER

  • This contains Pyroscope server address, where the profiling data will be sent.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

PS_PROFILER_SERVICE_NAME

  • This contain Pyroscope application name corresponding to specific service.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

MODEL-SERVICE

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

ENABLE_WEAVIATE_HA_CLIENT

  • flag to enable HA for weaviate client.

  • Affected services: [api-server model-service]

FLOW_DATASTORE_SYNC_PREFIX

  • Configures the cache prefix for Flow Datastore during execution of Flow synchronous APIs.

  • Affected services: [api-server model-service celery-app-tasks]

  • Tags: [flow]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_MAX_CONCURRENT_RPCS

  • The maximum number of concurrent RPCS that can be queued/sent to a GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_MESSAGE_LENGTH_MB

  • Maximum message size that a GRPC channel can receive (in megabytes).

  • Affected services: [api-server ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_WORKERS

  • The maximum number of GRPC workers for a given GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

HF_HOME

INSTALLM_API_KEY

  • The API key for InstaLLM.

  • Affected services: [api-server model-service]

LOGGING_EXPORT_ENDPOINT

  • The export endpoint for flow logs to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

MODEL_SERVICE_LOADING_BACKOFF_FACTOR

  • An exponential backoff factor to use when timing retry logic for connecting to RabbitMQ during model loading.

  • Affected services: [model-service]

  • Tags: [models]

MODEL_SERVICE_LOADING_MAX_RETRY_SECONDS

  • The maximum amount of time to wait to reconnect to RabbitMQ while retrying connections for model loading (in seconds).

  • Affected services: [model-service]

  • Tags: [models]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

PY_LOADER_DOWNLOAD_WORKERS

  • The number of workers for downloading files from the Instabase Filesystem during PyLoader usage (e.g. models in model service).

  • Affected services: [model-service ray-model-training-worker]

  • Tags: [udf]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_JOB_HOST

  • Hostname for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_JOB_PORT

  • Port for job-service.

  • Affected services: [apps-server api-server model-service celery-app-tasks celery-webdriver-tasks]

SERVICE_WEAVIATE_HOST

  • Hostname for weaviate.

  • Affected services: [api-server model-service]

SERVICE_WEAVIATE_PORT

  • Port for weaviate.

  • Affected services: [api-server model-service]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_COLLECTORS

  • List of collectors to run when the stats framework is setup. e.g. fs:–mountPath=/etc,–mountPath=/var/lib,–period=10;collectorX:–arg1=value1,–arg2=value2

  • Affected services: [job-service search-tservice model-service]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_PORT

  • Port for exposing stats

  • Affected services: [file-tservice model-service]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

OCR-MSFT-FORM-RECOGNIZER-LAYOUT

APIKEY

  • The azure API Key for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

BILLING

  • The azure billing endpoint URI for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

EULA

  • Used to accept the EULA for Microsoft read containers. Valid value is ‘accept’.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

StorageTimeToLiveInMinutes

  • Time-to-live in minutes of ocr results for Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite]

Task__MaxRunningTimeSpanInMinutes

  • Maximum time (in minutes) allowed for an ocr request to complete in Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

OCR-MSFT-LITE

APIKEY

  • The azure API Key for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

BILLING

  • The azure billing endpoint URI for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

EULA

  • Used to accept the EULA for Microsoft read containers. Valid value is ‘accept’.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

LICENSE_FILE

  • License File for Microsoft read-3.2 offline containers. This need to be updated for each customer.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

Mounts__License

  • Location of license for Microsoft offline containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3, ocr-msft-lite]

Mounts__Output

  • Location for writing usage metrics for Microsoft offline containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3, ocr-msft-lite]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

ONEOCR_CONCURRENCY

  • The concurrency value for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

OcrSlimMode

  • Light weight mode for Microsoft read-3.3 containers.

  • Affected services: [ocr-msft-lite]

  • Tags: [ocr-msft-lite]

QueueNamePrefix

  • The prefix value of rabbitmq queues created by Microsoft read containers. Example QueueNamePrefix=msft-read-lite- will prepend msft-read-lite- to the original queue name making it msft-read-lite-analytics-ocr, this helps in preventing queue names collision between same base images.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

StorageTimeToLiveInMinutes

  • Time-to-live in minutes of ocr results for Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite]

Task__MaxRunningTimeSpanInMinutes

  • Maximum time (in minutes) allowed for an ocr request to complete in Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

OCR-MSFT-V3

APIKEY

  • The azure API Key for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

BILLING

  • The azure billing endpoint URI for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

EULA

  • Used to accept the EULA for Microsoft read containers. Valid value is ‘accept’.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

LICENSE_FILE

  • License File for Microsoft read-3.2 offline containers. This need to be updated for each customer.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

Mounts__License

  • Location of license for Microsoft offline containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3, ocr-msft-lite]

Mounts__Output

  • Location for writing usage metrics for Microsoft offline containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3, ocr-msft-lite]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

ONEOCR_CONCURRENCY

  • The concurrency value for Microsoft read containers.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

QueueNamePrefix

  • The prefix value of rabbitmq queues created by Microsoft read containers. Example QueueNamePrefix=msft-read-lite- will prepend msft-read-lite- to the original queue name making it msft-read-lite-analytics-ocr, this helps in preventing queue names collision between same base images.

  • Affected services: [ocr-msft-v3 ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite, ocr-msft-v3]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

StorageTimeToLiveInMinutes

  • Time-to-live in minutes of ocr results for Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-lite]

Task__MaxRunningTimeSpanInMinutes

  • Maximum time (in minutes) allowed for an ocr request to complete in Microsoft read-3.2 containers.

  • Affected services: [ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite]

  • Tags: [ocr, ocr-msft-v3]

http_proxy

  • Standard Linux environment variable. For external HTTP requests, specify the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

https_proxy

  • Standard Linux environment variable. For external HTTPS requests, point to the proxy that will allow external web requests.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

no_proxy

  • Standard Linux environment variable. Defines the domains that should not get routed via the HTTP/HTTPS proxies specified by HTTP_PROXY and HTTPS_PROXY.

  • Affected services: [apps-server api-server ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite celery-app-tasks celery-webdriver-tasks]

OCR-SERVICE

ARI_DATA_DIR

  • Specifies the path for ARI’s user specific data files.

  • Affected services: [ocr-service]

  • Tags: [ocr]

ENABLE_IMAGE_SERVICE

  • Enable image-service functionality in ocr-service for image-processing functionality.

  • Affected services: [ocr-service celery-app-tasks]

GCLOUD_API_KEY

  • The API key for Google Cloud Services Sentiment Analysis.

  • Affected services: [ocr-service celery-app-tasks celery-webdriver-tasks]

  • Tags: [nlp]

GRPC_IMAGE_SERVICE_MAX_CONCURRENT_STREAMS

  • The maximum number of concurrent http streams to the image service GRPC server.

  • Affected services: [ocr-service]

  • Tags: [grpc]

GRPC_MAX_CONCURRENT_RPCS

  • The maximum number of concurrent RPCS that can be queued/sent to a GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_GRACE_SECONDS

  • Grace period for GRPC after the channel reaches its max age (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_CONNECTION_AGE_SECONDS

  • Maximum time that a GRPC channel may exist (seconds).

  • Affected services: [core-platform-service file-tservice job-service license-service ocr-service conversion-service model-service celery-app-tasks]

  • Tags: [grpc]

GRPC_MAX_MESSAGE_LENGTH_MB

  • Maximum message size that a GRPC channel can receive (in megabytes).

  • Affected services: [api-server ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_MAX_RECEIVE_MESSAGE_MB

  • Maximum message size (in megabytes) the GRPC server can receive.

  • Affected services: [ocr-service conversion-service]

  • Tags: [grpc]

GRPC_MAX_WORKERS

  • The maximum number of GRPC workers for a given GRPC service.

  • Affected services: [ocr-service conversion-service model-service]

  • Tags: [grpc]

GRPC_OCR_SERVICE_MAX_CONCURRENT_STREAMS

  • The maximum number of concurrent http streams to the ocr service GRPC server.

  • Affected services: [ocr-service]

  • Tags: [grpc]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_OCR_HOST

  • Hostname for ocr-service.

  • Affected services: [ocr-service celery-app-tasks]

SERVICE_OCR_PORT

  • Port for ocr-service.

  • Affected services: [ocr-service celery-app-tasks]

OPENSEARCH

DISABLE_INSTALL_DEMO_CONFIG

  • Flag to disable the installation of demo configurations during the installation process.

  • Affected services: [opensearch]

  • Tags: [opensearch]

DISABLE_SECURITY_PLUGIN

  • Flag to disable the security plugin during the startup process.

  • Affected services: [opensearch]

  • Tags: [opensearch]

OPENSEARCH_CLUSTER_NAME

  • Name of the opensearch cluster, used for pairing with other nodes to form multi node cluster.

  • Affected services: [opensearch]

  • Tags: [opensearch]

OPENSEARCH_DISCOVERY_SERVICE

  • Name of the headless service for opensearch cluster node discovery

  • Affected services: [opensearch]

  • Tags: [opensearch]

OPENSEARCH_HTTP_CORS_ALLOW_ORIGIN

  • List of origins to use for cross origin requests.

  • Affected services: [opensearch]

  • Tags: [opensearch]

OPENSEARCH_HTTP_CORS_ENABLE

  • Enable cross origin requests to opensearch

  • Affected services: [opensearch]

  • Tags: [opensearch]

OPENSEARCH_NUMBER_OF_MASTERS

  • Number of master nodes in the opensearch cluster

  • Affected services: [opensearch]

  • Tags: [opensearch]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

RABBITMQ

FORCE_BOOT

  • Boolean flag to allow RabbitMQ node to start even if the peers were not discovered at startup.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

HOSTNAME

  • Hostname used to identify a pod name. This is used for determining RabbitMQ node name. Set using kubernetes object metadata.

  • Affected services: [rabbitmq rabbitmq-ha ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBITMQ_CONSOLE_PASS

  • Password for RABBITMQ_CONSOLE_USER accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_CONSOLE_USER

  • Username for accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_ERLANG_KEY

  • Key used by RabbitMQ nodes to authenticate with each other.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_IO_THREAD_POOL_SIZE

  • The number of threads in the threapoll to perform IO operations with RabbitMQ

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_MODE

  • Used to run RabbitMQ in clustered mode (HA) or single node mode.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_NODENAME

  • Fullname used to identify a RabbitMQ node. It contains hostname/pod name.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_USE_LONGNAME

  • This allows RabbitMQ names to use FQDN for naming node, for clustering (HA) purpose.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ-HA

DB_CONN_MAX_LIFETIME_IN_SEC

  • For database connections, the maximum amount of time a connection a connection may be reused.

  • Affected services: [table-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_IDLE_CONNS

  • For database connections, specify the maximum number of connections in the idle connection pool.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_OPEN_CONNS

  • For database connections, specify the maximum number of open connections to the database.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_TLS_ENABLE

  • flag to enable TLS in databases

  • Affected services: [rabbitmq-ha]

  • Tags: [database]

DB_TLS_ENABLE_CLIENT_CERT

  • flag to enable client TLS in databases

  • Affected services: [rabbitmq-ha]

  • Tags: [database]

DB_TLS_SKIP_VERIFY

  • flag to disable TLS verification in db

  • Affected services: [rabbitmq-ha]

  • Tags: [database]

DB_USE_KERBEROS_AUTHENTICATION

  • flag to use kerberos authentication in db

  • Affected services: [rabbitmq-ha]

  • Tags: [database]

FORCE_BOOT

  • Boolean flag to allow RabbitMQ node to start even if the peers were not discovered at startup.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

HOSTNAME

  • Hostname used to identify a pod name. This is used for determining RabbitMQ node name. Set using kubernetes object metadata.

  • Affected services: [rabbitmq rabbitmq-ha ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

POD_NAME

  • Name of the current pod available as an Env var from Kubernetes object metadata.

  • Affected services: [job-service license-service search-tservice rabbitmq-ha]

  • Tags: [kubernetes]

RABBITMQ_CONSOLE_PASS

  • Password for RABBITMQ_CONSOLE_USER accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_CONSOLE_USER

  • Username for accessing RabbitMQ web console

  • Affected services: [api-server rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_DEFAULT_PASS

  • Password for RABBITMQ_DEFAULT_USER accessing RabbitMQ web console

  • Affected services: [rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_DEFAULT_USER

  • Default Username for accessing RabbitMQ web console

  • Affected services: [rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_ERLANG_KEY

  • Key used by RabbitMQ nodes to authenticate with each other.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_IO_THREAD_POOL_SIZE

  • The number of threads in the threapoll to perform IO operations with RabbitMQ

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_LOG_LEVEL

  • Log level for RMQ process that runs within RMQ-HA service

  • Affected services: [rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_MNESIA_BASE

  • The env to setup the base for the rmq mnesia

  • Affected services: [rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_MODE

  • Used to run RabbitMQ in clustered mode (HA) or single node mode.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_NODENAME

  • Fullname used to identify a RabbitMQ node. It contains hostname/pod name.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

RABBITMQ_USE_LONGNAME

  • This allows RabbitMQ names to use FQDN for naming node, for clustering (HA) purpose.

  • Affected services: [rabbitmq rabbitmq-ha]

  • Tags: [rabbit-mq]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

RAY-HEAD

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

HOSTNAME

  • Hostname used to identify a pod name. This is used for determining RabbitMQ node name. Set using kubernetes object metadata.

  • Affected services: [rabbitmq rabbitmq-ha ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOGGING_EXPORT_ENDPOINT

  • The export endpoint for flow logs to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RAY_USE_TLS

  • For Ray model-training infra, a flag to set whether or not TLS should be used for communication between pods in the Ray cluster. If 1, TLS is required, if 0, TLS will not be used. TLS is enabled by default.

  • Affected services: [ray-head ray-model-training-worker]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

TRACER_REPORTING_HOST

  • For tracing, specify the ip address of the Jaeger client.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TRACER_REPORTING_PORT

  • For tracing, specify the port number of the Jaeger client.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TRACER_SAMPLER_PARAM

  • For tracing, configures the parameters of sampling. When the TRACER_SAMPLER_TYPE is set as const, it will either sample all traces (TRACER_SAMPLER_PARAM=1) or none of them (TRACER_SAMPLER_PARAM=0). When TRACER_SAMPLER_TYPE is set as remote, the TRACER_SAMPLER_PARAM is ignored.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

RAY-MODEL-TRAINING-WORKER

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

DATASET_SDK_NUM_DOWNLOAD_WORKERS

  • The number of concurrent workers used to download files to disk within the DatasetSDK.

  • Affected services: [ray-model-training-worker]

  • Tags: [model-training, datasets]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_ENABLE_RETRY

  • Enable RPC retry for gRPC clients

  • Affected services: [core-platform-service file-tservice job-service api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

HF_HOME

HOSTNAME

  • Hostname used to identify a pod name. This is used for determining RabbitMQ node name. Set using kubernetes object metadata.

  • Affected services: [rabbitmq rabbitmq-ha ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOGGING_EXPORT_ENDPOINT

  • The export endpoint for flow logs to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

MAX_TASKS_PER_CHILD

  • Maximum number of tasks processed by a celery-worker before it is replaced

  • Affected services: [celery-app-tasks ray-model-training-worker]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

MODEL_TRAINING_MAX_WORKERS

  • Limits the number of concurrent celery workers running model training jobs in the same container.

  • Affected services: [ray-model-training-worker]

  • Tags: [model-training]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

PY_LOADER_DOWNLOAD_WORKERS

  • The number of workers for downloading files from the Instabase Filesystem during PyLoader usage (e.g. models in model service).

  • Affected services: [model-service ray-model-training-worker]

  • Tags: [udf]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RAY_USE_TLS

  • For Ray model-training infra, a flag to set whether or not TLS should be used for communication between pods in the Ray cluster. If 1, TLS is required, if 0, TLS will not be used. TLS is enabled by default.

  • Affected services: [ray-head ray-model-training-worker]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_ON_GPU

  • Set within model-training-tasks to indicate whether the deployment was configured for GPU use.

  • Affected services: [ray-model-training-worker]

  • Tags: [model-training]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

TRACER_REPORTING_HOST

  • For tracing, specify the ip address of the Jaeger client.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TRACER_REPORTING_PORT

  • For tracing, specify the port number of the Jaeger client.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TRACER_SAMPLER_PARAM

  • For tracing, configures the parameters of sampling. When the TRACER_SAMPLER_TYPE is set as const, it will either sample all traces (TRACER_SAMPLER_PARAM=1) or none of them (TRACER_SAMPLER_PARAM=0). When TRACER_SAMPLER_TYPE is set as remote, the TRACER_SAMPLER_PARAM is ignored.

  • Affected services: [ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

REDIS

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

REDIS_ADDR

  • Address of the Redis instance used by redis-stats-exporter sidecar.

  • Affected services: [redis redis-persistent]

  • Tags: [redis, redis-persistent, stats]

REDIS_EXPORTER_WEB_LISTEN_ADDRESS

  • Address to listen on for web interface used by redis-stats-exporter sidecar.

  • Affected services: [redis redis-persistent]

  • Tags: [redis, redis-persistent, stats]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

REDIS-PERSISTENT

APPEND_DIR_NAME

  • Directory path within REDIS_WORK_DIR at which AOFs can be found, if applicable. See Redis appenddirname configuration.

  • Affected services: [redis-persistent]

  • Tags: [redis-persistent]

APPEND_FILE_NAME

  • Name of the AOF within APPEND_DIR_NAME. See Redis appendfilename configuration.

  • Affected services: [redis-persistent]

  • Tags: [redis-persistent]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

REDIS_ADDR

  • Address of the Redis instance used by redis-stats-exporter sidecar.

  • Affected services: [redis redis-persistent]

  • Tags: [redis, redis-persistent, stats]

REDIS_EXPORTER_WEB_LISTEN_ADDRESS

  • Address to listen on for web interface used by redis-stats-exporter sidecar.

  • Affected services: [redis redis-persistent]

  • Tags: [redis, redis-persistent, stats]

REDIS_WORK_DIR

  • Directory path to where home directory for Redis configurations. See Redis dir configuration.

  • Affected services: [redis-persistent]

  • Tags: [redis-persistent]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

USE_MANIFEST

  • Whether the Redis deployment uses manifest files for AOF. Should be True if using Redis engine version >= 7.0.0, otherwise False

  • Affected services: [redis-persistent]

  • Tags: [redis-persistent]

SEARCH-TSERVICE

AMQP_PREFETCH_COUNT

  • Configures how many messages the Rabbit-MQ AMQP broker should pre-fetch. If < 1 defaults to 1.

  • Affected services: [core-platform-service file-tservice job-service search-tservice]

  • Tags: [rabbit-mq]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

DB_MAX_IDLE_CONNS

  • For database connections, specify the maximum number of connections in the idle connection pool.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

DB_MAX_OPEN_CONNS

  • For database connections, specify the maximum number of open connections to the database.

  • Affected services: [core-platform-service file-tservice job-service search-tservice rabbitmq-ha]

  • Tags: [database]

ENABLE_DOC_SEARCH

  • Internal config to enable Document Search functionality on the platform (feature is in development).

  • Affected services: [core-platform-service file-tservice api-server search-tservice]

ES_AWS_ACCESS_KEY_ID

  • If connecting to an Elasticsearch Service running in AWS, specify the AWS Access Key ID of the authenticated account.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_AWS_REGION

  • If connecting to an Elasticsearch Service running in AWS, specify the AWS Region the service is located in.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_AWS_SECRET_ACCESS_KEY

  • If connecting to an Elasticsearch Service running in AWS, specify the AWS Secret Access Key of the authenticated account.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_AWS_SERVER

  • If connecting to an Elasticsearch Service running in AWS, specify the name of the AWS server.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_ENABLE_HEALTHCHECK

  • Specify if healthchecks for Elasticsearch node discovery on client need to be enabled. This is usually disabled when sniffing is disabled.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_ENABLE_SNIFF

  • Specify if sniffing (periodic checks for available Elasticsearch node) need to enabled. This is recommended to be disabled when using AWS Elasticsearch/Opensearch.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_INDEX_PREFIX

  • Specify an optional prefix for index names in Elasticsearch.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_K8S_PORT

  • If connecting to an Elasticsearch Service running on Kubernetes, specify the port.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_K8S_SERVER

  • If connecting to an Elasticsearch Service running on Kubernetes, specify the host.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_PASSWORD

  • If connecting to an Elasticsearch Service running on Kubernetes that uses basic authentication, specify the password.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_PROVIDER

  • Specify the Elasticsearch Service provider. Valid values: [AWS, K8S].

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_TLS_ENABLE

  • If the ElasticsearchService is configured with TLS, set this to indicate that TLS configs should be used.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_TLS_SKIP_VERIFY

  • If the Elasticsearch Service is configured with TLS, set this to indicate that TLS certificate validation should be skipped.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_URL_SCHEME

  • Specify the URL scheme of the hostname of the Elasticsearch Service. Valid values: [http, https]

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_USERNAME

  • If connecting to an Elasticsearch Service running on Kubernetes that uses basic authentication, specify the username.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

ES_USE_IB_INDEX_MANAGEMENT_SYSTEM

  • Enables the IB implemented Index Management System for rollovers in ES/OpenSearch

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

FS_SYSTEM_NAME

  • A unique system name recognized by the file-service to allow list directory operations on all folders across the platform.

  • Affected services: [file-tservice search-tservice]

  • Tags: [file-service]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

INDEXER_RATE_LIMIT_DOCS_PER_SEC

  • A rate limit for the number of documents that are indexed by the file walker per second. If specified as zero, then no rate limiting is applied to the file walker.

  • Affected services: [search-tservice]

  • Tags: [document-search]

INDEX_AUDIT_LOGS

  • Feature flag to indicate whether audit logs should be indexed in Elasticsearch.

  • Affected services: [search-tservice]

  • Tags: [elasticsearch]

LOG_AUDITLOG

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [search-tservice]

  • Tags: [logs]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

POD_NAME

  • Name of the current pod available as an Env var from Kubernetes object metadata.

  • Affected services: [job-service license-service search-tservice rabbitmq-ha]

  • Tags: [kubernetes]

PS_PROFILER_SERVER

  • This contains Pyroscope server address, where the profiling data will be sent.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

PS_PROFILER_SERVICE_NAME

  • This contain Pyroscope application name corresponding to specific service.

  • Affected services: [core-platform-service file-tservice job-service license-service search-tservice]

  • Tags: [pyroscope]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SITE_SETTING_SITE_ADMIN_CAN_ACCESS_ALL_ORGS

  • A site-wide configuration option to allow site admins to access all organizations across the platform.

  • Affected services: [core-platform-service file-tservice search-tservice]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_COLLECTORS

  • List of collectors to run when the stats framework is setup. e.g. fs:–mountPath=/etc,–mountPath=/var/lib,–period=10;collectorX:–arg1=value1,–arg2=value2

  • Affected services: [job-service search-tservice model-service]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

WALKER_POLL_PERIOD_IN_SEC

  • The file-walker’s polling period (in seconds) to determine whether or not to enqueue the next batch of work into the queue.

  • Affected services: [search-tservice]

  • Tags: [document-search]

WALKER_TASK_EXPORTER_TYPE

  • The export endpoint type for the file walker to export index tasks. Valid values: [RABBIT_MQ, MOCK, BLACK_HOLE].

  • Affected services: [search-tservice]

  • Tags: [document-search]

SERVER-NGINX

ALERTMANAGER_BACKEND

  • The URL endpoint for the Alert Manager console.

  • Affected services: [server-nginx]

  • Tags: [nginx, prometheus, stats]

ALL_ALLOWED_HOSTS

  • In order to avoid HTTP host header poisoning, ALL_ALLOWED_HOSTS restricts HTTP host header to a specific set of domain names specified by this env var.

  • Affected services: [server-nginx]

  • Tags: [nginx]

API_SERVER

  • The URL endpoint to api-server for routing requests by server-nginx.

  • Affected services: [server-nginx]

  • Tags: [nginx]

API_SERVER_APPS

  • The URL endpoint to api-server-apps for routing requests by server-nginx.

  • Affected services: [server-nginx]

  • Tags: [nginx]

APPS_SERVER

  • The URL endpoint to apps-server for routing requests by server-nginx.

  • Affected services: [server-nginx]

  • Tags: [nginx]

CONTROL_PLANE_BACKEND

  • The URL endpoint for the control plane HTTP server.

  • Affected services: [server-nginx]

  • Tags: [control-plane]

DYNAMIC_PROXY_URL

  • Specify the web endpoint for dynamic-proxy. All Jupyter Notebook HTTP traffic is routed here.

  • Affected services: [server-nginx]

  • Tags: [notebook]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GRAFANA_BACKEND

  • The URL endpoint for the Grafana webpage for visualizing the time-series/system metric data in server-nginx.

  • Affected services: [server-nginx]

  • Tags: [nginx, prometheus, stats]

INSTABASE_HOSTNAME

  • The Instabase URL hostname (e.g. instabase.com).

  • Affected services: [license-service apps-server webapp api-server server-nginx]

JAEGER_BACKEND

  • The URL endpoint for the Jaeger webpage for tracing information.

  • Affected services: [api-server server-nginx]

  • Tags: [tracing, nginx, api-server-apps]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

PROMETHEUS_BACKEND

  • The URL endpoint for the Prometheus webpage.

  • Affected services: [server-nginx]

  • Tags: [nginx, stats, prometheus]

RABBITMQ_SERVER

  • The URL endpoint for the RabbitMQ management console.

  • Affected services: [server-nginx]

  • Tags: [rabbit-mq, nginx]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

RESOLVER

  • Standard Nginx environment variable to configure DNS host name and is used for resolving hostnames of upstream Instabase services.

  • Affected services: [server-nginx]

  • Tags: [nginx]

SSL_PROTOCOLS

  • Standard Nginx environment variable that specifies the supported SSL protocols. Default values: [TLSv1.2, TLSv1.3]

  • Affected services: [server-nginx]

  • Tags: [nginx]

VMAGENT_BACKEND

  • The URL endpoint for the Vmagent webpage.

  • Affected services: [server-nginx]

  • Tags: [nginx, stats]

WEBAPP

  • The URL endpoint to webapp for routing requests by server-nginx.

  • Affected services: [server-nginx]

  • Tags: [nginx]

ZIPKIN_BACKEND

  • The zipkin URL endpoint for jaeger’s zipkin recieving port

  • Affected services: [server-nginx]

  • Tags: [tracing, nginx]

TABLE-TSERVICE

DB_CONNECTION_POOL_INCREMENT_SIZE

  • For table-service database connections, sets the increment size of the connection pool when new connections are requested

  • Affected services: [table-tservice]

  • Tags: [database]

DB_CONNECTION_POOL_MAX_SIZE

  • For table-service database connections, sets the maximum size of the connection pool

  • Affected services: [table-tservice]

  • Tags: [database]

DB_CONNECTION_POOL_MIN_SIZE

  • For table-service database connections, sets the minimum size of the connection pool

  • Affected services: [table-tservice]

  • Tags: [database]

DB_CONN_MAX_IDLE_TIME_IN_SEC

  • For database connections, the maximum amount of time a connection may be idle.

  • Affected services: [table-tservice]

  • Tags: [database]

DB_CONN_MAX_LIFETIME_IN_SEC

  • For database connections, the maximum amount of time a connection a connection may be reused.

  • Affected services: [table-tservice rabbitmq-ha]

  • Tags: [database]

ORACLE_TNSADMIN_PATH

  • For table-service connections to Oracle DB, specify the path to the tnsnames.ora file

  • Affected services: [table-tservice]

  • Tags: [database]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SERVICE_TABLE_PORT

  • Port for table-service

  • Affected services: [core-platform-service table-tservice apps-server webapp api-server]

WEBAPP

AUDIT_LOGS_EXPORT_ENDPOINT

  • The export endpoint for audit-log events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [core-platform-service job-service apps-server webapp api-server model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

AUTH_ACCOUNT_LOCKOUT_MSG

  • The error message to display when a user gets locked out of their account after exceeding AUTH_LOGIN_MAX_ATTEMPTS login attempts. Default is 5.

  • Affected services: [webapp]

  • Tags: [authentication]

AUTH_ACCOUNT_LOCK_TIMEOUT_IN_SECS

  • The amount of time an account will be locked out after exceeding AUTH_LOGIN_MAX_ATTEMPTS to login to Instabase. Default is 600s.

  • Affected services: [webapp]

  • Tags: [authentication]

AUTH_LOGIN_MAX_ATTEMPTS

  • The max number of login attempts before the user account is locked out.

  • Affected services: [webapp]

  • Tags: [authentication]

AUTH_PROVIDER

  • For AUTH_TYPE=saml, indicate how SAML metadata is provided. If local, metadata is provided in the metadata.xml file, if remote, read metadata from the SAML provider metadata server. Valid values: [local, remote]. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

AUTH_PROVIDER_URI

  • For AUTH_TYPE=saml, and AUTH_PROVIDER=remote, indicate the SAML provider metadata server. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

AUTH_TYPE

  • Indiciate the type of authentication to use for user login. Valid values: [basic, saml, ldap]

  • Affected services: [webapp api-server]

  • Tags: [authentication]

BROKER_URL

  • The Rabbit-MQ URL.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

BUILD_TIMESTAMP

  • The time the release was built at.

  • Affected services: [apps-server webapp api-server]

CACHE_CLIENT_STATS_ENABLED

  • Enable stats collection for client-side caching stats

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats, redis]

CACHE_ENABLE_TLS

  • Whether redis uses mutual TLS or not. Valid values are: [true, false].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_HOST

  • The hostname (without protocol) for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PERSISTENT_HOST

  • The hostname (without protocol) for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PERSISTENT_PORT

  • The port used for Redis with persistence enabled.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis-persistent]

CACHE_PORT

  • The port used for Redis.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PREFIX

  • A prefix to append to all cache keys in Redis.

  • Affected services: [file-tservice apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_PROVIDER

  • The cache provider. Valid values are: [redis].

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CACERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the CA Root Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_CERTFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Certificate file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

CACHE_SSL_KEYFILE

  • For Redis server using mutual TLS (built with BUILD_TLS=yes), specify the path to the Private Key file used by client.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [redis]

EMAIL_PROVIDER

  • Specify the email provider to use. Valid values are: [SMTP, SES]

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP, SES]

ENABLE_CLIENT_SIDE_ENCRYPTION

  • Enable client-side encryption across all Instabase drives by default.

  • Affected services: [apps-server webapp api-server]

  • Tags: [file-system, encryption]

ENABLE_CSP

  • Enables the Content Security Policy header to block XSS attacks in webapp and apps-server

  • Affected services: [apps-server webapp]

ENABLE_LICENSING

  • Enable license-service for License enforcement across the the platform.

  • Affected services: [job-service apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

ENABLE_PROJECT_BUILDER

  • Feature flag that defaults apps to using and expecting projects

  • Affected services: [apps-server webapp api-server]

  • Tags: [flow]

ENABLE_SEARCH

  • Feature flag to enable the Spotlight search features in the UI.

  • Affected services: [apps-server webapp]

ENABLE_Z_PAGES

  • Enable z-pages which expose the internal state of a service to aid debugging.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

ENHANCE_RESPONSE_LOGS_ENABLED

  • Generate enhanced response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

FEEDBACK_EMAIL_ADDRESS

  • The email address for feedback to be sent to on the platform

  • Affected services: [webapp]

FORCE_LOGIN_USERNAME_EMAIL_TO_LOWERCASE

  • If set true, username and email will converted to lower cases when creating the account

  • Affected services: [webapp api-server]

  • Tags: [webapp]

GET_HOSTS_FROM

  • Specify how Kubernetes should determine the hosts for Redis. Valid values: [dns]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server conversion-service search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [redis, Kubernetes]

GOOGLE_CLIENT_ID

  • The client ID from the GCP app used to authenticate users.

  • Affected services: [webapp]

  • Tags: [authentication]

GOOGLE_CLIENT_SECRET

  • The client secret from the GCP app used to authenticate users.

  • Affected services: [webapp]

  • Tags: [authentication]

GRPC_ENABLE_STATS

  • Enable stats for gRPC servers and clients in a service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-core-tasks celery-webdriver-tasks]

  • Tags: [grpc, stats]

GRPC_LB_POLICY_NAME

  • The load balancing policy used by the gRPC client. Default - round robin

  • Affected services: [apps-server webapp api-server celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_RECV_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can receive

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_MAX_SEND_MESSAGE_SIZE_BYTES

  • Maximum message size in bytes a gRPC server or client can send

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [grpc]

GRPC_SERVICE_FILE_HOST

  • Hostname for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GRPC_SERVICE_FILE_PORT

  • Port for grpc-file-service.

  • Affected services: [core-platform-service job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-model-training-worker]

GUNICORN_MAX_REQUESTS

  • Specify the max. number of requests a Gunicorn worker will process before restarting (default is 250)

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_THREADS_COUNT

  • Set the number of threads per Gunicorn worker (default is 50). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

GUNICORN_WORKERS_COUNT

  • Set the number of Gunicorn workers to run (default is 3). This config is only respected if USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

INSTABASE_HOSTNAME

  • The Instabase URL hostname (e.g. instabase.com).

  • Affected services: [license-service apps-server webapp api-server server-nginx]

INSTABASE_URI

  • The Instabase URI hostname (e.g. instabase.com) to be used as the root URLs in API requests.

  • Affected services: [file-tservice license-service apps-server webapp]

  • Tags: [scheduler]

LDAP_BASE_DN

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_CACERT_FILE

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_DELIMITER

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_ENABLE_TLS

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_IGNORE_TLS_CERT_VALIDATION

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_PORT

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_PROTOCOL_VERSION

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_SERVER

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_TIMEOUT

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_TRACE_LEVEL

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_USER_ATTRIBUTE

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LDAP_USER_SEARCH_FILTER

  • Affected services: [webapp]

  • Tags: [authentication, ldap]

LOG_LEVEL

  • The Log level for logs within the service. Valid values are: FATAL, WARNING, ERROR, INFO, DEBUG.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server ocr-service conversion-service search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

LOG_PARSER

  • This specifies the log parser to be used inside fluent-bit for log parsing.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis redis-persistent celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

LOG_RESPONSE_DATA_ENABLED

  • Enable response logging in webservers.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

METRICS_EXPORT_ENDPOINT

  • The export endpoint for metric events to be sent to. Valid values: [RABBIT_MQ, BLACK_HOLE].

  • Affected services: [apps-server webapp api-server model-service celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

NAMESPACE

  • Used for making namespace available as environment variable. Set using kubernetes object metadata.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [rabbit-mq]

NO_REPLY_EMAIL_ADDRESS

  • For emails origination from the platform, the no-reply email address to send from.

  • Affected services: [apps-server webapp celery-app-tasks]

  • Tags: [email]

OBS_ENABLE_LOG_AGGREGATION

  • Log aggregation tooling support inside pods

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service rabbitmq rabbitmq-ha redis celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

  • Tags: [logs]

RABBIT_MQ_PASSWORD

  • Specify the password for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_PORT

  • Specify the port for connecting to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_URL

  • Specify the hostname/URL to RabbitMQ.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RABBIT_MQ_USERNAME

  • Specify the username for connecting to RabbitMQ.

  • Affected services: [file-tservice job-service license-service apps-server webapp search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [rabbit-mq]

RELEASE_VERSION

  • The Instabase platform release version.

  • Affected services: [core-platform-service file-tservice table-tservice job-service license-service apps-server webapp api-server ocr-service ocr-msft-v3 ocr-msft-form-recognizer-layout ocr-msft-lite conversion-service search-tservice model-service redis redis-persistent opensearch celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker server-nginx]

SAML_ALLOW_UNSOLICITED

  • With AUTH_TYPE=saml, for SP instances, if set to true, the SP will consume unsolicited SAML responses for which it has not sent a respective SAML Authentication Request. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_AUTHN_REQUESTS_SIGNED

  • With AUTH_TYPE=saml, for SP instances, a boolean flag to indicate if the Authentication Requests sent by this SP should be signed by default. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_CA_CERTS_FILE

  • With AUTH_TYPE=saml, this is the path to a file containing roto CA certificates for SSL server certificate validation. This is an optional parameter, the default value is an empty string.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_CERT_FILE

  • With AUTH_TYPE=saml, this is the public part of the service private/public key pair. The file must be PEM formatted file with a single certificate. This is an optional parameter, the default value is an empty string.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_HTTPS_ACS_URL

  • With AUTH_TYPE=saml, the URL where SAML provider redirects after the user successfully authenticates. For example, http:///account/sso/saml2. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_HTTP_ACS_URL

  • With AUTH_TYPE=saml, the URL where SAML provider redirects after the user successfully authenticates. For example, https:///account/sso/saml2. Note that this should be the https URL. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_KEY_FILE

  • With AUTH_TYPE=saml, this is the name of a PEM formatted file that contains the private key of the service. This is currently used both to encrypt/sign assertions and as the client key in an HTTPS session. This is an optional parameter, the default value is an empty string.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_LOGOUT_REQUESTS_SIGNED

  • With AUTH_TYPE=saml, indicates if this entity will sign the Logout Requests originated from it. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_OPTIONAL_ATTRIBUTES

  • With AUTH_TYPE=saml, the optional email, uid attributes provided to Instabase by SAML. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_REQUIRED_ATTRIBUTES

  • With AUTH_TYPE=saml, the required email, uid attributes provided to Instabase by SAML. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_SP_ENTITY_ID

  • With AUTH_TYPE=saml, the entity-id that was configured in SAML. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_SP_NAME

  • With AUTH_TYPE=saml, the label associated with the Instabase entity in SAML (InstabaseSP)

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_VERIFY_SSL_CERT

  • With AUTH_TYPE=saml, specifies if the SSL certificates should be verified. Can be True or False. The default configuration is False.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_WANT_ASSERTIONS_SIGNED

  • With AUTH_TYPE=saml, boolean flag that indicates that the assertions contained within the response to this SP must be signed. Default is true. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SAML_WANT_RESPONSE_SIGNED

  • With AUTH_TYPE=saml, boolean flag that indicates that the Authentication Response to this SP must be signed. Default is false. See SAML documentation for details.

  • Affected services: [webapp]

  • Tags: [authentication, saml]

SERVICE_ACCOUNT_HOST

  • Hostname for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_ACCOUNT_PORT

  • Port for grpc account-tservice.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

SERVICE_MOUNT_HOST

  • Hostname for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_MOUNT_PORT

  • Port for grpc mount service.

  • Affected services: [file-tservice apps-server webapp api-server celery-app-tasks]

SERVICE_REPO_HOST

  • Hostname for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_REPO_PORT

  • Port for gRPC repo service.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

SERVICE_TABLE_HOST

  • Hostname for table-service.

  • Affected services: [core-platform-service apps-server webapp api-server]

SERVICE_TABLE_PORT

  • Port for table-service

  • Affected services: [core-platform-service table-tservice apps-server webapp api-server]

SESSION_AUTO_TIMEOUT_MINUTES

  • If USE_SESSION_AUTO_TIMEOUT is true, this specifies the duration a user session will stay active before the session expires.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]

SESSION_SECRET_KEY

  • The key used to sign generated session keys for user login.

  • Affected services: [core-platform-service apps-server webapp api-server]

SES_ACCESS_KEY_ID

  • If the EMAIL_PROVIDER=ses, then specify the AWS Access Key ID for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_REGION_NAME

  • If the EMAIL_PROVIDER=ses, then specify the AWS Region for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SES_SECRET_ACCESS_KEY

  • If the EMAIL_PROVIDER=ses, then specify the AWS Secret Access Key for the account with permissions to SES.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SES]

SITE_SETTING_DISABLE_SIGNUP

  • A site-wide configuration option to disallow account signup.

  • Affected services: [apps-server webapp api-server]

SITE_SETTING_DISALLOW_LOGIN_WITH_NO_ORGS

  • A site-wide configuration option to disallow users from logging in if they are not a member of any organization.

  • Affected services: [webapp]

SMTP_HOSTNAME

  • If the EMAIL_PROVIDER=smtp, then specify the hostname of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

SMTP_PORT

  • If the EMAIL_PROVIDER=smtp, then specify the port of the SMTP server.

  • Affected services: [apps-server webapp celery-app-tasks celery-webdriver-tasks]

  • Tags: [email, SMTP]

STATS_AGENT

  • Beckend agent for stats aggregation and exposition in stats framework

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_ENABLE

  • Enable stats collection from the service if the stats framework is setup.

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service rabbitmq-ha celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats]

STATS_GRPC_ENABLED

  • Enable stats collection for GRPC services.

  • Affected services: [license-service apps-server apps-server webapp webapp api-server api-server model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

  • Tags: [stats, grpc]

STATS_HTTP_ENABLED

  • Enable http stats collection for web services.

  • Affected services: [apps-server webapp api-server]

  • Tags: [stats]

STATS_SERVICE_NAME

  • If stats collection is enabled, the name of the service to tag in stats exported from the service

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server apps-server webapp webapp api-server api-server search-tservice model-service model-service celery-app-tasks celery-app-tasks celery-core-tasks celery-core-tasks celery-webdriver-tasks celery-webdriver-tasks]

STATS_THRIFT_BUCKET_DISTRIBUTION_MULTIPLIER

  • Multiplier used for constructing histogram buckets for capturing stats data for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_ENABLED

  • Enable stats collection for Thrift services.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

STATS_THRIFT_MESSAGE_SIZE_ENABLED

  • Enable stats collection for request/response size for Thrift service

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-webdriver-tasks]

  • Tags: [stats, thrift]

TRACER_SAMPLER_TYPE

  • For tracing, configures the method of sampling. Valid values are: [const, probabilistic, ratelimiting, remote]

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_SVC_NAME

  • For tracing, the name of the service being traced (e.g. api-server-apps)

  • Affected services: [core-platform-service file-tservice job-service license-service apps-server webapp api-server search-tservice model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing]

TRACER_TYPE

  • For tracing, specify the tracer type. Valid values are: [null, jaeger]. null is equivalent to disabling tracing.

  • Affected services: [job-service apps-server webapp api-server model-service celery-app-tasks celery-core-tasks celery-webdriver-tasks ray-head ray-model-training-worker]

  • Tags: [tracing, jaeger]

TWILIO_ACCOUNT_SID

  • If integrating user login with Twilio for MFA authentication, specify the Twilio Account SID.

  • Affected services: [webapp]

  • Tags: [authentication]

TWILIO_AUTH_TOKEN

  • If integrating user login with Twilio for MFA authentication, specify the Twilio Auth Token.

  • Affected services: [webapp]

  • Tags: [authentication]

TWILIO_FROM_NUMBER

  • If integrating user login with Twilio for MFA authentication, specify the Twilio phone number to send from.

  • Affected services: [webapp]

  • Tags: [authentication]

UPLOAD_CHUNK_THRESHOLD_IN_MB

  • The upload chunk size in MB for uploads to Instabase file-system via the webapp/UI

  • Affected services: [webapp]

  • Tags: [file-system]

USE_CPP_IBDOC_CONVERSION

  • Disable python conversion of .ibdoc to JSON and uses cpp module for .ibdoc conversion.

  • Affected services: [apps-server webapp]

USE_GEVENT

  • Enable Python green-threads for Flask, Thrift and GRPC.

  • Affected services: [apps-server webapp api-server celery-app-tasks celery-core-tasks celery-webdriver-tasks]

  • Tags: [gunicorn]

USE_GUNICORN

  • Enable Gunicorn to serve Flask apps instead of Gevent. USE_GEVENT needs to be False when USE_GUNICORN=True

  • Affected services: [apps-server webapp api-server]

  • Tags: [gunicorn]

USE_NTBK

  • Whether or not Jupyter notebooks are enabled. This flag also determines if CSRF is used.

  • Affected services: [apps-server webapp api-server]

  • Tags: [notebook]

USE_SESSION_AUTO_TIMEOUT

  • Flag to indicate whether or not user sessions should expire after SESSION_AUTO_TIMEOUT_MINUTES and force users to re-login.

  • Affected services: [apps-server webapp api-server]

  • Tags: [authentication]