Skip to content

Configuration reference

A charts values file may be made up of multiple key:values. Some of these may be replicated across other component charts.

When using the umbrella chart, values can be within each component’s values file or set per chart from within the kx chart values file.

This requires a field such as image.tag to be updated in multiple places on a new image release.

Alternatively the need to replicate the configuration changes across subcharts can be solved using globals with the aid of helper functions.

Within the kx and subcharts the following global have been defined.

key type
default
description
global.env object
{}
optionally add key-value pairs for environment variable to be added to container
global.image.pullPolicy string
"IfNotPresent"
image pull policy
global.image.repository string
"gcr.io/cloudpak/"
repository containing component images
global.image.tag string
0.2.1
component image tag
global.license.email string
""
KX license user email
global.license.user string
""
KX license user name
global.metrics.enabled bool
false
enable the capture of instance metrics
global.metrics.image.pullPolicy string
"IfNotPresent"
image pull policy
global.metrics.image.repository string
"gcr.io/cloudpak/"
repository containing component images
global.metrics.image.tag string
0.2.1
component image tag
global.metrics.serviceMonitor.enabled bool
false
enable service monitor
global.objectstore object
{}
configuration for use of object stores in HDB par.txt
global.objectstore.buckets list
[]
list one or many object store paths; each appended to the par.txt file
global.objectstore.enabled bool
false
append object store paths to par.txt file
global.objectstore.sym object
{}
configuration of the object store backup sym file and local sym file
global.objectstore.sym.cp bool
false
if sym is not found locally, true enable the copy from object store
global.objectstore.sym.name string
sym
local sym file name on disk, copied object store file will be wrote to disk under this name
global.objectstore.sym.path string
""
full path to object store sym file back up location
global.persistence.shared.enabled bool
false
enable shared storage between pods
global.persistence.storageClass string
"nfs-client"
persistence storage class
global.rbac.create bool
false
create RBAC Role and RoleBinding
global.skaffold bool
false
use Skaffold for image tags

kx

Version: 0.3.0 Type: application AppVersion: 4.0.0

kdb+

Has no values itself, only requirements.

repository name version
file://../gw gw 0.3.0
file://../hdb hdb 0.3.0
file://../rdb rdb 0.3.0
file://../tp tp 0.3.0

gw parameters

Version: 0.3.0 Type: application AppVersion: 4.0

Gateway configuration is defined and configurable via .../charts/gw/values.yaml

