Skip to content

Sequencer

Key Value
type object
relationship Package -> Database -> Shard -> Sequencer
object path $.databases[*].shards[*].sequencers.*
package file path {package-root}/databases/{db-name}/shards/{shard-name}.yaml
cli commands kxi package add --to $PKG stream --name $STREAM
kxi package rm --from $PKG stream --name $STREAM

Fields

Field Type Required Description Constraints Default
external boolean yes External facing Sequencer, setting true enables External IP - -
annotations Annotations | null no Annotations to apply to resources created from Sequencer - 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
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
externalNodePort boolean | null no Use Node Port Type for Externally facing Sequencer service - null
image Image | null no Sequencer image details - null
k8sPolicy K8sPolicy | null no Kubernetes specific configurations for element Pods - {"serviceAccountConfigure": {"create": true}}
maxDiskUsagePercent integer | null no Maximum percentage of the available disk space that will be used by RT. When this percentage is exceeded rolled merged log files are garbage collected, oldest first. exclusive min: 0, exclusive max: 100 90
maxLogSize string | null no Maximum size of all log files in RT. Rolled merged log files which push the total size beyond this limit are garbage collected, oldest first. pattern: "^([+-]?[0-9.]+)([eEinukmgtpKMGTP]*[-+]?[0-9]*)$" null
metadata ComponentMetadata | null no - - null
name string | null no Sequencer instance name pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" null
retentionDuration integer | null no Retention period for merged RT stream log files in minutes. Rolled merged log files which contain messages older than this (based on the message timestamp) are garbage collected min: 0 null
sideCarConfig SideCarConfig | null no Sidecar Config Map Details - null
sideCarOverrides SideCarOverrides | null no Override Enabling Sidecar for Sequencer instance - null
size Size | null no Size defines the desired number of pods. This is a pointer to distinguish between explicit zero and not specified. - 3
staticIPs array<string> | null no Optional list of IPs to append to the External RT LoadBalancers - null
topicConfig TopicConfig | null no Sequencer Topic Prefix - {"topicPrefix": "rt-"}
topicConfigDir string | null no Location of RT 'pull' directory pattern: "^\\/+([a-zA-Z0-9_.-]+\\/*)+$" "/config/topics/"
useInternalLBAnnotations boolean | null no Apply Service Annotations to set LoadBalancer Service as internal only - null
uuid string | null no - format: "uuid" -
volume Volume | null no RT Sequencer directory paths - {"mountPath": "/s/"}
volumeMounts array<VolumeMount> | null no Mount volumes external to Assembly as defined within spec.Volumes - null

Used In

Back to top