OnlineFS values#

Values under onlinefs configure OnlineFS, which consumes feature rows from Kafka and writes them to RonDB.

Generated from the Hopsworks Helm chart 5.2.0-alpha-1791549041 (Hopsworks 5.2.0).

Always deployed.

General#

Defaults as YAML

onlinefs:
  apiKey:
    email: onlinefs@hopsworks.ai
    password: onlinefspw
    secret_name: onlinefs-api-key-auth
  appName: onlinefs
  configmap:
    name: onlinefs-configmap
  debug: false
  hopsworkslib: {}
  hpa:
    enabled: false
    maxReplicas: 5
    targetCPUUtilizationPercentage: 80
    targetMemoryUtilizationPercentage: 80
  nodeSelector: {}
  podDisruptionBudget:
    enabled: true
    minAvailable: 1
  serviceAccount:
    annotations: {}
    create: true
    name: onlinefs-default
  setupBackOffLimit: 10
  tlscerts:
    commonName: ''
    locality: onlinefs
  tolerations: []
  topologySpreadConstraint: {}

onlinefs #: Type object, default {"debug":false}. override onlinefs values
onlinefs.apiKey.email #: Type string, default "onlinefs@hopsworks.ai".
onlinefs.apiKey.password #: Type string, default "onlinefspw".
onlinefs.apiKey.secret_name #: Type string, default "onlinefs-api-key-auth".
onlinefs.appName #: Type string, default "onlinefs".
onlinefs.configmap.name #: Type string, default "onlinefs-configmap".
onlinefs.debug #: Type bool, default false.
onlinefs.hopsworkslib #: Type object, default {}. override hopsworkslib values
onlinefs.hpa.enabled #: Type bool, default false. Autoscale the Deployment with an HPA. While enabled, deployment.replicas is not rendered and the HPA owns spec.replicas.
onlinefs.hpa.maxReplicas #: Type int, default 5.
onlinefs.hpa.targetCPUUtilizationPercentage #: Type int, default 80.
onlinefs.hpa.targetMemoryUtilizationPercentage #: Type int, default 80.
onlinefs.nodeSelector #: Type object, default {}. node selector configuration
onlinefs.podDisruptionBudget.enabled #: Type bool, default true.
onlinefs.podDisruptionBudget.minAvailable #: Type int, default 1.
onlinefs.serviceAccount.annotations #: Type object, default {}. service account annotations
onlinefs.serviceAccount.create #: Type bool, default true.
onlinefs.serviceAccount.name #: Type string, default "onlinefs-default".
onlinefs.setupBackOffLimit #: Type int, default 10.
onlinefs.tlscerts.commonName #: Type string, default "".
onlinefs.tlscerts.locality #: Type string, default "onlinefs".
onlinefs.tolerations #: Type list, default [].
onlinefs.topologySpreadConstraint #: Type object, default {}. The default topology spread constraint. If not defined the global topology spread constraint would be used instead.

configmapOverrides#

Defaults as YAML

onlinefs:
  configmapOverrides:
    kafka: {}
    kafkaVectorDb: {}
    log4j: {}
    onlinefssite:
      hopsworks:
        tokenLocation: /onlinefs/etc/token
      kafkaConsumer:
        pollTimeoutMs: 1000
        topicList: ''
        topicPattern: .*_onlinefs
      rondb:
        batchSize: 300
        maxCachedInstances: 1024
        maxCachedSessions: 20
        maxTransactions: 1024
        poolSize: 1
        reconnectTimeout: 5
        useDynamicObjectCache: false
        useSessionCache: false
      service:
        featureGroupCacheExpire: 30
        featureStoreCacheExpire: 30
        featureViewCacheExpire: 10
        getSessionRetrySleepMs: 100
        maxBlacklistSize: 100
        maxFeatureGroupCacheSize: 1000
        maxFeatureStoreCacheSize: 1000
        maxFeatureViewCacheSize: 1000
        pauseRetrySleepMs: 5000
        ronDbThreadNumber: 10
        threadNumber: 10
        vectorDbThreadNumber: 10
    producer: {}