key
type
default
description
gw.affinity
object
{}
Pod Affinity rules for assigning a pod to a node
gw.autoscaling.enabled
bool
false
enable pod autoscaling
gw.autoscaling.maxReplicas
int
100
Max Replica Count permitted
gw.autoscaling.minReplicas
int
1
Minimum Replica Count permitted
gw.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
gw.autoscaling.targetMemoryUtilizationPercentage
int
80
max memory utilization metric value before autoscaling is triggered
gw.connections.hdb1.host
string
"kx-hdb-0.kx-hdb.default.svc"
host address of target instance
gw.connections.hdb1.port
int
5010
port of target instance
gw.connections.hdb1.type
string
"historical"
instance type, used for gateway API targeting
gw.connections.hdb1
object
{}
custom key, containing connection details for instance: used as alias to specified connection
gw.connections.rdb1.host
string
"kx-rdb-0.kx-rdb.default.svc"
host address of target instance
gw.connections.rdb1.port
int
5020
port of target instance
gw.connections.rdb1.type
string
"realtime"
instance type, used for gateway API targeting
gw.connections
object
{}
one or many object with connection details for additional instances
gw.env
object
{}
optionally add key value pairs for environment variable to be added to container
gw.fullnameOverride
string
""
overrides the default naming of chart components with the prefix releaseName-chartName
gw.image.component
string
"gw"
appended to image.repository to give the complete path to docker image repository
gw.image.pullPolicy
string
"IfNotPresent"
policy when starting a pod and creating the docker image
gw.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
gw.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
gw.imagePullSecrets
list
[]
Image Pull Secrets used for authenticating against a private docker registry
gw.ingress.annotations
object
{}
annotations used to configure ingress. Vary depending on Ingress resource used
gw.ingress.enabled
bool
false
enable or disable the use of Ingress
gw.ingress.hosts[0].host
string
"chart-example.local"
used for Ingress rules, routing incoming requests
gw.ingress.hosts[0].paths
list
[]
additional to the Ingress rules, routing incoming requests to specific service
gw.ingress.tls
list
[]
enable TLS on ingress, by setting secrets for given host names
gw.instanceParam.exampleParam
string
"aParam"
example command line option. Passes -exampleParam aParam to the q instance
gw.instanceParam.g
int
1
example use of values to set instance garbage collection to immediate
gw.instanceParam.t
int
1000
example use of values to set instance timer ticks to 1000 milliseconds
gw.license.email
string
"user.name@kx.com"
user email address used for requesting and generating the KX On Demand License
gw.license.user
string
"User Name"
user name used for requesting and generating the KX On Demand License
gw.metrics.connRetry
int
10
connection attempts before setting the metrics collection to be local only
gw.metrics.enabled
bool
false
enable the collections of metrics to a sidecar container using KX Fusion Prometheus Exporter
gw.metrics.handler.pc
bool
true
enable metrics collection of the .z.pc handler
gw.metrics.handler.pg
bool
true
enable metrics collection of the .z.pg handler
gw.metrics.handler.ph
bool
true
enable metrics collection of the .z.ph handler
gw.metrics.handler.po
bool
true
enable metrics collection of the .z.po handler
gw.metrics.handler.pp
bool
true
enable metrics collection of the .z.pp handler
gw.metrics.handler.ps
bool
true
enable metrics collection of the .z.ps handler
gw.metrics.handler.ts
bool
true
enable metrics collection of the .z.ts handler
gw.metrics.handler.wc
bool
true
enable metrics collection of the .z.wc handler
gw.metrics.handler.wo
bool
true
enable metrics collection of the .z.wo handler
gw.metrics.handler.ws
bool
true
enable metrics collection of the .z.ws handler
gw.metrics.image.component
string
"metriccollector"
appended to metrics.image.repository to give the complete path to docker image repository
gw.metrics.image.pullPolicy
string
"IfNotPresent"
policy when starting a pod and creating the docker image
gw.metrics.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
gw.metrics.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
gw.metrics.port
int
8080
metrics container port: used for pushing metrics to from the main component container and querying via REST requests
gw.metrics.protocol
string
"uds"
define protocol to use when make a connection between main container and metrics sidecar container
gw.metrics.pushSeconds
int
5
interval in seconds between async publish to metrics container from main component container
gw.metrics.resources
object
{}
metrics container CPU/memory resources requests and limits
gw.metrics.serviceMonitor.additionalLabels.release
string
"kx"
Populate service monitor meta data, used for locating a Prometheus operator using label selectors
gw.metrics.serviceMonitor.enabled
bool
false
enable the Service Monitor for the Prometheus Operator
gw.metrics.serviceMonitor.interval
string
"10s"
frequency to request metrics from sidecar container
gw.metrics.serviceMonitor.path
string
"/metrics"
REST Endpoint to query for metrics
gw.nameOverride
string
""
override the Chart name within helpers
gw.nodeSelector
object
{}
Node Selector basic requirements for assigning a pod to a node
gw.persistence.capacity
string
"8G"
requested volume capacity
gw.persistence.enabled
bool
false
enable persistent storage for pod
gw.persistence.logging.logDir
string
"/opt/kx/logs"
directory path to STDOUT log directory
gw.persistence.logging.logPVC
string
" kx-gw-stdout-pv"
STDOUT PVC name
gw.persistence.qScripts
string
"/opt/kx/qScripts"
directory path to directory containing q scripts deployed as part of the Helm chart
gw.persistence.schemaDir
string
"/opt/kx/schema"
directory path to directory containing schema JSON and q files deployed as part of the Helm chart
gw.persistence.shared.enabled
bool
false
enable shared access to pod PVC
gw.podAnnotations
object
{}
additional custom Annotations appended to metadata
gw.podSecurityContext
object
{}
setting the Security Context for the pod. Sets the runtime user and group for all containers inside pod
gw.port
int
5000
exposed container port and q instance
gw.rbac.annotations
object
{}
additional RBAC metadata
gw.rbac.create
bool
true
create RBAC Role and RBAC RoleBinding
gw.replicaCount
int
1
specify desired number of pods
gw.resources
object
{}
GW container CPU/memory resources requests and limits
gw.securityContext
object
{}
setting the Security Context for the containers. Sets the runtime user and group for given container
gw.service.port
int
5000
service port
gw.service.type
string
"LoadBalancer"
set the Service Type for service
gw.serviceAccount.annotations
object
{}
labels to be added to Service account metadata
gw.serviceAccount.create
bool
true
create Service Account
gw.serviceAccount.name
string
""
name given to Service Account
gw.tolerations
list
[]
pod Tolerations to node taint; used for assigning a pod to a node

hdb parameters

Version: 0.3.0 Type: application AppVersion: 4.0

Historical DB configuration is defined and configurable via .../charts/hdb/values.yaml

