Install considerations

Install with defaults Copied

Important

This information refers to the previous helm install method. For the streamlined Kubernetes Off-the-Shelf (KOTS) method, you can select the apps you want to install during Platform installation.
helm install obcerv-app-query-service itrs/obcerv-app-query-service \
     --version <version number> -n <namespace> --wait

Install with overrides Copied

The Query Service consists of three workloads, all of which are Kubernetes Deployments/ReplicaSets:

  1. Create a chart config file, named app.yaml containing content similar to:
bff:   
  threadPoolSize: 20
  resources: 
    requests: 
      memory: "512Mi"
      cpu: "200m"
    limits: 
      memory: "2Gi"
      cpu: "1"
sink:
   resources: 
    requests: 
      memory: "512Mi"
      cpu: "200m"
    limits: 
      memory: "3Gi"
      cpu: "2" 
db:
  resources: 
    requests: 
      memory: "4Gi"
      cpu: "1"
    limits: 
      memory: "8Gi"
      cpu: "4"
  1. To install the chart, run:
helm install -f app.yaml obcerv-app-query-service itrs/obcerv-app-query-service
  --version <version number> -n <namespace> --wait

Storage Copied

The Persistent Volume Claims (PVC) used by the Query Service are:

PVC Mount
app-query-service-data /data
app-query-service-wal /wal

The allocated storage can be changed by modifying the PVCs in Kubernetes, or the defaults can be overridden at install time by setting db.dataDiskSize and db.walDiskSize in the chart config file.

db:
  dataDiskSize: 20Gi
  walDiskSize: 5Gi

Storage class Copied

It is recommended to use a dedicated, high-performance disk for the Query Service database. If not specified, the Query Service DB will use the default storage class defined for the cluster.

To change the storage class, set both dataStorageClass and walStorageClass in the values file.

db:
 dataStorageClass: "<name of the storage class>"
 walStorageClass: "<name of the storage class>"

Resource allocation Copied

The app deploys a query service and a database with the following default resource allocations:

bff:   
  threadPoolSize: 20
  resources: 
    requests: 
      memory: "512Mi"
      cpu: "200m"
    limits: 
      memory: "2Gi"
      cpu: "1"
db:
  resources: 
    requests: 
      memory: "4Gi"
      cpu: "1"
    limits: 
      memory: "8Gi"
      cpu: "4"

The following additional parameters are available:

Batch processing Copied

The following additional parameters for sink are available:

  sink:
      batchSize: 1000
      queueSize: 100000
      attributeLookbackPeriod: P7D

Queue size Copied

Since each queue has a different data source, the volume of data largely differs. You can separately configure queue size parameters for entities, attributes, and signals.

The following additional parameters for sink are available:

  sink:
    queue:
      entities: 100000
      attributes: 500000
      signals: 100000
["ITRS Analytics"] ["ITRS Analytics > App Query Service"] ["Technical Reference"]

Was this topic helpful?