onlinefs.configmapOverrides.kafka #: Type object, default {}. Extra properties to add or overwrite in onlinefs-kafka.properties
onlinefs.configmapOverrides.kafkaVectorDb #: Type object, default {}. Extra properties to add or overwrite in onlinefs-kafka-vector-db.properties
onlinefs.configmapOverrides.log4j #: Type object, default {}. Extra properties to add or overwrite in log4j.properties
onlinefs.configmapOverrides.onlinefssite.hopsworks.tokenLocation #: Type string, default "/onlinefs/etc/token".
onlinefs.configmapOverrides.onlinefssite.kafkaConsumer.pollTimeoutMs #: Type int, default 1000.
onlinefs.configmapOverrides.onlinefssite.kafkaConsumer.topicList #: Type string, default "".
onlinefs.configmapOverrides.onlinefssite.kafkaConsumer.topicPattern #: Type string, default ".*_onlinefs".
onlinefs.configmapOverrides.onlinefssite.rondb.batchSize #: Type int, default 300.
onlinefs.configmapOverrides.onlinefssite.rondb.maxCachedInstances #: Type int, default 1024.
onlinefs.configmapOverrides.onlinefssite.rondb.maxCachedSessions #: Type int, default 20.
onlinefs.configmapOverrides.onlinefssite.rondb.maxTransactions #: Type int, default 1024.
onlinefs.configmapOverrides.onlinefssite.rondb.poolSize #: Type int, default 1.
onlinefs.configmapOverrides.onlinefssite.rondb.reconnectTimeout #: Type int, default 5.
onlinefs.configmapOverrides.onlinefssite.rondb.useDynamicObjectCache #: Type bool, default false.
onlinefs.configmapOverrides.onlinefssite.rondb.useSessionCache #: Type bool, default false.
onlinefs.configmapOverrides.onlinefssite.service.featureGroupCacheExpire #: Type int, default 30.
onlinefs.configmapOverrides.onlinefssite.service.featureStoreCacheExpire #: Type int, default 30.
onlinefs.configmapOverrides.onlinefssite.service.featureViewCacheExpire #: Type int, default 10.
onlinefs.configmapOverrides.onlinefssite.service.getSessionRetrySleepMs #: Type int, default 100.
onlinefs.configmapOverrides.onlinefssite.service.maxBlacklistSize #: Type int, default 100.
onlinefs.configmapOverrides.onlinefssite.service.maxFeatureGroupCacheSize #: Type int, default 1000.
onlinefs.configmapOverrides.onlinefssite.service.maxFeatureStoreCacheSize #: Type int, default 1000.
onlinefs.configmapOverrides.onlinefssite.service.maxFeatureViewCacheSize #: Type int, default 1000.
onlinefs.configmapOverrides.onlinefssite.service.pauseRetrySleepMs #: Type int, default 5000.
onlinefs.configmapOverrides.onlinefssite.service.ronDbThreadNumber #: Type int, default 10.
onlinefs.configmapOverrides.onlinefssite.service.threadNumber #: Type int, default 10.
onlinefs.configmapOverrides.onlinefssite.service.vectorDbThreadNumber #: Type int, default 10.
onlinefs.configmapOverrides.producer #: Type object, default {}. Extra properties to add or overwrite in producer.properties

dependencies#

Defaults as YAML

onlinefs:
  dependencies:
    glassfish:
      consulServiceName: glassfish
      consulServiceTag: hopsworks
      port: 8182
    kafka:
      consulServiceName: kafka
      consulServiceTag: broker
      port: 9092
      securityProtocol: SSL
      url: ''
    mgmd:
      consulServiceName: mgmd
      port: 1186
      url: ''
    opensearch:
      consulServiceName: elastic
      consulServiceTag: rest
      port: 9200

onlinefs.dependencies.glassfish.consulServiceName #: Type string, default "glassfish".
onlinefs.dependencies.glassfish.consulServiceTag #: Type string, default "hopsworks".
onlinefs.dependencies.glassfish.port #: Type int, default 8182.
onlinefs.dependencies.kafka.consulServiceName #: Type string, default "kafka".
onlinefs.dependencies.kafka.consulServiceTag #: Type string, default "broker".
onlinefs.dependencies.kafka.port #: Type int, default 9092.
onlinefs.dependencies.kafka.securityProtocol #: Type string, default "SSL". Kafka security.protocol. PLAINTEXT or SSL
onlinefs.dependencies.kafka.url #: Type string, default "". The Kafka Brokers URL (can be comma-separated urls with port or a single url), if not set the consul DNS name will be used
onlinefs.dependencies.mgmd.consulServiceName #: Type string, default "mgmd".
onlinefs.dependencies.mgmd.port #: Type int, default 1186.
onlinefs.dependencies.mgmd.url #: Type string, default "". The mgmd URL, if not set the consul DNS name will be used
onlinefs.dependencies.opensearch.consulServiceName #: Type string, default "elastic".
onlinefs.dependencies.opensearch.consulServiceTag #: Type string, default "rest".
onlinefs.dependencies.opensearch.port #: Type int, default 9200.