key
type
default
description
hdb.affinity
object
{}
Pod Affinity rules for assigning a pod to a node
hdb.autoscaling.enabled
bool
false
enable pod autoscaling
hdb.autoscaling.maxReplicas
int
100
Max Replica Count permitted
hdb.autoscaling.minReplicas
int
1
Minimum Replica Count permitted
hdb.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
hdb.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
hdb.env
object
{}
optionally add key value pairs for environment variable to be added to container
hdb.fullnameOverride
string
""
overrides the default naming of chart components with the prefix releaseName-chartName
hdb.gateway.host
string
"kx-gw.default.svc"
target gateway host
hdb.gateway.name
string
"gw"
alias for gateway instance
hdb.gateway.port
string
"5000"
target gateway port
hdb.image.component
string
"hdb"
appended to image.repository to give the complete path to Docker image repository
hdb.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
hdb.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
hdb.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
hdb.imagePullSecrets
list
[]
Image Pull Secrets used for authenticating against a private Docker registry
hdb.ingress.annotations
object
{}
annotations used to configure ingress. Vary depending on Ingress resource used
hdb.ingress.enabled
bool
false
enable or disable the use of Ingress
hdb.ingress.hosts[0].host
string
"chart-example.local"
used for Ingress rules, routing incoming requests
hdb.ingress.hosts[0].paths
list
[]
additional to the Ingress rules, routing incoming requests to specific service
hdb.ingress.tls
list
[]
enable TLS on ingress, by setting secrets for given host names
hdb.instanceParam.exampleParam
string
"aParam"
example command line option. Passes -exampleParam aParam to the q instance
hdb.instanceParam.g
int
1
example use of values to set instance garbage collection to immediate
hdb.instanceParam.t
int
1000
example use of values to set instance timer ticks to 1000 milliseconds
hdb.license.email
string
"user.name@kx.com"
user email address used for requesting and generating the KX On Demand License
hdb.license.user
string
"User Name"
user name used for requesting and generating the KX On Demand License
hdb.metrics.connRetry
int
10
connection attempts before setting the metrics collection to be local only
hdb.metrics.enabled
bool
false
enable the collections of metrics to a sidecar container using KX Fusion Prometheus Exporter
hdb.metrics.handler.pc
bool
true
enable metrics collection of the .z.pc handler
hdb.metrics.handler.pg
bool
true
enable metrics collection of the .z.pg handler
hdb.metrics.handler.ph
bool
true
enable metrics collection of the .z.ph handler
hdb.metrics.handler.po
bool
true
enable metrics collection of the .z.po handler
hdb.metrics.handler.pp
bool
true
enable metrics collection of the .z.pp handler
hdb.metrics.handler.ps
bool
true
enable metrics collection of the .z.ps handler
hdb.metrics.handler.ts
bool
true
enable metrics collection of the .z.ts handler
hdb.metrics.handler.wc
bool
true
enable metrics collection of the .z.wc handler
hdb.metrics.handler.wo
bool
true
enable metrics collection of the .z.wo handler
hdb.metrics.handler.ws
bool
true
enable metrics collection of the .z.ws handler
hdb.metrics.image.component
string
"metriccollector"
appended to metrics.image.repository to give the complete path to Docker image repository
hdb.metrics.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
hdb.metrics.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
hdb.metrics.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
hdb.metrics.port
int
8080
metrics container port. Used for pushing metrics to from the main component container and querying via REST requests
hdb.metrics.protocol
string
"uds"
define protocol to use when make a connection between main container and metrics sidecar container
hdb.metrics.pushSeconds
int
5
interval in seconds between async publish to metrics container from main component container
hdb.metrics.resources
object
{}
metrics container CPU/memory resources requests and limits
hdb.metrics.serviceMonitor.additionalLabels.release
string
"kx"
populate Service monitor meta data, used for locating a Prometheus Operator using label selectors
hdb.metrics.serviceMonitor.enabled
bool
false
enable the Service Monitor for the Prometheus Operator
hdb.metrics.serviceMonitor.interval
string
"10s"
frequency to request metrics from sidecar container
hdb.metrics.serviceMonitor.path
string
"/metrics"
REST Endpoint to query for metrics
hdb.nameOverride
string
""
override the Chart name within helpers
hdb.nodeSelector
object
{}
Node Selector basic requirements for assigning a pod to a node
hdb.objectstore
object
{}
configuration for use of Object Stores in HDB par.txt
hdb.objectstore.buckets
list
[]
list one or many object store paths. Each appended to the par.txt file
hdb.objectstore.enabled
bool
false
append object store paths to par.txt file
hdb.objectstore.sym
object
{}
configuration of the object store back up sym file and local sym file
hdb.objectstore.sym.cp
bool
false
if sym is not found locally, true will enable the copy from object store
hdb.objectstore.sym.name
string
sym
local sym file name on disk, copied object store file will be wrote to disk under this name
hdb.objectstore.sym.path
string
""
full path to object store sym file back up location
hdb.persistence.capacity
string
"8G"
requested volume capacity
hdb.persistence.enabled
bool
false
enable Persistent storage for pod
hdb.persistence.logging.logDir
string
"/opt/kx/logs"
directory path to STDOUT log directory
hdb.persistence.logging.logPVC
string
" kx-gw-stdout-pv"
STDOUT PVC name
hdb.persistence.qScripts
string
"/opt/kx/qScripts"
directory path to directory containing q scripts deployed as part of the Helm chart
hdb.persistence.schemaDir
string
"/opt/kx/schema"
directory path to directory containing schema JSON and q files deployed as part of the Helm chart
hdb.persistence.shared.enabled
bool
false
enabled shared access to pod PVC
hdb.persistence.shared.storageClass
string
""
volume Storage Class
hdb.persistence.storageClass
string
""
volume Storage Class
hdb.podAnnotations
object
{}
additional custom Annotations appended to metadata
hdb.podSecurityContext
object
{}
setting the Security Context for the pod. Sets the runtime user and group for all containers inside pod
hdb.port
int
5010
exposed container port and q instance
hdb.rbac.annotations
object
{}
additional RBAC metadata
hdb.rbac.create
bool
true
create RBAC Role and RBAC RoleBinding
hdb.realtime.hdbDir
string
"/opt/kx/hdbdata"
path to HDB date partitions
hdb.realtime.host
string
"kx-rdb.default.svc"
RDB host
hdb.realtime.port
string
"5020"
RDB port
hdb.realtime.rdbPVC
string
"kx-rdb-hdb-data-kx-rdb-0"
RDB PVC name
hdb.realtime.volumeName
string
"kx-rdb-pvc"
name given to volume
hdb.replicaCount
int
1
specify desired number of pods
hdb.resources
object
{}
HDB container CPU/memory resources requests and limits
hdb.securityContext
object
{}
setting the Security Context for the containers. Sets the runtime user and group for given container
hdb.service.port
int
5010
service port
hdb.service.type
string
"ClusterIP"
set the Service Type for service
hdb.serviceAccount.annotations
object
{}
labels to be added to Service account metadata
hdb.serviceAccount.create
bool
true
create Service Account
hdb.serviceAccount.name
string
""
name given to Service Account
hdb.tolerations
list
[]
pod Tolerations to node taint. Used for assigning a pod to a node

