Skip to content

Instances

Key Value
type object
relationship Package -> Database -> Shard -> Dap -> Instances
object path $.databases[*].shards[*].daps.instances.*
package file path {package-root}/databases/{db-name}/shards/{shard-name}.yaml

Fields

Field Type Required Description Constraints Default
allowPartialResults boolean | null no Allows partial results to be sent to Aggregators while DAPs are in low memory mode. - true
annotations Annotations | null no Annotations to apply to resources created from DA - null
args array<string> | null no Args defines the arguments to be passed to the container's entrypoint. See https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/ - null
config map<string, string > | null no Additional configuration to be applied to Data Access Assembly element - null
customFile string | null no Path to optional custom file to be loaded by DA instance pattern: "^(\\/\|\\$[a-z0-9]([-a-z0-9]*[a-z0-9])?)[a-zA-z0-9_.\\/-]*.q[_]?$" null
enforceSchema boolean | null no Validates schemas as they arrive but at a cost to performance - false
env array<EnvItem> | null no Env provides a list of environment variable to inject into the container. See https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/ - null
gwEndpoints array<GwEndpoint> | null no List of hostname:port strings of known gateways, if the discovery service is unavailable - null
image Image | null no Data Access image details - null
k8sPolicy K8sPolicy | null no Kubernetes specific configurations for element Pods - {"serviceAccountConfigure": {"create": true}}
lateData boolean | null no Filter data feed to records within 'purview' of instance - null
mapPartitions boolean | null no Indicates if partitions should mapped into memory on reload with .Q.MAP - false
mountList array<MountListItem> | null no Where DA is a Collective DA instance, allow for multiple Volume Mounts for each listed mount max items: 3 null
mountName string | null no Where DA is a Legacy DA instance, create Volume Mount for given mountName pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" null
name string | null no Data Access Instance name pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$", min length: 2, max length: 15 null
opEnabled boolean | null no Whether to enable the data access operator - null
opHost string | null no Host of operator process pattern: "^[a-z0-9]+[a-z0-9.-]*[a-z0-9]+$" null
opPort integer | null no Port of operator process min: 1, exclusive max: 65536 null
par string | null no Path to par.txt file within Pod or in Cloud Storage pattern: "^(file:\\/\\/\\/\|s3:\\/\\/\|gs:\\/\\/\|ms:\\/\\/){1}[a-zA-Z0-9\\/-]*(par.txt){1}$" null
pctMemThreshold PctMemThreshold1 | integer | null no Float 0-1, configuring at which percentage of memory utilization the DA should do an emergency flush to IDB - null
port integer | null no Data Access container port min: 1, exclusive max: 65534 null
purview string | null no Inclusive start, exclusive end purview for startup of DA process - null
rtLogVolume RtLogVolume | null no RT Logs volume - {"mountPath": "/logs/rt/"}
sideCarConfig SideCarConfig | null no Sidecar Config Map Details - null
size integer | null no Size defines the desired number of pods. This is a pointer to distinguish between explicit zero and not specified. min: 0 3
source string | null no Sequencer Bus to subscribe to. 'source' is used to look up sequencers defined within the Assembly 'elements.sequencer' or 'bus' fields. If 'source' is not located, it is assumed to be an existing Sequencer name, external to the Assembly. pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" null
storageManager string | null no Storage Manager name pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+-{1}(0{1}\|[1-9]{1,3})$" null
storageURI string | null no Path to database in Cloud Storage pattern: "^(s3:\\/\\/\|gs:\\/\\/\|ms:\\/\\/){1}[a-zA-Z0-9\\/-]*$" null
sym string | null no Path to sym file within Pod or in Cloud Storage pattern: "^(file:\\/\\/\\/\|s3:\\/\\/\|gs:\\/\\/\|ms:\\/\\/){1}[a-zA-Z0-9\\/-]*(sym){1}$" null
tableLoad TableLoad | null no How to populate in-memory database tables. Support for empty, splay, and links - null
volumeMounts array<VolumeMount> | null no Mount volumes external to Assembly as defined within spec.Volumes - null

Used In

  • Dap via instances
Back to top