deployment#

Defaults as YAML

onlinefs:
  deployment:
    env:
      JAVA_OPTS: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:9029
    name: onlinefs-deployment
    ports:
      debug: 9029
      monitor: 12800
    replicas: 1
    resources:
      limits:
        cpu: '4'
        memory: 4096Mi
      requests:
        cpu: '2'
        memory: 1024Mi
    strategy: {}
    vectordb:
      enabled: true

onlinefs.deployment.env.JAVA_OPTS #: Type string, default "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:9029".
onlinefs.deployment.name #: Type string, default "onlinefs-deployment".
onlinefs.deployment.ports.debug #: Type int, default 9029.
onlinefs.deployment.ports.monitor #: Type int, default 12800.
onlinefs.deployment.replicas #: Type int, default 1. Number of replicas. Not rendered while hpa.enabled is true: the HPA then owns spec.replicas and this value is its minReplicas. Turning the HPA on for a running release drops the Deployment to 1 once, until the HPA scales it back up.
onlinefs.deployment.resources.limits.cpu #: Type string, default "4".
onlinefs.deployment.resources.limits.memory #: Type string, default "4096Mi".
onlinefs.deployment.resources.requests.cpu #: Type string, default "2".
onlinefs.deployment.resources.requests.memory #: Type string, default "1024Mi".
onlinefs.deployment.strategy #: Type object, default {}. spec.strategy of the Deployment, rendered as given when set. Left empty, two or more replicas roll out by terminating a pod before creating its replacement (maxSurge 0, maxUnavailable 1), so an upgrade completes on a node pool with no room for an extra pod, and a single replica keeps the Kubernetes default. Set it explicitly for a single-replica install whose node pool cannot fit a surge pod, or to keep surge-first behaviour on an install with spare capacity that would rather not drop a consumer during a rollout.
onlinefs.deployment.vectordb.enabled #: Type bool, default true.

rbac#

Defaults as YAML

onlinefs:
  rbac:
    annotations: {}
    create: true
    extraRoleRules: []
    name: onlinefs-role
    useExistingRole: false

onlinefs.rbac.annotations #: Type object, default {}. rbac annotations
onlinefs.rbac.create #: Type bool, default true.
onlinefs.rbac.extraRoleRules #: Type list, default [].
onlinefs.rbac.name #: Type string, default "onlinefs-role".
onlinefs.rbac.useExistingRole #: Type bool, default false.

service#

Defaults as YAML

onlinefs:
  service:
    debug:
      annotations:
        consul.hashicorp.com/service-name: onlinefs
        consul.hashicorp.com/service-tags: debug
      name: onlinefs-debug
      port: 9029
    monitoring:
      annotations:
        consul.hashicorp.com/service-name: onlinefs
        consul.hashicorp.com/service-tags: monitor
        prometheus.io/path: /metrics
        prometheus.io/port: 12800
        prometheus.io/scheme: http
        prometheus.io/scrape: 'true'
      name: onlinefs-monitor
      port: 12800

onlinefs.service.debug.annotations."consul.hashicorp.com/service-name" #: Type string, default "onlinefs".
onlinefs.service.debug.annotations."consul.hashicorp.com/service-tags" #: Type string, default "debug".
onlinefs.service.debug.name #: Type string, default "onlinefs-debug".
onlinefs.service.debug.port #: Type int, default 9029.
onlinefs.service.monitoring.annotations."consul.hashicorp.com/service-name" #: Type string, default "onlinefs".
onlinefs.service.monitoring.annotations."consul.hashicorp.com/service-tags" #: Type string, default "monitor".
onlinefs.service.monitoring.annotations."prometheus.io/path" #: Type string, default "/metrics".
onlinefs.service.monitoring.annotations."prometheus.io/port" #: Type int, default 12800.
onlinefs.service.monitoring.annotations."prometheus.io/scheme" #: Type string, default "http".
onlinefs.service.monitoring.annotations."prometheus.io/scrape" #: Type string, default "true".
onlinefs.service.monitoring.name #: Type string, default "onlinefs-monitor".
onlinefs.service.monitoring.port #: Type int, default 12800.