q parameters

Version: 0.3.0 Type: application AppVersion: 4.0

Q configuration is defined and configurable via .../charts/q/values.yaml

key
type
default
description
q.affinity
object
{}
Pod Affinity rules for assigning a pod to a node
q.autoscaling.enabled
bool
false
enable pod autoscaling
q.autoscaling.maxReplicas
int
100
Max Replica Count permitted
q.autoscaling.minReplicas
int
1
Minimum Replica Count permitted
q.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
q.autoscaling.targetMemoryUtilizationPercentage
int
80
max memory utilization metric value before autoscaling is triggered
q.env
object
{}
optionally add key value pairs for environment variable to be added to container
q.fullnameOverride
string
""
overrides the default naming of chart components with the prefix releaseName-chartName
q.image.component
string
"q"
appended to image.repository to give the complete path to Docker image repository
q.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
q.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
q.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
q.imagePullSecrets
list
[]
Image Pull Secrets used for authenticating against a private Docker registry
q.ingress.annotations
object
{}
annotations used to configure ingress. Vary depending on Ingress resource used
q.ingress.enabled
bool
false
enable or disable the use of Ingress
q.ingress.hosts[0].host
string
"chart-example.local"
used for Ingress rules, routing incoming requests
q.ingress.hosts[0].paths
list
[]
additional to the Ingress rules, routing incoming requests to specific service
q.ingress.tls
list
[]
enable TLS on ingress, by setting secrets for given host names
q.instanceParam.exampleParam
string
"aParam"
example command line option. Passes -exampleParam aParam to the q instance
q.instanceParam.g
int
1
example use of values to set instance garbage collection to immediate
q.instanceParam.t
int
100
example use of values to set instance timer ticks to 100 milliseconds
q.license.email
string
"user.name@kx.com"
user email address used for requesting and generating the KX On Demand License
q.license.user
string
"User Name"
user name used for requesting and generating the KX On Demand License
q.metrics.connRetry
int
10
connection attempts before setting the metrics collection to be local only
q.metrics.enabled
bool
true
enable the collections of metrics to a sidecar container using KX Fusion Prometheus Exporter
q.metrics.handler.pc
bool
true
enable metrics collection of the .z.pc handler
q.metrics.handler.pg
bool
true
enable metrics collection of the .z.pg handler
q.metrics.handler.ph
bool
true
enable metrics collection of the .z.ph handler
q.metrics.handler.po
bool
true
enable metrics collection of the .z.po handler
q.metrics.handler.pp
bool
true
enable metrics collection of the .z.pp handler
q.metrics.handler.ps
bool
true
enable metrics collection of the .z.ps handler
q.metrics.handler.ts
bool
true
enable metrics collection of the .z.ts handler
q.metrics.handler.wc
bool
true
enable metrics collection of the .z.wc handler
q.metrics.handler.wo
bool
true
enable metrics collection of the .z.wo handler
q.metrics.handler.ws
bool
true
enable metrics collection of the .z.ws handler
q.metrics.image.component
string
"metriccollector"
appended to metrics.image.repository to give the complete path to Docker image repository
q.metrics.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
q.metrics.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
q.metrics.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
q.metrics.port
int
8080
metrics container port. Used for pushing metrics to from the main component container and querying via REST requests
q.metrics.protocol
string
"uds"
define protocol to use when make a connection between main container and metrics sidecar container
q.metrics.pushSeconds
int
5
interval in seconds between async publish to metrics container from main component container
q.metrics.resources
object
{}
metrics container CPU/memory resources requests and limits
q.metrics.serviceMonitor.additionalLabels.release
string
"kx"
populate Service monitor meta data, used for locating a Prometheus Operator using label selectors
q.metrics.serviceMonitor.enabled
bool
false
enable the Service Monitor for the Prometheus Operator
q.metrics.serviceMonitor.interval
string
"10s"
frequency to request metrics from sidecar container
q.metrics.serviceMonitor.path
string
"/metrics"
REST Endpoint to query for metrics
q.nameOverride
string
""
override the Chart name within helpers
q.nodeSelector
object
{}
Node Selector basic requirements for assigning a pod to a node
q.persistence.capacity
string
"8G"
requested volume capacity
q.persistence.dataDir
string
"/opt/kx/dataDir"
path to additional data directory
q.persistence.enabled
bool
false
enable Persistent storage for pod
q.persistence.logging.logDir
string
"/opt/kx/logs"
directory path to STDOUT log directory
q.persistence.logging.logPVC
string
" kx-q-stdout-pv"
STDOUT PVC name
q.persistence.qPVC
string
" kx-q-pvc"
PV Claim name
q.persistence.qScripts
string
"/opt/kx/qScripts"
directory path to directory containing q scripts deployed as part of the Helm chart
q.persistence.schemaDir
string
"/opt/kx/schema"
directory path to directory containing schema JSON and q files deployed as part of the Helm chart
q.persistence.shared.enabled
bool
false
enabled shared access to pod PVC
q.persistence.storageClass
string
""
volume Storage Class
q.podAnnotations
object
{}
additional custom Annotations appended to metadata
q.podSecurityContext
object
{}
setting the Security Context for the pod. Sets the runtime user and group for all containers inside pod
q.port
int
2001
exposed container port and q instance
q.rbac.annotations
object
{}
additional RBAC metadata
q.rbac.create
bool
true
create RBAC Role and RBAC RoleBinding
q.replicaCount
int
1
specify desired number of pods
q.resources
object
{}
container CPU/memory resources requests and limits
q.securityContext
object
{}
setting the Security Context for the containers. Sets the runtime user and group for given container
q.service.port
int
5000
service port
q.service.type
string
"ClusterIP"
set the Service Type for service
q.serviceAccount.annotations
object
{}
labels to be added to Service account metadata
q.serviceAccount.create
bool
true
create Service Account
q.serviceAccount.name
string
""
name given to Service Account
q.tolerations
list
[]
pod Tolerations to node taint. Used for assigning a pod to a node

