Platform Engineering

Appearance

GuanceDB Starting Arguments Reference ​

This document provides comprehensive reference information for GuanceDB application starting arguments and configuration options.

guance-select Arguments ​

storageNode (Required when streamaggr.enabled is true) ​

Purpose: Specifies the actual instances of guance-storage for stream aggregation functionality.

Configuration: Set via guance-select.extraArgs

Values:

  • VM deployment: <storage-node-1-ip>:8401, <storage-node-2-ip>:8401
  • Kubernetes deployment: <storage-pod-fqdn-1>:8401, <storage-pod-fqdn-2>:8401

Important: When deployed on Kubernetes, use the actual FQDN of the pod, NOT the headless service IP.

guance-insert Arguments ​

--fileQueue.workers ​

Purpose: Determines the number of concurrent write workers that guance-insert spins up to write to scopedb-ingest.

Default Behavior: Automatically calculated using the following logic (lines 91-104 of StatefulSet):

  1. Only sets --fileQueue.workers if:
    • ScopeDB is enabled AND
    • The parameter isn't already provided in extraArgs
  2. Finds the "ingest" nodegroup from scopedb.nodegroups
  3. Calculates: ceil((ingest_nodegroup_replicas × ingest_nodegroup_cpu_limit) ÷ guance_insert_replicas)

Manual Override: When replica counts of scopedb-ingest change due to HPA, manual configuration may be required.

Configuration: Set in extraArgs within the values.yaml file.

Reference: See this commit example for implementation details.

Configuration Best Practices ​

  • Monitor scopedb-ingest replica changes when using HPA
  • Verify storageNode endpoints are accessible before deployment
  • Test configuration changes in staging environments first
  • Review calculated --fileQueue.workers values against actual cluster capacity