rdb parameters

Version: 0.3.0 Type: application AppVersion: 4.0

Realtime DB configuration is defined and configurable via .../charts/rdb/values.yaml

key
type
default
description
rdb.affinity
object
{}
Pod Affinity rules for assigning a pod to a node
rdb.autoscaling.enabled
bool
false
enable pod autoscaling
rdb.autoscaling.maxReplicas
int
100
Max Replica Count permitted
rdb.autoscaling.minReplicas
int
1
Minimum Replica Count permitted
rdb.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
rdb.autoscaling.targetMemoryUtilizationPercentage
int
80
max memory utilization metric value before autoscaling is triggered
rdb.env
object
{}
optionally add key value pairs for environment variable to be added to container
rdb.fullnameOverride
string
""
overrides the default naming of chart components with the prefix releaseName-chartName
rdb.gateway.host
string
"kx-gw.default.svc"
target gateway host
rdb.gateway.name
string
"gw"
alias for gateway instance
rdb.gateway.port
string
""
target gateway port
rdb.historical.host
string
"kx-hdb.default.svc"
HDB host
rdb.historical.port
string
"5000"
HDB port
rdb.image.component
string
"rdb"
appended to image.repository to give the complete path to Docker image repository
rdb.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
rdb.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
rdb.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
rdb.imagePullSecrets
list
[]
Image Pull Secrets used for authenticating against a private Docker registry
rdb.ingress.annotations
object
{}
annotations used to configure ingress. Vary depending on Ingress resource used
rdb.ingress.enabled
bool
false
enable or disable the use of Ingress
rdb.ingress.hosts[0].host
string
"chart-example.local"
used for Ingress rules, routing incoming requests
rdb.ingress.hosts[0].paths
list
[]
additional to the Ingress rules, routing incoming requests to specific service
rdb.ingress.tls
list
[]
enable TLS on ingress, by setting secrets for given host names
rdb.instanceParam.exampleParam
string
"aParam"
example command line option. Passes -exampleParam aParam to the q instance
rdb.instanceParam.g
int
1
example use of values to set instance garbage collection to immediate
rdb.instanceParam.t
int
1000
example use of values to set instance timer ticks to 1000 milliseconds
rdb.license.email
string
"user.name@kx.com"
user email address used for requesting and generating the KX On Demand License
rdb.license.user
string
"User Name"
user name used for requesting and generating the KX On Demand License
rdb.metrics.connRetry
int
10
connection attempts before setting the metrics collection to be local only
rdb.metrics.custom.kdb_upd_total
object
{}
example of custom metric. Key defines name, with object defining metric parameters and function overrides
rdb.metrics.enabled
bool
false
enable the collections of metrics to a sidecar container using KX Fusion Prometheus Exporter
rdb.metrics.handler.pc
bool
true
enable metrics collection of the .z.pc handler
rdb.metrics.handler.pg
bool
true
enable metrics collection of the .z.pg handler
rdb.metrics.handler.ph
bool
true
enable metrics collection of the .z.ph handler
rdb.metrics.handler.po
bool
true
enable metrics collection of the .z.po handler
rdb.metrics.handler.pp
bool
true
enable metrics collection of the .z.pp handler
rdb.metrics.handler.ps
bool
true
enable metrics collection of the .z.ps handler
rdb.metrics.handler.ts
bool
true
enable metrics collection of the .z.ts handler
rdb.metrics.handler.wc
bool
true
enable metrics collection of the .z.wc handler
rdb.metrics.handler.wo
bool
true
enable metrics collection of the .z.wo handler
rdb.metrics.handler.ws
bool
true
enable metrics collection of the .z.ws handler
rdb.metrics.image.component
string
"metriccollector"
appended to metrics.image.repository to give the complete path to Docker image repository
rdb.metrics.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
rdb.metrics.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
rdb.metrics.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
rdb.metrics.port
int
8080
metrics container port. Used for pushing metrics to from the main component container and querying via REST requests
rdb.metrics.protocol
string
"uds"
define protocol to use when make a connection between main container and metrics sidecar container
rdb.metrics.pushSeconds
int
5
interval in seconds between async publish to metrics container from main component container
rdb.metrics.resources
object
{}
metrics container CPU/memory resources requests and limits
rdb.metrics.serviceMonitor.additionalLabels.release
string
"kx"
populate Service monitor meta data, used for locating a Prometheus Operator using label selectors
rdb.metrics.serviceMonitor.enabled
bool
false
enable the Service Monitor for the Prometheus Operator
rdb.metrics.serviceMonitor.interval
string
"10s"
frequency to request metrics from sidecar container
rdb.metrics.serviceMonitor.path
string
"/metrics"
REST Endpoint to query for metrics
rdb.nameOverride
string
""
override the Chart name within helpers
rdb.nodeSelector
object
{}
Node Selector basic requirements for assigning a pod to a node
rdb.objectstore
object
{}
configuration for use of Object Stores in HDB par.txt
rdb.objectstore.buckets
list
[]
list one or many object store paths. Each appended to the par.txt file
rdb.objectstore.enabled
bool
false
append object store paths to par.txt file
rdb.objectstore.sym
object
{}
configuration of the object store back up sym file and local sym file
rdb.objectstore.sym.cp
bool
false
if sym is not found locally, true will enable the copy from object store
rdb.objectstore.sym.name
string
sym
local sym file name on disk, copied object store file will be wrote to disk under this name
rdb.objectstore.sym.path
string
""
full path to object store sym file back up location
rdb.persistence.capacity
string
"8G"
requested volume capacity
rdb.persistence.enabled
bool
false
enable Persistent storage for pod
rdb.persistence.eodDir
string
"/opt/kx/hdbdata"
path to directory in-memory tables are wrote at EOD
rdb.persistence.logging.logDir
string
"/opt/kx/logs"
directory path to STDOUT log directory
rdb.persistence.logging.logPVC
string
" kx-rdb-stdout-pv"
STDOUT PVC name
rdb.persistence.qScripts
string
"/opt/kx/qScripts"
directory path to directory containing q scripts deployed as part of the Helm chart
rdb.persistence.rdbPVC
string
"kx-hdb-pvc"
RDB PVC name, location of EOD date partitions
rdb.persistence.schemaDir
string
"/opt/kx/schema"
directory path to directory containing schema JSON and q files deployed as part of the Helm chart
rdb.persistence.shared.enabled
bool
false
enabled shared access to pod PVC
rdb.persistence.shared.storageClass
string
"nfs-client"
volume Storage Class
rdb.persistence.storageClass
string
""
volume Storage Class
rdb.persistence.volName
string
"kx-hdb-data"
name given to volume
rdb.podAnnotations
object
{}
additional custom Annotations appended to metadata
rdb.podSecurityContext
object
{}
setting the Security Context for the pod. Sets the runtime user and group for all containers inside pod
rdb.port
int
5020
exposed container port and q instance
rdb.rbac.annotations
object
{}
additional RBAC metadata
rdb.rbac.create
bool
true
create RBAC Role and RBAC RoleBinding
rdb.replicaCount
int
1
specify desired number of pods
rdb.resources
object
{}
RDB container CPU/memory resources requests and limits
rdb.securityContext
object
{}
setting the Security Context for the containers. Sets the runtime user and group for given container
rdb.service.port
int
5020
service port
rdb.service.type
string
"ClusterIP"
set the Service Type for service
rdb.serviceAccount.annotations
object
{}
labels to be added to Service account metadata
rdb.serviceAccount.create
bool
true
create Service Account
rdb.serviceAccount.name
string
""
name given to Service Account
rdb.tickerplant.host
string
"kx-tp.default.svc"
tickerplant host
rdb.tickerplant.logsDir
string
"/opt/kx/tplogs"
path to tickerplant log files directory
rdb.tickerplant.port
string
"5000"
tickerplant port
rdb.tickerplant.tpPVC
string
"kx-tp-pvc"
tickerplant PVC name, location of tickerplant log files
rdb.tickerplant.volName
string
"kx-tp-pvc"
name given to volume
rdb.tolerations
list
[]
pod Tolerations to node taint. Used for assigning a pod to a node

tp parameters

Version: 0.3.0 Type: application AppVersion: 4.0

Tickerplant configuration is defined and configurable via .../charts/tp/values.yaml

key
type
default
description
tp.fullnameOverride
string
""
overrides the default naming of chart components with the prefix releaseName-chartName
tp.nameOverride
string
""
override the Chart name within helpers
tp.replicaCount
int
1
specify desired number of pods
tp.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
tp.image.component
string
"tp"
appended to image.repository to give the complete path to Docker image repository
tp.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
tp.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
tp.imagePullSecrets
list
[]
Image Pull Secrets used for authenticating against a private Docker registry
tp.license.email
string
"user.name@kx.com
user email address used for requesting and generating the KX On Demand License
tp.license.user
string
"User Name"
user name used for requesting and generating the KX On Demand License
tp.env
object
{}
optionally add key value pairs for environment variable to be added to container
tp.port
int
5000
exposed container port and q instance
tp.instanceParam.eodTime
string
"23:59:59"
configure the EOD trigger time
tp.instanceParam.exampleParam
string
"aParam"
example command line option. Passes -exampleParam aParam to the q instance
tp.instanceParam.g
int
1
example use of values to set instance garbage collection to immediate
tp.instanceParam.t
int
100
example use of values to set instance timer ticks to 100 milliseconds
tp.metrics.enabled
bool
false
enable the collections of metrics to a sidecar container using KX Fusion Prometheus Exporter
tp.metrics.image.repository
string
"gcr.io/cloudpak/"
Docker image repository
tp.metrics.image.component
string
"metriccollector"
appended to metrics.image.repository to give the complete path to Docker image repository
tp.metrics.image.tag
string
"0.2.1"
Docker image version tag, may also use the latest tag
tp.metrics.image.pullPolicy
string
"IfNotPresent"
Policy when starting a pod and creating the Docker image
tp.metrics.port
int
8080
metrics container port. Used for pushing metrics to from the main component container and querying via REST requests
tp.metrics.pushSeconds
int
5
interval in seconds between async publish to metrics container from main component container
tp.metrics.connRetry
int
10
connection attempts before setting the metrics collection to be local only
tp.metrics.protocol
string
"uds"
define protocol to use when make a connection between main container and metrics sidecar container
tp.metrics.resources
object
{}
metrics container CPU/memory resources requests and limits
tp.metrics.handler.pc
bool
true
enable metrics collection of the .z.pc handler
tp.metrics.handler.pg
bool
true
enable metrics collection of the .z.pg handler
tp.metrics.handler.ph
bool
true
enable metrics collection of the .z.ph handler
tp.metrics.handler.po
bool
true
enable metrics collection of the .z.po handler
tp.metrics.handler.pp
bool
true
enable metrics collection of the .z.pp handler
tp.metrics.handler.ps
bool
true
enable metrics collection of the .z.ps handler
tp.metrics.handler.ts
bool
true
enable metrics collection of the .z.ts handler
tp.metrics.handler.wc
bool
true
enable metrics collection of the .z.wc handler
tp.metrics.handler.wo
bool
true
enable metrics collection of the .z.wo handler
tp.metrics.handler.ws
bool
true
enable metrics collection of the .z.ws handler
tp.metrics.custom.kdb_upd_total
object
{}
example of custom metric. Key defines name, with object defining metric parameters and function overrides
tp.metrics.serviceMonitor.enabled
bool
false
enable the Service Monitor for the Prometheus Operator
tp.metrics.serviceMonitor.interval
string
"10s"
frequency to request metrics from sidecar container
tp.metrics.serviceMonitor.path
string
"/metrics"
REST Endpoint to query for metrics
tp.metrics.serviceMonitor.additionalLabels.release
string
"kx"
populate Service monitor meta data, used for locating a Prometheus Operator using label selectors
tp.serviceAccount.create
bool
true
create Service Account
tp.serviceAccount.annotations
object
{}
labels to be added to Service account metadata
tp.serviceAccount.name
string
""
name given to Service Account
tp.rbac.create
bool
true
create RBAC Role and RBAC RoleBinding
tp.rbac.annotations
object
{}
additional RBAC metadata
tp.podAnnotations
object
{}
additional custom Annotations appended to metadata
tp.podSecurityContext
object
{}
setting the Security Context for the pod. Sets the runtime user and group for all containers inside pod
tp.securityContext
object
{}
setting the Security Context for the containers. Sets the runtime user and group for given container
tp.service.type
string
"LoadBalancer"
set the Service Type for service
tp.service.port
int
5000
service port
tp.ingress.enabled
bool
false
enable or disable the use of Ingress
tp.ingress.annotations
object
{}
annotations used to configure ingress. Vary depending on Ingress resource used
tp.ingress.hosts[0].host
string
"chart-example.local"
used for Ingress rules, routing incoming requests
tp.ingress.hosts[0].paths
list
[]
additional to the Ingress rules, routing incoming requests to specific service
tp.ingress.tls
list
[]
enable TLS on ingress, by setting secrets for given host names
tp.resources
object
{}
tickerplant container CPU/memory resources requests and limits
tp.autoscaling.enabled
bool
false
enable pod autoscaling
tp.autoscaling.minReplicas
int
1
Minimum Replica Count permitted
tp.autoscaling.maxReplicas
int
100
Max Replica Count permitted
tp.autoscaling.targetCPUUtilizationPercentage
int
80
max CPU metric value before autoscaling is triggered
tp.autoscaling.targetMemoryUtilizationPercentage
int
80
max memory utilization metric value before autoscaling is triggered
tp.nodeSelector
object
{}
Node Selector basic requirements for assigning a pod to a node
tp.tolerations
list
[]
pod Tolerations to node taint. Used for assigning a pod to a node
tp.affinity
object
{}
Pod Affinity rules for assigning a pod to a node
tp.persistence.enabled
bool
false
enable Persistent storage for pod
tp.persistence.capacity
string
"8G"
requested volume capacity
tp.persistence.storageClass
string
""
volume Storage Class
tp.persistence.tpPVC
string
"kx-tp-pvc"
tickerplant PVC name, location of tickerplant log files
tp.persistence.tpLogDir
string
"/opt/kx/tplogs"
directory path to location of tickerplant transaction log files
tp.persistence.logging.logPVC
string
" kx-tp-stdout-pv"
STDOUT PVC name
tp.persistence.logging.logDir
string
"/opt/kx/logs"
directory path to STDOUT log directory
tp.persistence.schemaDir
string
"/opt/kx/schema"
directory path to directory containing schema JSON and q files deployed as part of the Helm chart
tp.persistence.qScripts
string
"/opt/kx/qScripts"
directory path to directory containing q scripts deployed as part of the Helm chart
tp.persistence.shared.enabled
bool
false
enabled shared access to pod PVC