Insights Configuration Reference¶
Version: 1.19.0
kdb Insights Enterprise umbrella chart. Deploys all core components and dependencies.
Values¶
Local Configurations¶
Local values configuration for insights.
| Key | Type | Default | Description |
|---|---|---|---|
fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
ingress |
object |
{} |
Configure Ingress resources for external access to the application. |
ingress.issuer |
object |
{} |
Configuration for Cert Manager to provision TLS Certificate. |
ingress.issuer.cloudDNS |
object |
{} |
Configuration for Google Cloud DNS for DNS-01 challenge solver. Refer to ACME Issuer. |
ingress.issuer.create |
bool |
false |
Create Issuer resource Refer to ACME Issuer. |
ingress.issuer.httpSolver |
bool |
true |
Enabled the HTTP-01 challenge solver. Refer to ACME Issuer. |
installSize |
string |
"starter" |
Define the install size of this release. Values must be a key within global.insightsConfig.installSize map.Selected size is used to determine defaults applied to container resource requests. |
kxi-views |
object |
{} |
Configuration information for dashboard views |
kxi-views.defaultTimeoutSeconds |
int |
10 |
The default timeout in seconds for queries from a view’s data source, which are used to populate components in a view |
kxi-views.maxTimeoutSeconds |
int |
900 |
A limit in seconds, on how long a query from a view can take, to ensure, views are responsive |
nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
packages |
object |
{} |
Configure Packaging within chart. |
packages.enabled |
bool |
true |
Enabled Packaging. |
packages.storageClass |
string |
"sharedfiles" |
Shared Packaging Persistent Volume Claim StorageClass. |
packages.storageSize |
string |
"20Gi" |
Specifies the storage capacity request for the Shared Persistent Volume Claim. |
packages.useLocalValues |
bool |
true |
When enabled, global configuration is ignored and local configuration is used. |
private-registry |
object |
{} |
Set the Private Image registry details. Location of container images. |
private-registry.enabled |
bool |
false |
Enable Private Image registry. |
private-registry.host |
string |
"" |
Private Image registry hostname. |
Global Configurations¶
Global values that are accessible across all templates and subcharts.
Note
When you have both global and local configuration values, the global values take precedence over local (chart-specific) values as the chart template explicitly references the global scope.
Audit Log¶
Global audit log configuration. Enable and configure audit logging within subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.auditLog.enabled |
bool |
false |
Enable audit logging globally. |
global.auditLog.logLevel |
string |
"INFO" |
Set verbosity level for the audit logs. E.g "INFO", "DEBUG", "ERROR". |
Clientz¶
Configure the integration of a component's connection information for tracking the relationship of different services within kdb Insights Enterprise.
| Key | Type | Default | Description |
|---|---|---|---|
global.clientz.enabled |
bool |
true |
Enable or disable the Side Car capturing client data from the main container. |
Encryption¶
Configure Encryption with all subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.encryption.auth |
object |
{} |
Configuration used for database encryption. |
global.encryption.auth.existingSecret |
string |
"kxi-encryption-secret" |
Name of the existing Kubernetes secret used for database encryption. |
global.encryption.authorizationPolicy |
bool |
false |
Enable the creation of Authorization Policies across all subchart containers. If entitlements have been enabled, this will be ignored and set to true. |
global.encryption.enabled |
bool |
true |
Enable encryption across all subchart containers. |
global.encryption.mTLS |
bool |
true |
Enable mTLS between all subchart containers. |
global.encryption.outboundTimeout |
string |
"3s" |
Set the Istio sidecar outbound connection pool HTTP idle timeout. |
global.encryption.timeout |
string |
"4s" |
Set the Istio sidecar inbound connection pool HTTP idle timeout. |
Entitlements¶
Configure the use of Entitlements within the release.
| Key | Type | Default | Description |
|---|---|---|---|
global.entitlements.disableAuthorizationPolicy |
bool |
false |
Disable the creation of Istio AuthorizationPolicies used for restricting inter process connections. |
global.entitlements.enabled |
bool |
false |
Enable the use of Entitlements within the release. |
Healthz¶
Global health check configuration. Configure the integration of a component's health status within Insights.
| Key | Type | Default | Description |
|---|---|---|---|
global.healthz.checkFreq |
int |
5 |
Frequency in seconds at which the sidecar polls health statuses from the main service components. |
global.healthz.enabled |
bool |
true |
Enable the use of health status integration globally. |
Image Repository¶
Configure Image repository details within the release.
Refer to Container Images
| Key | Type | Default | Description |
|---|---|---|---|
global.image.pullPolicy |
string |
"IfNotPresent" |
Override Image pull policy across all subcharts. Refer to image-pull-policy. |
global.image.repository |
string |
"portal.dl.kx.com/" |
Override image repository across all subcharts. |
Ingress¶
Configure Ingress resources for external access to the application.
| Key | Type | Default | Description |
|---|---|---|---|
global.ingress.annotations |
object |
{} |
Custom annotations to be applied to the Ingress resource. Dictionary of key-value pairs. Refer to Object Annotations. |
global.ingress.class |
string |
"nginx-community" |
Specify the Ingress Controller class to use for routing traffic to the application. |
global.ingress.controllerType |
string |
"f5-nginx" |
NGINX Controller Type. May be the community or F5 edition. Permitted values - "f5-nginx" or "community-nginx". |
global.ingress.host |
string |
"" |
Hostname use to route traffic and access application from outside the cluster. |
global.ingress.kind |
string |
"route" |
Applicable only to Openshift/okd deploys. Override the default use of the route resource for the NGINX ingress.Permitted values - "nginx" or "route". |
Install Config¶
Configure default resource utilization for Assembly/Package components.
| Key | Type | Default | Description |
|---|---|---|---|
global.insightsConfig.installSize |
object |
{} |
Configure default resource utilization for Assembly/Package components. |
global.insightsConfig.installSize.large |
object |
{} |
Configuration for a large installation. |
global.insightsConfig.installSize.large.agg.resources |
object |
{ |
Assembly Aggregator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.dap.hdb.dbVolume |
string |
"5000Gi" |
Specifies the storage capacity request for Historical database Persistent Volume Claim. |
global.insightsConfig.installSize.large.dap.hdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.large.dap.hdb.resources |
object |
{ |
Assembly DA HDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.dap.hdb.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.dap.idb.dbVolume |
string |
"1000Gi" |
Specifies the storage capacity request for Intra day database Persistent Volume Claim. |
global.insightsConfig.installSize.large.dap.idb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.large.dap.idb.resources |
object |
{ |
Assembly DA IDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.dap.idb.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.dap.rdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.large.dap.rdb.resources |
object |
{ |
Assembly DA RDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.dap.rdb.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.dap.resources |
object |
{ |
Assembly DA container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.rc.resources |
object |
{ |
Assembly Resource Coordinator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sequencer.replicaCount |
int |
3 |
This sets the default replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.large.sequencer.resources |
object |
{ |
Assembly RT container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sequencer.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.sm.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.large.sm.resources |
object |
{ |
Assembly Storage Manager SM container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sm.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.smSingle.resources |
object |
{ |
Assembly Storage Manager Single container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sp.controller |
object |
{} |
Assembly Pipeline Controller defaults configuration. |
global.insightsConfig.installSize.large.sp.controller.resources |
object |
{ |
Assembly Pipeline Controller container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sp.controller.serviceVolume |
string |
"10Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.large.sp.maxWorkerThreads |
int |
4 |
Pipeline maximum worker threads. |
global.insightsConfig.installSize.large.sp.maxWorkers |
int |
100 |
Pipeline maximum worker count. |
global.insightsConfig.installSize.large.sp.minWorkers |
int |
1 |
Pipeline minimum worker count. |
global.insightsConfig.installSize.large.sp.worker |
object |
{} |
Assembly Pipeline Worker defaults configuration. |
global.insightsConfig.installSize.large.sp.worker.resources |
object |
{ |
Assembly Pipeline Worker container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.large.sp.worker.serviceVolume |
string |
"200Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium |
object |
{} |
Configuration for a medium installation. |
global.insightsConfig.installSize.medium.agg.resources |
object |
{ |
Assembly Aggregator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.dap.hdb.dbVolume |
string |
"2500Gi" |
Specifies the storage capacity request for Historical database Persistent Volume Claim. |
global.insightsConfig.installSize.medium.dap.hdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.medium.dap.hdb.resources |
object |
{ |
Assembly DA HDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.dap.hdb.serviceVolume |
string |
"70Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.dap.idb.dbVolume |
string |
"500Gi" |
Specifies the storage capacity request for Intra day database Persistent Volume Claim. |
global.insightsConfig.installSize.medium.dap.idb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.medium.dap.idb.resources |
object |
{ |
Assembly DA IDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.dap.idb.serviceVolume |
string |
"70Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.dap.rdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.medium.dap.rdb.resources |
object |
{ |
Assembly DA RDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.dap.rdb.serviceVolume |
string |
"70Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.dap.resources |
object |
{ |
Assembly DA container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.rc.resources |
object |
{ |
Assembly Resource Coordinator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sequencer.replicaCount |
int |
3 |
This sets the default replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.medium.sequencer.resources |
object |
{ |
Assembly RT container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sequencer.serviceVolume |
string |
"70Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.sm.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.medium.sm.resources |
object |
{ |
Assembly Storage Manager SM container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sm.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.smSingle.resources |
object |
{ |
Assembly Storage Manager Single container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sp.controller |
object |
{} |
Assembly Pipeline Controller defaults configuration. |
global.insightsConfig.installSize.medium.sp.controller.resources |
object |
{ |
Assembly Pipeline Controller container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sp.controller.serviceVolume |
string |
"10Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.medium.sp.maxWorkerThreads |
int |
10 |
Pipeline maximum worker threads. |
global.insightsConfig.installSize.medium.sp.maxWorkers |
int |
10 |
Pipeline maximum worker count. |
global.insightsConfig.installSize.medium.sp.minWorkers |
int |
1 |
Pipeline minimum worker count. |
global.insightsConfig.installSize.medium.sp.worker |
object |
{} |
Assembly Pipeline Worker defaults configuration. |
global.insightsConfig.installSize.medium.sp.worker.resources |
object |
{ |
Assembly Pipeline Worker container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.medium.sp.worker.serviceVolume |
string |
"140Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small |
object |
{} |
Configuration for a small installation. |
global.insightsConfig.installSize.small.agg.resources |
object |
{ |
Assembly Aggregator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.dap.hdb.dbVolume |
string |
"500Gi" |
Specifies the storage capacity request for Historical database Persistent Volume Claim. |
global.insightsConfig.installSize.small.dap.hdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.small.dap.hdb.resources |
object |
{ |
Assembly DA HDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.dap.hdb.serviceVolume |
string |
"50Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.dap.idb.dbVolume |
string |
"100Gi" |
Specifies the storage capacity request for Intra day database Persistent Volume Claim. |
global.insightsConfig.installSize.small.dap.idb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.small.dap.idb.resources |
object |
{ |
Assembly DA IDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.dap.idb.serviceVolume |
string |
"50Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.dap.rdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.small.dap.rdb.resources |
object |
{ |
Assembly DA RDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.dap.rdb.serviceVolume |
string |
"50Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.dap.resources |
object |
{ |
Assembly DA container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.rc.resources |
object |
{ |
Assembly Resource Coordinator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sequencer.replicaCount |
int |
3 |
This sets the default replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.small.sequencer.resources |
object |
{ |
Assembly RT container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sequencer.serviceVolume |
string |
"50Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.sm.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.small.sm.resources |
object |
{ |
Assembly Storage Manager SM container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sm.serviceVolume |
string |
"50Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.smSingle.resources |
object |
{ |
Assembly Storage Manager Single container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sp.controller |
object |
{} |
Assembly Pipeline Controller defaults configuration. |
global.insightsConfig.installSize.small.sp.controller.resources |
object |
{ |
Assembly Pipeline Controller container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sp.controller.serviceVolume |
string |
"10Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.small.sp.maxWorkerThreads |
int |
1 |
Pipeline maximum worker threads. |
global.insightsConfig.installSize.small.sp.maxWorkers |
int |
10 |
Pipeline maximum worker count. |
global.insightsConfig.installSize.small.sp.minWorkers |
int |
1 |
Pipeline minimum worker count. |
global.insightsConfig.installSize.small.sp.worker |
object |
{} |
Assembly Pipeline Worker defaults configuration. |
global.insightsConfig.installSize.small.sp.worker.resources |
object |
{ |
Assembly Pipeline Worker container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.small.sp.worker.serviceVolume |
string |
"100Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter |
object |
{} |
Configuration for a starter installation. |
global.insightsConfig.installSize.starter.agg.resources |
object |
{ |
Assembly Aggregator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.dap.hdb.dbVolume |
string |
"60Gi" |
Specifies the storage capacity request for Historical database Persistent Volume Claim. |
global.insightsConfig.installSize.starter.dap.hdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.starter.dap.hdb.resources |
object |
{ |
Assembly DA HDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.dap.hdb.serviceVolume |
string |
"20Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.dap.idb.dbVolume |
string |
"30Gi" |
Specifies the storage capacity request for Intra day database Persistent Volume Claim. |
global.insightsConfig.installSize.starter.dap.idb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.starter.dap.idb.resources |
object |
{ |
Assembly DA IDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.dap.idb.serviceVolume |
string |
"20Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.dap.rdb.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.starter.dap.rdb.resources |
object |
{ |
Assembly DA RDB container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.dap.rdb.serviceVolume |
string |
"20Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.dap.resources |
object |
{ |
Assembly DA container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.rc.resources |
object |
{ |
Assembly Resource Coordinator container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sequencer.replicaCount |
int |
3 |
This sets the default replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.starter.sequencer.resources |
object |
{ |
Assembly RT container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sequencer.serviceVolume |
string |
"40Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.sm.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
global.insightsConfig.installSize.starter.sm.resources |
object |
{ |
Assembly Storage Manager SM container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sm.serviceVolume |
string |
"20Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.smSingle.resources |
object |
{ |
Assembly Storage Manager Single container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sp.controller |
object |
{} |
Assembly Pipeline Controller defaults configuration. |
global.insightsConfig.installSize.starter.sp.controller.resources |
object |
{ |
Assembly Pipeline Controller container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sp.controller.serviceVolume |
string |
"10Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.installSize.starter.sp.maxWorkerThreads |
int |
1 |
Pipeline maximum worker threads. |
global.insightsConfig.installSize.starter.sp.maxWorkers |
int |
1 |
Pipeline maximum worker count. |
global.insightsConfig.installSize.starter.sp.minWorkers |
int |
1 |
Pipeline minimum worker count. |
global.insightsConfig.installSize.starter.sp.worker |
object |
{} |
Assembly Pipeline Worker defaults configuration. |
global.insightsConfig.installSize.starter.sp.worker.resources |
object |
{ |
Assembly Pipeline Worker container resource requests and limits. Refer to Container Resources. |
global.insightsConfig.installSize.starter.sp.worker.serviceVolume |
string |
"80Gi" |
Specifies the storage capacity request for Persistent Volume Claim. |
global.insightsConfig.storage |
object |
{} |
Configure supported Storage Class provisioners. |
global.insightsConfig.storage.database-cluster.provisioners |
object |
{} |
Configure supported Storage Class provisioners for Cluster Storage Manager. |
global.insightsConfig.storage.database-cluster.provisioners.default |
list |
[ |
Priority list of default provisioners to select for each component. |
global.insightsConfig.storage.database-cluster.provisioners.supported |
bool |
true |
Boolean to indicate all are supported. |
global.insightsConfig.storage.database-single.provisioners |
object |
{} |
Configure supported Storage Class provisioners for Single Storage Manager. |
global.insightsConfig.storage.database-single.provisioners.default |
list |
[ |
Priority list of default provisioners to select for each component. |
global.insightsConfig.storage.database-single.provisioners.supported |
list |
[ |
Indicates the set of supported provisioners within different components in the system. |
Keycloak¶
Configure Keycloak realm and users within the release.
| Key | Type | Default | Description |
|---|---|---|---|
global.keycloak.authURL |
string |
"" |
Where Keycloak has not been deployed as part of release, you may set the Keycloak Auth URL. |
global.keycloak.caching |
object |
{ |
Keycloak cache configuration |
global.keycloak.caching.enabled |
bool |
false |
Enable local caching of Keycloak updates within PostGres. |
global.keycloak.guiClientSecret |
string |
"" |
Client Secret to be used by the UI for interacting with this release's Keycloak realm. |
global.keycloak.importUsers |
bool |
false |
Import users into the Keycloak realm during install or upgrade. |
global.keycloak.operatorClientSecret |
string |
"" |
Client Secret to be used by the KXI Operator for interacting with this releases Keycloak realm. |
global.keycloak.realm |
string |
"insights" |
Keycloak realm created and imported for this release. |
KX License¶
Configure the KX License to be used across all subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.license.asFile |
bool |
true |
Mount License secret as file to the subcharts container. If false will be set a ENV Var within container. |
global.license.secretName |
string |
"" |
Name of existing Kubernetes secret containing encoded license. |
global.license.type |
string |
"k4" |
Supersedes the onDemand field, user can set type of license contained within their existing license secret.Permitted values - "kx", "kc" or "k4". |
Metrics¶
Configure the capture of Metrics across all subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.metrics.enabled |
bool |
false |
Enable metric generation across all subcharts. |
Observability¶
Configure the use of Observability within the release.
| Key | Type | Default | Description |
|---|---|---|---|
global.observability.enabled |
bool |
true |
Enable the use of Observability within the release. |
global.observability.withinRelease |
bool |
true |
Observability deployed as part of release. 'service' will be generated based on release. |
Packaging¶
Configure Packaging across all subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.packages.enabled |
bool |
true |
Enable Packaging across all subcharts. |
global.packages.initImage |
object |
{} |
Configure Packaging Porter init container image details across all subcharts. Refer to Images. |
global.packages.initImage.component |
string |
"kxi-kdbx-init" |
Image component. |
global.packages.initImage.tag |
string |
"1.19.0" |
Image tag. |
global.packages.porter |
object |
{} |
Configure Packaging Porter init container across all subcharts. |
global.packages.porter.native |
bool |
true |
When true Porter container will be deployed as a native sidecar.Refer to Native Sidecars. |
global.packages.porter.port |
int |
65534 |
Port number to assign to the exposed container port. |
global.packages.porter.resources |
object |
{ |
Packaging Porter container resource requests and limits. Refer to Container Resources. |
KXI Sidecar¶
The KXI Sidecar is the helper container that adds observability support, especially metrics scraping and export to kdb Insights Enterprise components.
Configure the KXI Sidecar to be used across all subcharts.
| Key | Type | Default | Description |
|---|---|---|---|
global.sidecar.image |
object |
{} |
Configure Sidecar Image details within the release. Refer to Images. |
global.sidecar.image.component |
string |
"kxi-sidecar" |
Image component. |
global.sidecar.image.tag |
string |
"1.19.0" |
Image tag. |
global.sidecar.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
Miscellaneous¶
| Key | Type | Default | Description |
|---|---|---|---|
global.betaFeatures |
object |
{} |
Enable beta features within subcharts. |
global.betaFeatures.kxi-sp |
bool |
false |
Enable beta features within kxi-sp. |
global.clusterProvider |
string |
"unknown" |
Specifies the Kubernetes infrastructure provider. Triggers specific provider logic e.g annotations or ingress. Permitted values - "aks", "eks", "gke", "openshift" or "unknown". |
global.cnpg |
object |
{} |
Configure the use of Cloud Native Postgres within the release. |
global.cnpg.auth.existingSecret |
string |
"kxi-postgresql" |
Name of the existing Kubernetes secret containing Postgres authorization details. |
global.dnsService |
string |
"kube-dns.kube-system" |
The DNS service name used for cluster resolution. |
global.embedded |
object |
{} |
Configure the use of the Embedded iFrame within the release. |
global.embedded.enabled |
bool |
false |
Enable the use of embedded ui demo within release. When true, sets the Content-Security-Policy to allow embedding. |
global.embedded.host |
string |
"none" |
The domain that is allowed to embed this app in an iframe. Use "none" to block all iframe embedding. |
global.env |
object |
{} |
Global map of environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
global.gui-gateway.enabled |
bool |
true |
Enable the gui-gateway subchart |
global.kubernetes |
object |
{} |
Configure the Kubernetes cluster details. |
global.kubernetes.clusterDomain |
string |
"" |
Override the Kubernetes Service cluster domain. |
global.kubernetes.namespace |
string |
"" |
Override the Kubernetes Service namespace. |
global.kubernetes.service |
string |
"" |
Override in full the Kubernetes Service. |
global.persistence |
object |
{} |
Configure persistence across all subcharts. |
global.persistence.enabled |
bool |
true |
Deprecated Enable persistence within release. |
global.persistence.local |
object |
{} |
Default Persistent Volume Claim configurations for local storage. |
global.persistence.local.accessModes |
list |
[ |
Local storage Persistent Volume Claim Access Modes. |
global.persistence.local.storageClass |
string |
"" |
Local storage Persistent Volume Claim StorageClass. |
global.persistence.local.storageSize |
string |
"20Gi" |
Specifies the storage capacity request for local storage Persistent Volume Claim. |
global.persistence.shared |
object |
{} |
Default Persistent Volume Claim configurations for shared storage. |
global.persistence.shared.accessModes |
list |
[ |
Shared storage Persistent Volume Claim Access Modes. |
global.persistence.shared.storageClass |
string |
"rook-cephfs" |
Shared storage Persistent Volume Claim StorageClass. |
global.persistence.shared.storageSize |
string |
"20Gi" |
Specifies the storage capacity request for shared storage Persistent Volume Claim. |
global.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
global.priorityClass |
object |
{} |
Configure the use of Pod Priority Classes within the release. |
global.priorityClass.assembly.value |
int |
10000 |
Value assigned to the 'assembly' Priority Class. |
global.priorityClass.enabled |
bool |
true |
Enable the use of Priority Classes within the release. |
global.priorityClass.high-priority.value |
int |
8000 |
Value assigned to the 'high-priority' Priority Class. |
global.proxy |
object |
{} |
Configure the use of No Proxy within the release. |
global.proxy.httpProxy |
string |
"" |
Set the proxy details for 'https_proxy' and 'HTTPS_PROXY' |
global.proxy.httpsProxy |
string |
"" |
Set the proxy details for 'http_proxy' and 'HTTP_PROXY' |
global.proxy.noProxy |
string |
"" |
Set the proxy details for 'no_proxy' and 'NO_PROXY' |
global.queryEnvironments |
bool |
true |
Configure the use of Query Environments within the release. |
global.route |
object |
{} |
Configure Route resources for external access to the application. A Route resource is deployed when deploying on OpenShift cluster. |
global.route.annotations |
object |
{} |
Custom annotations to be applied to the Route resource. Dictionary of key-value pairs. Refer to Object Annotations. |
global.route.timeout |
string |
"6h" |
Overrides the routes default timeout. Refer to Route Timeouts. |
global.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
global.service |
object |
{} |
Configuration for Service resources across all subcharts. |
global.tests |
object |
{} |
Configuration for test hooks defined in helm charts. |
global.tests.annotations |
object |
{} |
Custom annotations to be applied to test resources. Dictionary of key-value pairs. Refer to Object Annotations. |
global.tests.backoffLimit |
int |
3 |
Back off limit for test Job. |
global.tests.timeout |
int |
600 |
Job active deadline seconds. |
global.timeouts |
object |
{} |
Global configuration component timeouts across all subcharts. Components should derive their own timeout based on these values. |
global.timeouts.keepAlive |
int |
75 |
System level keepAlive timeout. |
Assembly Resource¶
A Custom Resource of kind AssemblyResource is deployed within kdb Insights Enterprise.
This is used for defaulting configurations of deployed packages.
Configuration may be updated within the insights values configuration.
Keycloak¶
Configuration for this insights release Keycloak service.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.keycloak |
object |
{} |
Release keycloak information. |
kxi-operator.keycloak.clientID |
string |
"kxi-operator" |
Client ID assigned to kxi-operator to interact with Keycloak. |
kxi-operator.keycloak.enabled |
bool |
true |
Keycloak is enabled and required for this release. |
Pod Security¶
Configure the default podSecurityContext for all workloads deployed by the kxi-operator.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
Assembly mounts¶
Default Persistent Volume Claim configuration for any shared storage resources.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.mount.accessModes |
list |
[ |
Default Access Modes to use when creating Assembly mount Persistent Volume Claims. |
kxi-operator.config.mount.storageClass |
string |
"rook-cephfs" |
Default Storage Class to use when creating Assembly mount Persistent Volume Claims. |
Application Persistent Storage¶
Default Persistent Volume Claim configuration for any local storage resources.
Typically this requested Volume is used for storage for RT log files.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.element.accessModes |
list |
[ |
Default Access Modes to use when creating Assembly local Persistent Volume Claims. |
kxi-operator.config.element.storageClass |
string |
"" |
Default Storage Class to use when creating Assembly local Persistent Volume Claims. |
Aggregator¶
An Aggregator may be deployed as part of a package.
Default configuration may be set for all Aggregator deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.agg.affinity |
string |
"soft" |
Configure the Assembly Aggregator default anti-affinity. |
kxi-operator.config.agg.env |
list |
[] |
List of default environment variables to inject into all Aggregator containers. |
kxi-operator.config.agg.image |
object |
{} |
Configure the Assembly Aggregator Image details. Refer to Images. |
kxi-operator.config.agg.image.component |
string |
"kxi-sg-agg" |
Image component. |
kxi-operator.config.agg.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.agg.port |
int |
5070 |
Configure the Assembly Aggregator default container port. |
Resource Coordinator¶
A Resource Coordinator may be deployed as part of a package.
Default configuration may be set for all Resource Coordinator deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.rc.affinity |
string |
"soft" |
Configure the Assembly Resource Coordinator default anti-affinity. |
kxi-operator.config.rc.env |
list |
[] |
List of default environment variables to inject into all Resource Coordinator containers. |
kxi-operator.config.rc.image |
object |
{} |
Configure the Assembly Resource Coordinator Image details. Refer to Images. |
kxi-operator.config.rc.image.component |
string |
"kxi-sg-rc" |
Image component. |
kxi-operator.config.rc.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.rc.port |
int |
5060 |
Configure the Assembly Resource Coordinator default container port. |
Data Access¶
A Data Access instance may be deployed as part of a package.
dap instances have access to only one data source, i.e. application only contain data from a one of the defined mount resources within Assembly.
Default configuration may be set for all Data Access deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.dap.affinity |
string |
"hard" |
Configure the Assembly Data Access default anti-affinity. |
kxi-operator.config.dap.env |
list |
[] |
List of default environment variables to inject into all DA containers. |
kxi-operator.config.dap.image |
object |
{} |
Configure the Assembly Data Access Image details. Refer to Images. |
kxi-operator.config.dap.image.component |
string |
"kxi-da" |
Image component. |
kxi-operator.config.dap.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.dap.port |
int |
5080 |
Configure the Assembly Data Access default container port. |
Data Access Single¶
A Data Access Single instance may be deployed as part of a package.
This version of the Data Access instance, may mount all data sources from the mount configuration within the Assembly.
Default configuration may be set for all Data Access Single deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.dapSingle.affinity |
string |
"hard" |
Configure the Assembly Data Access Single default anti-affinity. |
kxi-operator.config.dapSingle.env |
list |
[] |
List of default environment variables to inject into all DA Single containers. |
kxi-operator.config.dapSingle.image |
object |
{} |
Configure the Assembly Data Access Single Image details. Refer to Images. |
kxi-operator.config.dapSingle.image.component |
string |
"kxi-da-single" |
Image component. |
kxi-operator.config.dapSingle.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.dapSingle.port |
int |
5080 |
Configure the Assembly Data Access Single default container port. |
RT¶
An RT may be deployed as part of a package.
Default configuration may be set for all RT deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.rt.affinity |
string |
"hard" |
Configure the Assembly RT default anti-affinity. |
kxi-operator.config.rt.containerPorts |
list |
[] |
Define all Container Ports to be exposed by RT containers. |
kxi-operator.config.rt.env |
list |
[] |
List of default environment variables to inject into all RT containers. |
kxi-operator.config.rt.externalNodePort |
bool |
false |
Deploy Externally facing RT services as NodePort Service type. |
kxi-operator.config.rt.externalServicePorts |
list |
[] |
Define all Service Ports to be exposed by RT external Service resources. |
kxi-operator.config.rt.image |
object |
{} |
Configure the Assembly RT Image details. Refer to Images. |
kxi-operator.config.rt.image.component |
string |
"kxi-rt" |
Image component. |
kxi-operator.config.rt.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.rt.maxDiskUsagePercent |
int |
90 |
Default maximum percentage of the available disk space that will be used by RT. |
kxi-operator.config.rt.probes |
object |
{} |
Configure the Assembly RT Probes. Refer to Configure Probes. |
kxi-operator.config.rt.probes.enabled |
bool |
true |
Enable or disable all probes for the Assembly RT. |
kxi-operator.config.rt.probes.livenessProbe |
object |
{} |
Configure the Assembly RT Liveness Probe. |
kxi-operator.config.rt.probes.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-operator.config.rt.probes.livenessProbe.failureThreshold |
int |
6 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-operator.config.rt.probes.livenessProbe.initialDelaySeconds |
int |
60 |
Number of seconds after the container has started before liveness probes are initiated. |
kxi-operator.config.rt.probes.livenessProbe.path |
string |
"/readiness" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-operator.config.rt.probes.livenessProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-operator.config.rt.probes.livenessProbe.port |
int |
6000 |
Where probeType is either "httpGet" or "tcpSocket" Name or number of the port to access on the container.. |
kxi-operator.config.rt.probes.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values httpGet, tcpSocket or exec. |
kxi-operator.config.rt.probes.livenessProbe.scheme |
string |
"HTTP" |
Where probeType is "httpGet", Scheme to use for connecting to the host, HTTP or HTTPS. |
kxi-operator.config.rt.probes.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-operator.config.rt.probes.readinessProbe |
object |
{} |
Configure the Assembly RT Readiness Probe. |
kxi-operator.config.rt.probes.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-operator.config.rt.probes.readinessProbe.failureThreshold |
int |
1 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-operator.config.rt.probes.readinessProbe.initialDelaySeconds |
int |
0 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-operator.config.rt.probes.readinessProbe.path |
string |
"/readiness" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-operator.config.rt.probes.readinessProbe.periodSeconds |
int |
2 |
How often (in seconds) to perform the probe. |
kxi-operator.config.rt.probes.readinessProbe.port |
int |
6000 |
Where probeType is either "httpGet" or "tcpSocket" Name or number of the port to access on the container. |
kxi-operator.config.rt.probes.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-operator.config.rt.probes.readinessProbe.scheme |
string |
"HTTP" |
Where probeType is "httpGet", Scheme to use for connecting to the host, HTTP or HTTPS. |
kxi-operator.config.rt.probes.readinessProbe.successThreshold |
int |
2 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-operator.config.rt.probes.readinessProbe.timeoutSeconds |
int |
5 |
Number of seconds after which the probe times out. |
kxi-operator.config.rt.probes.startUpProbe |
object |
{} |
Configure the Assembly RT Startup Probe. |
kxi-operator.config.rt.probes.startUpProbe.enabled |
bool |
false |
Enable probe. |
kxi-operator.config.rt.retentionDuration |
int |
10080 |
Default RT log retention period for merged RT stream log files in minutes. |
kxi-operator.config.rt.servicePorts |
list |
[] |
Define all Service Ports to be exposed by RT internal Service resources. |
kxi-operator.config.rt.volume |
object |
{} |
Configure the Assembly RT default local storage Persistent Volume Claim. |
kxi-operator.config.rt.volume.accessModes |
list |
[ |
Local storage Persistent Volume Claim Access Modes. |
kxi-operator.config.rt.volume.storageClass |
string |
"" |
Local storage Persistent Volume Claim StorageClass. |
Storage Manager¶
A Storage Manager may be deployed as part of a package.
Default configuration may be set for all Storage Manager deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.storageManager.affinity |
string |
"hard" |
Configure the Assembly Storage Manager default anti-affinity. |
kxi-operator.config.storageManager.dbm.env |
list |
[] |
List of default environment variables to inject into all Storage Manager DBM containers. |
kxi-operator.config.storageManager.dbm.image |
object |
{} |
Configure the Assembly Storage Manager DBM Image details. Refer to Images. |
kxi-operator.config.storageManager.dbm.image.component |
string |
"kxi-sm-dbm" |
Image component. |
kxi-operator.config.storageManager.dbm.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.storageManager.dbm.port |
int |
10004 |
Configure the Assembly Storage Manager DBM default container port. |
kxi-operator.config.storageManager.eod.env |
list |
[] |
List of default environment variables to inject into all Storage Manager EOD containers. |
kxi-operator.config.storageManager.eod.image |
object |
{} |
Configure the Assembly Storage Manager EOD Image details. Refer to Images. |
kxi-operator.config.storageManager.eod.image.component |
string |
"kxi-sm-eod" |
Image component. |
kxi-operator.config.storageManager.eod.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.storageManager.eod.port |
int |
10003 |
Configure the Assembly Storage Manager EOD default container port. |
kxi-operator.config.storageManager.eoi.env |
list |
[] |
List of default environment variables to inject into all Storage Manager EOI containers. |
kxi-operator.config.storageManager.eoi.image |
object |
{} |
Configure the Assembly Storage Manager EOI Image details. Refer to Images. |
kxi-operator.config.storageManager.eoi.image.component |
string |
"kxi-sm-eoi" |
Image component. |
kxi-operator.config.storageManager.eoi.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.storageManager.eoi.port |
int |
10002 |
Configure the Assembly Storage Manager EOI default container port. |
kxi-operator.config.storageManager.probes |
object |
{} |
Configure the Assembly Storage Manager Probes. Refer to Configure Probes. |
kxi-operator.config.storageManager.probes.enabled |
bool |
true |
Enable or disable all probes for the Assembly Storage Manager. |
kxi-operator.config.storageManager.probes.livenessProbe |
object |
{} |
Configure the Assembly Storage Manager Liveness Probe. |
kxi-operator.config.storageManager.probes.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-operator.config.storageManager.probes.livenessProbe.failureThreshold |
int |
5 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-operator.config.storageManager.probes.livenessProbe.initialDelaySeconds |
int |
240 |
Number of seconds after the container has started before startup probes are initiated. |
kxi-operator.config.storageManager.probes.livenessProbe.path |
string |
"/alive" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-operator.config.storageManager.probes.livenessProbe.periodSeconds |
int |
60 |
How often (in seconds) to perform the probe. |
kxi-operator.config.storageManager.probes.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-operator.config.storageManager.probes.livenessProbe.scheme |
string |
"HTTP" |
Where probeType is "httpGet", Scheme to use for connecting to the host, HTTP or HTTPS. |
kxi-operator.config.storageManager.probes.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-operator.config.storageManager.probes.livenessProbe.timeoutSeconds |
int |
5 |
Number of seconds after which the probe times out. |
kxi-operator.config.storageManager.probes.readinessProbe |
object |
{} |
Configure the Assembly Storage Manager Readiness Probe. |
kxi-operator.config.storageManager.probes.readinessProbe.enabled |
bool |
false |
Enable probe. |
kxi-operator.config.storageManager.probes.readinessProbe.failureThreshold |
int |
4 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-operator.config.storageManager.probes.readinessProbe.initialDelaySeconds |
int |
15 |
Number of seconds after the container has started before startup probes are initiated. |
kxi-operator.config.storageManager.probes.readinessProbe.path |
string |
"/ready" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-operator.config.storageManager.probes.readinessProbe.periodSeconds |
int |
4 |
How often (in seconds) to perform the probe. |
kxi-operator.config.storageManager.probes.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-operator.config.storageManager.probes.readinessProbe.scheme |
string |
"HTTP" |
Where probeType is "httpGet", Scheme to use for connecting to the host, HTTP or HTTPS. |
kxi-operator.config.storageManager.probes.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-operator.config.storageManager.probes.readinessProbe.timeoutSeconds |
int |
1 |
Number of seconds after which the probe times out. |
kxi-operator.config.storageManager.probes.startUpProbe |
object |
{} |
Configure the Assembly Storage Manager Startup Probe. |
kxi-operator.config.storageManager.probes.startUpProbe.command |
list |
[] |
Where probeType is "exec", Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. |
kxi-operator.config.storageManager.probes.startUpProbe.enabled |
bool |
true |
Enable probe. |
kxi-operator.config.storageManager.probes.startUpProbe.failureThreshold |
int |
6 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-operator.config.storageManager.probes.startUpProbe.periodSeconds |
int |
15 |
How often (in seconds) to perform the probe. |
kxi-operator.config.storageManager.probes.startUpProbe.probeType |
string |
"exec" |
Probe type. Permitted values httpGet, tcpSocket or exec. |
kxi-operator.config.storageManager.sm.env |
list |
[] |
List of default environment variables to inject into all Storage Manager SM containers. |
kxi-operator.config.storageManager.sm.image |
object |
{} |
Configure the Assembly Storage Manager SM Image details. Refer to Images. |
kxi-operator.config.storageManager.sm.image.component |
string |
"kxi-sm" |
Image component. |
kxi-operator.config.storageManager.sm.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.storageManager.sm.port |
int |
10001 |
Configure the Assembly Storage Manager SM default container port. |
kxi-operator.config.storageManager.smSingle.env |
list |
[] |
List of default environment variables to inject into all Storage Manager Single containers. |
kxi-operator.config.storageManager.smSingle.image |
object |
{} |
Configure the Assembly Storage Manager Single Image details. Refer to Images. |
kxi-operator.config.storageManager.smSingle.image.component |
string |
"kxi-sm-single" |
Image component. |
kxi-operator.config.storageManager.smSingle.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-operator.config.storageManager.smSingle.port |
int |
10001 |
Configure the Assembly Storage Manager Single default container port. |
Pipelines¶
Pipelines may be deployed as part of a package.
Default configuration may be set for all Pipelines deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.sp.env |
list |
[] |
List of default environment variables to inject into all Pipeline containers. |
kdbx workloads¶
kdbx workloads may be deployed as part of a package.
Default configuration may be set for all kdbx workloads deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.kdbx.env |
list |
[] |
List of default environment variables to inject into all kdb-x containers. |
kxi-operator.config.kdbx.image |
object |
{} |
Configure the KDB-X Image details. Refer to Images. |
kxi-operator.config.kdbx.image.component |
string |
"kxi-kdbx-base" |
Image component. |
kxi-operator.config.kdbx.image.tag |
string |
"1.19.0" |
Image tag. |
KXI Sidecar¶
Where metrics or entitlements are enabled within the package a sidecar is deployed along side the workload containers.
Default configuration may be set for all sidecar containers deployed within the insights release namespace.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-operator.config.sidecar |
object |
{} |
Configure the KXI Sidecar to be used across ASM components. |
kxi-operator.config.sidecar.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
Subchart configuration¶
Configuration for subcharts of insights.
api-gateway¶
The API Gateway is the main ingress layer for APIs into the environment. It sits in front of internal services and exposes external HTTP endpoints for clients, tools, and the web interface.
Configuration for the api-gateway Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
api-gateway.affinity |
string |
"hard" |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
api-gateway.auth |
object |
{} |
Authentication configuration. |
api-gateway.auth.enabled |
bool |
true |
Enable authentication. |
api-gateway.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
api-gateway.autoscaling.enabled |
bool |
false |
Enable use of HPA within application. |
api-gateway.autoscaling.maxReplicas |
int |
10 |
Maximum permitted replicas to be running. |
api-gateway.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
api-gateway.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
api-gateway.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
api-gateway.autoscaling.stabilizationWindowSeconds |
int |
60 |
Stabilization window is used to restrict the flapping of replica count when the metrics used for scaling keep fluctuating. |
api-gateway.autoscaling.targetCPUUtilizationPercentage |
int |
80 |
Threshold to trigger a scale in replica based on average CPU utilization. |
api-gateway.autoscaling.type |
string |
"ContainerResource" |
Kubernetes metric type to use. Permitted values - "Resource" or "ContainerResource". |
api-gateway.configAnnotations |
object |
{} |
Custom annotations to be applied to ConfigMap resources. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.debug |
object |
{} |
Debug configuration. |
api-gateway.debug.enabled |
bool |
true |
Enable debug logging. |
api-gateway.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
api-gateway.encryption |
object |
{} |
Configure Encryption. |
api-gateway.encryption.enabled |
bool |
false |
Enable encryption within chart. |
api-gateway.env |
object |
{} |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
api-gateway.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
api-gateway.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
api-gateway.image.component |
string |
"kxi-api-gateway" |
Image component. |
api-gateway.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
api-gateway.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
api-gateway.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
api-gateway.image.useLocal |
bool |
false |
When enabled, global configuration is ignored and local configuration is used. |
api-gateway.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
api-gateway.ingress |
object |
{} |
Configure Ingress resources for external access to the application. |
api-gateway.ingress.annotations |
object |
{} |
Custom annotations to be applied to the Ingress resource. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.ingress.class |
string |
"nginx-community" |
Specify the Ingress Controller class to use for routing traffic to the application. |
api-gateway.ingress.enabled |
bool |
true |
Enable ingress. |
api-gateway.ingress.path |
string |
"/" |
Host endpoint to direct to target Kubernetes Service. |
api-gateway.ingress.rewrite |
bool |
true |
Rewrite ingress path, stripping path while preserving endpoints. |
api-gateway.initContainerProps |
object |
{} |
Gateway Init container properties such as image name and tag are specified here. |
api-gateway.initContainerProps.image |
string |
"curl-jq" |
Init container image. |
api-gateway.initContainerProps.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
api-gateway.initContainerProps.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
api-gateway.initContainerProps.tag |
string |
"2.1.0" |
Init container tag. |
api-gateway.keycloakRealmInit |
object |
{} |
Configure the Keycloak Realm init job. Used to check for the successful import of keycloak realm. |
api-gateway.keycloakRealmInit.image |
object |
{} |
Configure the Keycloak realm check job image details. Refer to Images. |
api-gateway.keycloakRealmInit.image.component |
string |
"curl-jq" |
Image component. |
api-gateway.keycloakRealmInit.image.tag |
string |
"2.1.0" |
Image tag. |
api-gateway.keycloakRealmInit.jobName |
string |
"" |
Keycloak config CLI job to lookup. Job is checked for successful import Keycloak realm. |
api-gateway.kxi-ent-srv |
object |
{} |
Configuration for kxi-ent-srv. |
api-gateway.kxi-info-srv |
object |
{} |
Configuration for kxi-info-srv. |
api-gateway.kxi-package-manager |
object |
{ |
Configuration for NGINX.conf entries for Package Manager |
api-gateway.kxi-package-manager.apiVersion |
string |
"v0" |
API Version |
api-gateway.kxi-sp |
object |
{} |
Configuration for KXI Stream Processor. |
api-gateway.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
api-gateway.livenessProbe.enabled |
bool |
true |
Enable probe. |
api-gateway.livenessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
api-gateway.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
api-gateway.livenessProbe.path |
string |
"/healthz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
api-gateway.livenessProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
api-gateway.livenessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
api-gateway.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
api-gateway.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
api-gateway.livenessProbe.timeoutSeconds |
int |
1 |
Number of seconds after which the probe times out. |
api-gateway.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
api-gateway.nginx |
object |
{} |
Variable used to override default entries in nginx.conf |
api-gateway.nginx.conf |
string |
"/usr/local/openresty/nginx/conf/nginx.conf" |
Path the nginx.conf used in the configMap |
api-gateway.nginx.events |
object |
{} |
Nginx events properties. |
api-gateway.nginx.http |
object |
{} |
Http block default values. |
api-gateway.nginx.http.add_header |
object |
{} |
Add multiple add_headers directives to the http block. |
api-gateway.nginx.http.server |
object |
{} |
http.server block configuration. |
api-gateway.nginx.luaOpts |
object |
{} |
Lua options for Nginx. |
api-gateway.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
api-gateway.observability |
object |
{} |
Configure the use of Observability within the release. |
api-gateway.observability.enabled |
bool |
false |
Enable the use of Observability within the release. |
api-gateway.observability.service |
string |
"" |
Set static service endpoint, used where 'withinRelease' is set to 'false'. |
api-gateway.observability.withinRelease |
bool |
true |
Observability deployed as part of release. 'service' will be generated based on release. |
api-gateway.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.podDisruptionBudget |
object |
{} |
Provisions a Pod Disruption Budget (PDB) to restrict pod evictions. NOTE that only one of minAvailable and maxUnavailable may be set.Refer to Configure PDB. |
api-gateway.podDisruptionBudget.enabled |
bool |
true |
Enable Pod Disruption Budget (PDB) for the application. |
api-gateway.podDisruptionBudget.minAvailable |
int |
1 |
Minimum replicas required by this workload, expressed as an integer or percentage. |
api-gateway.podLabels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
api-gateway.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
api-gateway.port |
int |
8080 |
Port number to assign to the exposed container port. |
api-gateway.qe-gateway |
object |
{} |
Configuration for qe-gateway. |
api-gateway.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
api-gateway.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
api-gateway.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
api-gateway.readinessProbe.enabled |
bool |
true |
Enable probe. |
api-gateway.readinessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
api-gateway.readinessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before readiness probes are initiated. |
api-gateway.readinessProbe.path |
string |
"/healthz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
api-gateway.readinessProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
api-gateway.readinessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
api-gateway.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
api-gateway.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
api-gateway.readinessProbe.timeoutSeconds |
int |
1 |
Number of seconds after which the probe times out. |
api-gateway.replicaCount |
int |
3 |
This sets the replicaSet count.Refer to ReplicaSet. |
api-gateway.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
api-gateway.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
api-gateway.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
api-gateway.service.port |
int |
8080 |
Set exposed Service Port. Refer to Service Ports. |
api-gateway.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
api-gateway.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
api-gateway.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
api-gateway.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
api-gateway.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
api-gateway.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
api-gateway.sg-gateway |
object |
{} |
Configuration for sg-gateway. |
api-gateway.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
api-gateway.startupProbe.enabled |
bool |
true |
Enable probe. |
api-gateway.startupProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
api-gateway.startupProbe.path |
string |
"/healthz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
api-gateway.startupProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
api-gateway.startupProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
api-gateway.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
api-gateway.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
gui¶
The Web Interface is a browser based application for building, querying, monitoring, and visualizing your environment.
Configuration for the gui Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
gui.affinity |
string |
"hard" |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
gui.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
gui.autoscaling.enabled |
bool |
false |
Enable use of HPA within application. |
gui.autoscaling.maxReplicas |
int |
1 |
Maximum permitted replicas to be running. |
gui.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
gui.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
gui.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
gui.autoscaling.targetCPUUtilizationPercentage |
int |
80 |
Threshold to trigger a scale in replica based on average CPU utilization. |
gui.autoscaling.type |
string |
"Resource" |
Kubernetes metric type to use. Permitted values - "Resource" or "ContainerResource". |
gui.clusterProvider |
string |
"unknown" |
Specifies the Kubernetes infrastructure provider. Triggers specific provider logic e.g annotations or ingress. Permitted values - "aks", "eks", "gke", "openshift" or "unknown". |
gui.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
gui.encryption |
object |
{} |
Configure Encryption. |
gui.encryption.enabled |
bool |
false |
Enable encryption within chart. |
gui.env |
object |
{} |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
gui.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
gui.gui-gateway |
object |
{} |
Configure gui-gateway subchart. |
gui.gui-gateway.data.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
gui.gui-gateway.data.image.component |
string |
"kxi-gui-data" |
Image component. |
gui.gui-gateway.data.image.pullPolicy |
string |
"Always" |
Image pull policy. Refer to Image Pull Policy. |
gui.gui-gateway.data.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
gui.gui-gateway.data.port |
int |
6812 |
Data port |
gui.gui-gateway.gateway.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
gui.gui-gateway.gateway.image.component |
string |
"kxi-gui-gateway" |
Image component. |
gui.gui-gateway.gateway.image.pullPolicy |
string |
"Always" |
Image pull policy. Refer to Image Pull Policy. |
gui.gui-gateway.gateway.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
gui.gui-gateway.gateway.port |
int |
10001 |
Gateway port |
gui.gui-gateway.license |
object |
{} |
Configure the KX License to be used by kdb applications. |
gui.gui-gateway.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
gui.gui-gateway.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
gui.gui-gateway.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
gui.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
gui.image.component |
string |
"kxi-gui-app" |
Image component. |
gui.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
gui.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
gui.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
gui.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within the chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
gui.kxi-sp |
object |
{} |
kxi-sp service connection details.If empty object, will build connection details using release name. |
gui.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
gui.livenessProbe.enabled |
bool |
true |
Enable probe. |
gui.livenessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
gui.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
gui.livenessProbe.path |
string |
"/" |
Where probeType is "httpGet", Path to access on the HTTP server. |
gui.livenessProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
gui.livenessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
gui.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
gui.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
gui.livenessProbe.timeoutSeconds |
int |
1 |
Number of seconds after which the probe times out. |
gui.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
gui.nginx |
object |
{} |
Variable used to override default entries in nginx.conf |
gui.nginx.events |
object |
{} |
Nginx events properties. |
gui.nginx.http |
object |
{} |
Http block default values. |
gui.nginx.http.server |
object |
{} |
http.server block configuration. |
gui.nginx.http.server.large_client_header_buffers |
string |
"4 16k" |
Large client header buffers |
gui.nginx.http.server.listen |
int |
8080 |
Port to listen on |
gui.nginx.http.server.server_name |
string |
"localhost" |
Server name |
gui.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
gui.pdfServer |
object |
{} |
Configure the PDF Server |
gui.pdfServer.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
gui.pdfServer.image.component |
string |
"kxi-gui-pdf" |
Image component. |
gui.pdfServer.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
gui.pdfServer.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
gui.pdfServer.port |
int |
3333 |
Port number to assign to the exposed container port. |
gui.pdfServer.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
gui.pdfServer.volume |
object |
{ |
EmptyDir volume configuration for PDF Server. Set values below to adjust volume mounted |
gui.pdfServer.volume.name |
string |
"pdf-tmp" |
Name of the volume. |
gui.pdfServer.volume.sizeLimit |
string |
"250Mi" |
Size limit for the volume. |
gui.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
gui.podDisruptionBudget |
object |
{} |
Provisions a Pod Disruption Budget (PDB) to restrict pod evictions. NOTE that only one of minAvailable and maxUnavailable may be set.Refer to Configure PDB. |
gui.podDisruptionBudget.enabled |
bool |
false |
Enable Pod Disruption Budget (PDB) for the application. |
gui.podDisruptionBudget.minAvailable |
int |
1 |
Minimum replicas required by this workload, expressed as an integer or percentage. |
gui.podLabels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
gui.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
gui.port |
int |
8080 |
Port number to assign to the exposed container port. |
gui.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
gui.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
gui.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
gui.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
gui.readinessProbe.enabled |
bool |
true |
Enable probe. |
gui.readinessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
gui.readinessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before readiness probes are initiated. |
gui.readinessProbe.path |
string |
"/" |
Where probeType is "httpGet", Path to access on the HTTP server. |
gui.readinessProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
gui.readinessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
gui.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
gui.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
gui.readinessProbe.timeoutSeconds |
int |
1 |
Number of seconds after which the probe times out. |
gui.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
gui.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
gui.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
gui.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
gui.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
gui.service.port |
int |
8080 |
Set exposed Service Port. Refer to Service Ports. |
gui.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
gui.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
gui.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
gui.serviceAccount.autoMount |
bool |
false |
Automatically mount a Service Account's API credentials. |
gui.serviceAccount.create |
bool |
false |
Specifies whether a Service Account should be created. |
gui.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
gui.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
gui.startupProbe.enabled |
bool |
true |
Enable probe. |
gui.startupProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
gui.startupProbe.path |
string |
"/" |
Where probeType is "httpGet", Path to access on the HTTP server. |
gui.startupProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
gui.startupProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
gui.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
gui.tmpVolume |
object |
{} |
Configure the mounted emptyDir tmp volume. |
gui.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
keycloak-config-cli¶
The Keycloak Config CLI is a utility designed to manage Keycloak configurations as code and is used as part of installation, upgrade and rollback of Keycloak.
Configuration for the keycloak-config-cli Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
keycloak-config-cli.affinity |
object |
{} |
Affinity rules for pod assignment. Allows advanced scheduling constraints based on nodes or pods labels. nodeAffinity, podAffinity, podAntiAffinity |
keycloak-config-cli.annotations |
object |
{} |
Custom annotations to be applied to the Job. Define helm post hook here |
keycloak-config-cli.args |
list |
[] |
Container ARGs. |
keycloak-config-cli.backoffLimit |
int |
1 |
Count of retries. A backoff value of 2 means 3 tries in total. |
keycloak-config-cli.cleanup |
object |
{} |
Cleanup job settings. |
keycloak-config-cli.cleanup.annotations |
object |
{} |
Custom annotations to be applied to the Job. |
keycloak-config-cli.cleanup.enabled |
bool |
false |
enabled: true means delete realm on uninstall |
keycloak-config-cli.cleanup.image |
object |
{} |
Configure Cleanup Job Image repository details. Refer to Images. |
keycloak-config-cli.cleanup.image.component |
string |
"curl-jq" |
Image component. |
keycloak-config-cli.cleanup.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
keycloak-config-cli.cleanup.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
keycloak-config-cli.cleanup.image.tag |
string |
"2.1.0" |
Image tag. |
keycloak-config-cli.config |
object |
{<realm name>: { inline: {}, file: "" }} |
Configuration to be added to a Kubernetes secret. Replace <realm name> with the actual realm identifier.Populate either inline or file depending on how you want to provide configuration.- inline reads values and encodes details to a secret.- file expects a file path relative to chart root.The file is read and encodes details to a secret. |
keycloak-config-cli.containerSecurityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
keycloak-config-cli.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
keycloak-config-cli.enabled |
bool |
true |
Enable Keycloak Config CLI deployment. |
keycloak-config-cli.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "MY_ENV" : "value" } |
keycloak-config-cli.existingConfigSecret |
string |
"keycloak-realm" |
Name of existing Kubernetes secret containing realm configurations. If set, config field is ignored. |
keycloak-config-cli.existingSecret |
string |
"kxi-keycloak" |
Existing Kubernetes secret containing Authentication details |
keycloak-config-cli.existingSecretKey |
string |
"admin-password" |
The key in the existing secret that stores the password. |
keycloak-config-cli.extraVolumeMounts |
list |
{} |
Add additional volumes mounts, e. g. for custom secrets Refer to Volumes. |
keycloak-config-cli.extraVolumes |
list |
{} |
Add additional volumes, e.g. for custom secrets Refer to Volumes. |
keycloak-config-cli.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
keycloak-config-cli.image |
object |
{} |
Configure Cleanup Job Image repository details. Refer to Images. |
keycloak-config-cli.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
keycloak-config-cli.image.repository |
string |
"docker.io/adorsys/keycloak-config-cli" |
Image repository. |
keycloak-config-cli.image.tag |
string |
"6.4.0-24" |
Image tag. |
keycloak-config-cli.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
keycloak-config-cli.labels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
keycloak-config-cli.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
keycloak-config-cli.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
keycloak-config-cli.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
keycloak-config-cli.podLabels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
keycloak-config-cli.resources |
object |
{} |
Container resource requests and limits. Refer to Container Resources. |
keycloak-config-cli.secrets |
list |
{} |
Map of Kubernetes environment variable to be defined in a Kubernetes Secret. |
keycloak-config-cli.securityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
keycloak-config-cli.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
keycloak-config-cli.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
keycloak-config-cli.serviceAccount.autoMount |
bool |
false |
Automatically mount a Service Account's API credentials. |
keycloak-config-cli.serviceAccount.create |
bool |
false |
Specifies whether a Service Account should be created. |
keycloak-config-cli.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
keycloak-config-cli.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
keycloak-config-cli.ttlSecondsAfterFinished |
int |
30 |
Time in seconds after completion for TTL controller to to remove job and its dependents |
keycloak¶
Keycloak-X is an open-source Identity and Access Management (IAM) platform designed to secure modern applications and services.
See here for additional configuration details
Configuration for the keycloak Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
keycloak.auth.existingSecret |
string |
"kxi-keycloak" |
Existing Kubernetes secret containing Authentication details for keycloak. |
keycloak.cache |
object |
{ |
Keycloak cache configuration. |
keycloak.command |
list |
[] |
Container command. |
keycloak.containerSecurityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
keycloak.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
keycloak.enabled |
bool |
true |
Enable Keycloak deployment. |
keycloak.extraEnv |
string |
"{{ include "keycloak.extraEnv" . }} |
Additional environment variable to inject into all Keycloak containers. |
keycloak.extraInitContainers |
string |
"" |
Add additional init containers to inject into Pod. |
keycloak.extraVolumeMounts |
string |
"" |
Add additional volumes mounts, e. g. for custom secrets Refer to Volumes. |
keycloak.extraVolumes |
string |
"" |
Add additional volumes, e.g. for custom secrets Refer to Volumes. |
keycloak.http |
object |
{ |
Keycloak http server configuration. |
keycloak.httpRoute |
object |
{ |
Expose the service via gateway-api HTTPRoute Requires Gateway API resources and suitable controller installed within the cluster (see: here.) |
keycloak.importUsers |
bool |
false |
Import users into the Keycloak realm during install or upgrade. |
keycloak.initClient |
object |
{} |
Configure the realms Init Client. |
keycloak.initClient.clientId |
string |
"" |
Client ID assigned to init client. |
keycloak.initClient.clientSecret |
string |
"" |
Client Secret assigned to init client. |
keycloak.initClient.enabled |
bool |
false |
Enable Init Client creation with realm. |
keycloak.initClient.realmRoles |
list |
[ |
List of keycloak roles to be assigned to init client. |
keycloak.initUser |
object |
{} |
Configure the realms Init User. |
keycloak.initUser.auth |
string |
"" |
Password for init user. |
keycloak.initUser.email |
string |
"" |
Email address assigned to init user. |
keycloak.initUser.enabled |
bool |
false |
Enable Init user creation with realm. |
keycloak.initUser.name |
string |
"" |
Name to be given to created init user. |
keycloak.initUser.realmRoles |
list |
[] |
List of keycloak roles to be assigned to init user. |
keycloak.initUser.temporary |
bool |
true |
Set password as temporary |
keycloak.keycloakConfigCli |
object |
{} |
Configuration for the keycloak-config-cli sub-chart |
keycloak.keycloakConfigCli.image.tag |
string |
"6.4.0-24" |
Image tag. |
keycloak.passwordPolicy |
object |
{} |
Configure the realms Password Policy. |
keycloak.passwordPolicy.enabled |
bool |
true |
Enable password policy requirement |
keycloak.passwordPolicy.policy |
object |
{} |
Password Policy |
keycloak.passwordPolicy.policy.digits |
int |
1 |
Defines the minimum numerical characters within password. |
keycloak.passwordPolicy.policy.forceExpiredPasswordChange |
int |
90 |
Defines the number of days before password reset is required. |
keycloak.passwordPolicy.policy.length |
int |
14 |
Defines the minimum character length of password. |
keycloak.passwordPolicy.policy.lowerCase |
int |
1 |
Defines the minimum lowercase characters within password. |
keycloak.passwordPolicy.policy.passwordHistory |
int |
24 |
Defines the number of previous passwords retained by the system to prevent reuse. |
keycloak.passwordPolicy.policy.specialChars |
int |
1 |
Defines the minimum special characters within password. |
keycloak.passwordPolicy.policy.upperCase |
int |
1 |
Defines the minimum uppercase characters within password. |
keycloak.passwordPolicy.templateFile |
string |
"template.ftl" |
Custom template file for the password policy. |
keycloak.passwordPolicy.text |
string |
"<p>Password policy:</p> |
Password policy description |
keycloak.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
keycloak.podLabels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
keycloak.podManagementPolicy |
string |
"Parallel" |
Issues with configuration can cause a statefulset to get into a condition which must be manually recovered. If during development, issues are encountered, setting this to Parallel should prevent this issue. However, for most environments, the default 'OrderedReady' should be used. Refer to Pod Management. |
keycloak.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
keycloak.priorityClassName |
string |
"system-cluster-critical" |
Kubernetes priority class to assign to Keycloak pods |
keycloak.proxy |
object |
{ |
Keycloak proxy configuration. |
keycloak.realmAnnotations |
object |
{} |
Custom annotations to be applied to the realm. Dictionary of key-value pairs. Refer to Object Annotations. |
keycloak.replicas |
int |
3 |
This sets the replicaSet count.Refer to ReplicaSet. |
keycloak.resetPasswordAllowed |
bool |
false |
Reset Password allowed. |
keycloak.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
keycloak.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
keycloak.service.extraPorts |
list |
{} |
Additional Service port to expose. |
keycloak.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
keycloak.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
keycloak.serviceAccount.automountServiceAccountToken |
bool |
true |
Automatically mount a Service Account's API credentials. |
keycloak.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
keycloak.smtpServer |
object |
{ |
Configure SMTP Server |
kxi-ent-srv¶
The Entitlement Service is used to control who has entitlements to query specific databases and manage specific packages across the application.
Configuration for the kxi-ent-srv Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-ent-srv.adminRoles |
list |
[ |
List of keycloak roles that grant "Admin" level access to a user. |
kxi-ent-srv.affinity |
object |
{} |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-ent-srv.cacheRefresh |
int |
10 |
Interval in seconds between each Entitlements cache refresh. |
kxi-ent-srv.daemonSet |
bool |
false |
Deploy workload as a daemonSet resource. |
kxi-ent-srv.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
kxi-ent-srv.encryption |
object |
{} |
Configure Encryption. |
kxi-ent-srv.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-ent-srv.externalDatabase |
object |
{} |
Configuration for external database. Only used when postgresql.enabled is set to false |
kxi-ent-srv.externalDatabase.createDatabase |
bool |
true |
Application should attempt to create database during initialization. |
kxi-ent-srv.externalDatabase.database |
string |
"<.Release.Namespace>-kxi-ent" |
Name of external database to connect to. |
kxi-ent-srv.externalDatabase.existingSecret |
string |
"" |
Name of an existing Kubernetes Secret containing the database credentials. |
kxi-ent-srv.externalDatabase.existingSecretPasswordKey |
string |
"" |
Key within existingSecret that containers database password. |
kxi-ent-srv.externalDatabase.existingSecretUserKey |
string |
"" |
Key within existingSecret that containers database username. |
kxi-ent-srv.externalDatabase.host |
string |
"" |
Hostname of external database server. |
kxi-ent-srv.externalDatabase.port |
int |
5432 |
Port number of external database server. |
kxi-ent-srv.externalDatabase.username |
string |
"" |
Username to authenticate with the external database. |
kxi-ent-srv.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-ent-srv.http |
object |
{} |
Configuration for the http REST Service. |
kxi-ent-srv.http.idleTimeout |
string |
"74" |
Maximum duration in seconds to wait for the next request. |
kxi-ent-srv.http.readTimeout |
int |
10 |
Maximum duration in seconds for reading the entire request, including the body. A zero or negative value means there will be no timeout. |
kxi-ent-srv.http.writeTimeout |
int |
10 |
Maximum duration in seconds before timing out writes of the response. |
kxi-ent-srv.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-ent-srv.image.component |
string |
"kxi-ent-srv" |
Image component. |
kxi-ent-srv.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-ent-srv.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-ent-srv.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
kxi-ent-srv.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-ent-srv.initDBJob |
object |
{} |
Configure the init DB job. |
kxi-ent-srv.initDBJob.image |
object |
{} |
Configure the Init DB Image details. Refer to Images. |
kxi-ent-srv.initDBJob.image.component |
string |
"postgresql" |
Image component. |
kxi-ent-srv.initDBJob.image.repository |
string |
"docker.io/bitnamilegacy" |
Override image repository across all subcharts. |
kxi-ent-srv.initDBJob.image.tag |
string |
"15.0.0-debian-11-r1" |
Image tag. |
kxi-ent-srv.initDBJob.image.useLocal |
bool |
true |
When enabled, global configuration is ignored and local configuration is used. |
kxi-ent-srv.initDBJob.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-ent-srv.keycloak |
object |
{} |
Configure Keycloak realm and users within this chart. |
kxi-ent-srv.keycloak.auth.existingSecret |
string |
"" |
The name of existing Kubernetes Secret containing the Keycloak password. |
kxi-ent-srv.keycloak.enabled |
bool |
true |
Keycloak is deployed and integrated with this release. |
kxi-ent-srv.keycloak.username |
string |
"user" |
Username used to authenticate and interact with Keycloak. |
kxi-ent-srv.keycloakRealmInit |
object |
{} |
Configure the Keycloak Realm init job. Used to check for the successful import of keycloak realm. |
kxi-ent-srv.keycloakRealmInit.image |
object |
{} |
Configure the Keycloak realm check job image details. Refer to Images. |
kxi-ent-srv.keycloakRealmInit.image.component |
string |
"curl-jq" |
Image component. |
kxi-ent-srv.keycloakRealmInit.image.tag |
string |
"2.0.2" |
Image tag. |
kxi-ent-srv.keycloakRealmInit.jobName |
string |
"" |
Keycloak config CLI job to lookup. Job is checked for successful import Keycloak realm. |
kxi-ent-srv.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-ent-srv.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-ent-srv.livenessProbe.path |
string |
"/alive" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-ent-srv.livenessProbe.periodSeconds |
int |
20 |
How often (in seconds) to perform the probe. |
kxi-ent-srv.livenessProbe.port |
int |
8080 |
Where probeType is either httpGet or tcpSocket, Name or number of the port to access on the container. |
kxi-ent-srv.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-ent-srv.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-ent-srv.metrics.enabled |
bool |
false |
Enable metric generation. |
kxi-ent-srv.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-ent-srv.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
kxi-ent-srv.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
kxi-ent-srv.metrics.serviceMonitor.interval |
string |
"30s" |
Frequency which Prometheus should attempt to scrape metrics from target service. Refer to GoDuration. |
kxi-ent-srv.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-ent-srv.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-ent-srv.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-ent-srv.podOwnerAnnotation |
string |
"" |
The annotation key appended to pod resource within the namespace to identify 'Owner'. |
kxi-ent-srv.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-ent-srv.port |
int |
8080 |
Port number to assign to the exposed container port. |
kxi-ent-srv.postgresql |
object |
{} |
Configuration for the PostgreSQL subchart. |
kxi-ent-srv.postgresql.audit |
object |
{} |
Configuration for PostgreSql auditing. |
kxi-ent-srv.postgresql.audit.clientMinMessages |
string |
"debug5" |
Minimum message severity to send to client. |
kxi-ent-srv.postgresql.audit.pgAuditLog |
string |
"ALL" |
Configure message classes to log. |
kxi-ent-srv.postgresql.audit.pgAuditLogCatalog |
string |
"on" |
Enabled session auditing for catalog tables. |
kxi-ent-srv.postgresql.auth |
object |
{} |
Authentication configuration for PostgreSQL. |
kxi-ent-srv.postgresql.auth.database |
string |
"kxi-ent" |
Name for the custom database to create |
kxi-ent-srv.postgresql.auth.existingSecret |
string |
"" |
Name of an existing Kubernetes Secret containing the database credentials. |
kxi-ent-srv.postgresql.auth.password |
string |
"" |
Password for the custom user. |
kxi-ent-srv.postgresql.auth.postgresPassword |
string |
"" |
Password for the postgres superuser. |
kxi-ent-srv.postgresql.auth.username |
string |
"app" |
Name for the custom user to create. |
kxi-ent-srv.postgresql.enabled |
bool |
false |
Specifies whether to deploy PostgreSQL subchart. |
kxi-ent-srv.postgresql.nameOverride |
string |
"kxi-ent-pg" |
Override Chart name. Used when generating resource names |
kxi-ent-srv.postgresql.primary |
object |
{} |
Configuration for the primary PostgreSql instance. |
kxi-ent-srv.postgresql.primary.persistence |
object |
{} |
Configuration for the Persistent Volume Claim. |
kxi-ent-srv.postgresql.primary.persistence.size |
string |
"1Gi" |
The request size of the Persistent Volume Claim. |
kxi-ent-srv.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-ent-srv.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-ent-srv.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-ent-srv.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-ent-srv.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-ent-srv.readinessProbe.initialDelaySeconds |
int |
5 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-ent-srv.readinessProbe.path |
string |
"/ready" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-ent-srv.readinessProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-ent-srv.readinessProbe.port |
int |
8080 |
Where probeType is either httpGet or tcpSocket, Name or number of the port to access on the container. |
kxi-ent-srv.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-ent-srv.replicaCount |
int |
2 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-ent-srv.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-ent-srv.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-ent-srv.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-ent-srv.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-ent-srv.service.name |
string |
"http" |
Set exposed Service Port name. Refer to Service Ports. |
kxi-ent-srv.service.port |
int |
8080 |
Set exposed Service Port. Refer to Service Ports. |
kxi-ent-srv.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-ent-srv.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-ent-srv.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-ent-srv.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-ent-srv.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-ent-srv.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-ent-srv.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-ent-srv.startupProbe.enabled |
bool |
true |
Enable probe. |
kxi-ent-srv.startupProbe.failureThreshold |
int |
6 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-ent-srv.startupProbe.initialDelaySeconds |
int |
5 |
Number of seconds after the container has started before startup probes are initiated. |
kxi-ent-srv.startupProbe.path |
string |
"/startup" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-ent-srv.startupProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-ent-srv.startupProbe.port |
int |
8080 |
Where probeType is either httpGet or tcpSocket, Name or number of the port to access on the container. |
kxi-ent-srv.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-ent-srv.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-ent-srv.updateStrategy |
object |
{} |
Configuration for Deployment updates."Recreate" will delete all Deployment Pods."RollingUpdate" orchestrates a controlled update.Refer to UpgradeStrategy. |
kxi-ent-srv.updateStrategy.type |
string |
"RollingUpdate" |
Update type. Permitted values - "RollingUpdate", "Recreate". |
kxi-ent-srv.viewerRoles |
list |
[ |
List of keycloak roles that grant "Viewer" level access to a user. |
kxi-ent-srv.writerRoles |
list |
[ |
List of keycloak roles that grant "Writer" level access to a user. |
kxi-ent-srv.zap |
object |
{} |
Configure the zap logging library. |
kxi-ent-srv.zap.logFormat |
string |
"json" |
Define the output structure for the logs. |
kxi-ent-srv.zap.logLevel |
string |
"info" |
The minimum log severity level to output. |
kxi-ent-srv.zap.stacktraceLevel |
string |
"panic" |
The log level at which stack traces are captured and attached. |
kxi-ent-srv.zap.timeEncoding |
string |
"iso8601" |
The formatting for the log timestamps. |
kxi-info-srv¶
The Information Service provides connection and metadata details for external publishers and subscribers.
Configuration for the kxi-info-srv Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-info-srv.affinity |
object |
{} |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-info-srv.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
kxi-info-srv.autoscaling.enabled |
bool |
true |
Enable use of HPA within deployment. |
kxi-info-srv.autoscaling.maxReplicas |
int |
5 |
Maximum permitted replicas to be running. |
kxi-info-srv.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
kxi-info-srv.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
kxi-info-srv.autoscaling.scaleDownPolicy[0] |
object |
{ |
Scale down by 50% replicaCount every 30 seconds |
kxi-info-srv.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
kxi-info-srv.autoscaling.scaleUpPolicy[0] |
object |
{ |
Scale up by 1 Pod every 120 seconds |
kxi-info-srv.autoscaling.stabilizationWindowSeconds |
int |
60 |
Stabilization window is used to restrict the flapping of replica count when the metrics used for scaling keep fluctuating. |
kxi-info-srv.autoscaling.targetCPUUtilizationPercentage |
int |
100 |
Threshold to trigger a scale in replica based on average CPU utilization. |
kxi-info-srv.autoscaling.type |
string |
"ContainerResource" |
Kubernetes metric type to use. Permitted values - "Resource" or "ContainerResource". |
kxi-info-srv.clientController |
object |
{} |
Configure Client resource details. |
kxi-info-srv.clientController.certificate |
object |
{} |
Configure Client Certificate details. |
kxi-info-srv.clientController.certificate.duration |
string |
"2160h" |
Certificate duration |
kxi-info-srv.clientController.certificate.renew |
string |
"360h" |
Certificate renewal. |
kxi-info-srv.clientController.clientPrefix |
string |
"kx-client--" |
clientPrefix Prefix to append to all resources created for client on enrollment. |
kxi-info-srv.clientz |
object |
{} |
Configure the integration of a component's connection information for tracking the relationship of different services within Insights. |
kxi-info-srv.clientz.enabled |
bool |
false |
Enable or disable the Side Car capturing client data from the main container. |
kxi-info-srv.clientz.useLocal |
bool |
true |
When enabled, global configuration is ignored and local configuration is used. |
kxi-info-srv.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
kxi-info-srv.encryption |
object |
{} |
Configure Encryption. |
kxi-info-srv.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-info-srv.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-info-srv.healthz |
object |
{} |
Configure the integration of a component's health status within Insights. |
kxi-info-srv.healthz.enabled |
bool |
false |
Enable the use of health status integration. |
kxi-info-srv.healthz.useLocal |
bool |
true |
When enabled, global configuration is ignored and local configuration is used. |
kxi-info-srv.http |
object |
{} |
HTTP server configuration. |
kxi-info-srv.http.idleTimeout |
string |
"74" |
Maximum duration in seconds to wait for the next request when keep-alives are enabled. If zero, the value of readTimeout is used. |
kxi-info-srv.http.readTimeout |
int |
10 |
Maximum duration in seconds for reading the entire request, including the body. A zero or negative value means there will be no timeout. |
kxi-info-srv.http.writeTimeout |
int |
10 |
Maximum duration in seconds before timing out writes of the response. |
kxi-info-srv.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-info-srv.image.component |
string |
"kxi-info-srv" |
Image component. |
kxi-info-srv.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-info-srv.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-info-srv.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
kxi-info-srv.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-info-srv.infoService |
object |
{} |
Configure client Info endpoint details. |
kxi-info-srv.keycloak |
object |
{} |
Configure Keycloak realm and users within this chart. |
kxi-info-srv.keycloak.auth.existingSecret |
string |
"" |
The name of existing Kubernetes Secret containing the Keycloak password. |
kxi-info-srv.keycloak.enabled |
bool |
true |
Keycloak is deployed and integrated with this release. |
kxi-info-srv.keycloak.username |
string |
"user" |
Username used to authenticate and interact with Keycloak. |
kxi-info-srv.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-info-srv.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-info-srv.livenessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-info-srv.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
kxi-info-srv.livenessProbe.path |
string |
"/v1/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-info-srv.livenessProbe.periodSeconds |
int |
60 |
How often (in seconds) to perform the probe. |
kxi-info-srv.livenessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-info-srv.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-info-srv.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-info-srv.livenessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-info-srv.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-info-srv.metrics.enabled |
bool |
false |
Enable metric generation. |
kxi-info-srv.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-info-srv.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
kxi-info-srv.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
kxi-info-srv.metrics.serviceMonitor.interval |
string |
"30s" |
Frequency which Prometheus should attempt to scrape metrics from target service. Refer to GoDuration. |
kxi-info-srv.metrics.useAnnotations |
bool |
false |
Append Prometheus.io annotations to resource pods to allow metrics to be scraped without ServiceMonitor resources. |
kxi-info-srv.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-info-srv.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-info-srv.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-info-srv.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-info-srv.port |
int |
8080 |
Port number to assign to the exposed container port. |
kxi-info-srv.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-info-srv.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-info-srv.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-info-srv.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-info-srv.readinessProbe.enabled |
bool |
false |
Enable probe. |
kxi-info-srv.readinessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-info-srv.readinessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-info-srv.readinessProbe.path |
string |
"/v1/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-info-srv.readinessProbe.periodSeconds |
int |
60 |
How often (in seconds) to perform the probe. |
kxi-info-srv.readinessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-info-srv.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-info-srv.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-info-srv.readinessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-info-srv.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-info-srv.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-info-srv.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-info-srv.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-info-srv.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-info-srv.service.name |
string |
"http" |
Set exposed Service Port name. Refer to Service Ports. |
kxi-info-srv.service.port |
int |
80 |
Set exposed Service Port. Refer to Service Ports. |
kxi-info-srv.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-info-srv.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-info-srv.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-info-srv.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-info-srv.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-info-srv.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-info-srv.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-info-srv.startupProbe.enabled |
bool |
false |
Enable probe. |
kxi-info-srv.startupProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-info-srv.startupProbe.path |
string |
"/v1/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-info-srv.startupProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-info-srv.startupProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-info-srv.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-info-srv.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-info-srv.updateStrategy |
object |
{} |
Configuration for Deployment updates."Recreate" will delete all Deployment Pods."RollingUpdate" orchestrates a controlled update.Refer to UpgradeStrategy. |
kxi-info-srv.updateStrategy.type |
string |
"RollingUpdate" |
Update type. Permitted values - "RollingUpdate", "Recreate". |
kxi-info-srv.zap |
object |
{} |
Configure the zap logging library. |
kxi-info-srv.zap.logFormat |
string |
"json" |
Define the output structure for the logs. |
kxi-info-srv.zap.logLevel |
string |
"info" |
The minimum log severity level to output. |
kxi-info-srv.zap.stacktraceLevel |
string |
"panic" |
The log level at which stack traces are captured and attached. |
kxi-info-srv.zap.timeEncoding |
string |
"iso8601" |
The formatting for the log timestamps. |
kxi-monitoring¶
The kxi-monitoring Subchart is used to deploy and manage the monitoring stack. It installs and configures observability components such as Prometheus for metrics, Grafana for dashboards and visualization, and Loki plus Fluent Bit for logs.
Configuration for the kxi-monitoring Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-monitoring.enabled |
bool |
true |
If enabled the kxi-monitoring chart will be deployed as part of the insights release. |
kxi-monitoring.grafana |
object |
{} |
Configure deployment of Grafana dashboards. Dashboards are deployed as Kubernetes ConfigMaps and imported by Grafana. |
kxi-monitoring.grafana.annotations |
object |
{} |
Custom annotations to be applied to Dashboard ConfigMap. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-monitoring.grafana.dashboardDir |
string |
"/tmp/dashboards/<.Release.Namespace>" |
Define the target directory to mount config maps. |
kxi-monitoring.grafana.dashboards |
bool |
true |
Enable the install and configuration of Prometheus, Grafana and pre-defined dashboards and alerts. |
kxi-monitoring.grafana.labels |
object |
{ |
Custom labels to be applied to Dashboard ConfigMap. Dictionary of key-value pairs. Refer to Object Labels. |
kxi-monitoring.grafana.namespace |
string |
"<.Release.Namespace>" |
Set the namespace to deploy the dashboards config maps to. |
kxi-monitoring.metrics |
object |
{} |
Configure deployment of Prometheus Rules. |
kxi-monitoring.metrics.alerts |
bool |
true |
When true deploy Prometheus Rules. |
kxi-monitoring.metrics.enabled |
bool |
true |
Metrics are enabled within target namespace. |
kxi-obs-srv¶
The Observability Service is used for collecting and exposing logs, metrics, alerts, and related health information.
Configuration for the kxi-obs-srv Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-obs-srv.affinity |
object |
{} |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-obs-srv.auditLog |
object |
{} |
Enable and configure audit logging. |
kxi-obs-srv.auditLog.enabled |
bool |
true |
Enable audit logging. |
kxi-obs-srv.auditLog.logLevel |
string |
"INFO" |
Set verbosity level for the audit logs. E.g "INFO", "DEBUG", "ERROR". |
kxi-obs-srv.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
kxi-obs-srv.autoscaling.enabled |
bool |
true |
Enable use of HPA within deployment. |
kxi-obs-srv.autoscaling.maxReplicas |
int |
5 |
Maximum permitted replicas to be running. |
kxi-obs-srv.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
kxi-obs-srv.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
kxi-obs-srv.autoscaling.scaleDownPolicy[0] |
object |
{ |
Scale down by 50% replicaCount every 30 seconds |
kxi-obs-srv.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
kxi-obs-srv.autoscaling.scaleUpPolicy[0] |
object |
{ |
Scale up by 1 Pod every 120 seconds |
kxi-obs-srv.autoscaling.stabilizationWindowSeconds |
int |
60 |
Stabilization window is used to restrict the flapping of replica count when the metrics used for scaling keep fluctuating. |
kxi-obs-srv.autoscaling.targetCPUUtilizationPercentage |
int |
100 |
Threshold to trigger a scale in replica based on average CPU utilization. |
kxi-obs-srv.autoscaling.type |
string |
"ContainerResource" |
Kubernetes metric type to use. Permitted values - "Resource" or "ContainerResource". |
kxi-obs-srv.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
kxi-obs-srv.enabled |
bool |
true |
Enable kxi-obs-srv deployment. |
kxi-obs-srv.encryption |
object |
{} |
Configure Encryption. |
kxi-obs-srv.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-obs-srv.events |
object |
{} |
Configuration for the exposed events endpoint API. |
kxi-obs-srv.events.enabled |
bool |
true |
Enable or disable the events endpoint. |
kxi-obs-srv.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-obs-srv.health |
object |
{} |
Configuration for the exposed health endpoint API. |
kxi-obs-srv.health.configMapLabels |
list |
[ |
List of labels used to identify the Health ConfigMap generated from pod resources. |
kxi-obs-srv.health.enabled |
bool |
true |
Enable or disable the health endpoint. |
kxi-obs-srv.http |
object |
{ |
Configuration for the http REST Service. |
kxi-obs-srv.http.idleTimeout |
string |
"74" |
Maximum duration in seconds to wait for the next request. |
kxi-obs-srv.http.readTimeout |
int |
10 |
Maximum duration in seconds for reading the entire request, including the body. A zero or negative value means there will be no timeout. |
kxi-obs-srv.http.writeTimeout |
int |
10 |
Maximum duration in seconds before timing out writes of the response. |
kxi-obs-srv.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-obs-srv.image.component |
string |
"kxi-obs-srv" |
Image component. |
kxi-obs-srv.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-obs-srv.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-obs-srv.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
kxi-obs-srv.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-obs-srv.keycloak |
object |
{} |
Configure Keycloak realm and users within this chart. |
kxi-obs-srv.keycloak.auth.existingSecret |
string |
"" |
The name of existing Kubernetes Secret containing the Keycloak password. |
kxi-obs-srv.keycloak.enabled |
bool |
true |
Keycloak is deployed and integrated with this release. |
kxi-obs-srv.keycloak.username |
string |
"user" |
Username used to authenticate and interact with Keycloak. |
kxi-obs-srv.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-obs-srv.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-obs-srv.livenessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-obs-srv.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
kxi-obs-srv.livenessProbe.path |
string |
"/v1/alive" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-obs-srv.livenessProbe.periodSeconds |
int |
60 |
How often (in seconds) to perform the probe. |
kxi-obs-srv.livenessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-obs-srv.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-obs-srv.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-obs-srv.livenessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-obs-srv.logging |
object |
{} |
Configuration for the exposed logging endpoint API. Sets default query parameters. |
kxi-obs-srv.logging.containerIgnore |
list |
[] |
List of specific container names to explicitly ignore and filter from log output. |
kxi-obs-srv.logging.containerIgnoreRegex |
string |
"" |
Regular expression string used to filter out matching container names from log output. |
kxi-obs-srv.logging.enabled |
bool |
true |
Enable or disable the logging endpoint. |
kxi-obs-srv.logging.logLevel |
string |
"ERROR" |
Filters any logs with a severity level less than specified values. |
kxi-obs-srv.logging.sinceSeconds |
int |
1800 |
Return logs newer than a relative duration in seconds before current time. |
kxi-obs-srv.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-obs-srv.metrics.enabled |
bool |
false |
Enable metric generation. |
kxi-obs-srv.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-obs-srv.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
kxi-obs-srv.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
kxi-obs-srv.metrics.serviceMonitor.interval |
string |
"30s" |
Frequency which Prometheus should attempt to scrape metrics from target service. Refer to GoDuration. |
kxi-obs-srv.metrics.useAnnotations |
bool |
false |
Append Prometheus.io annotations to resource pods to allow metrics to be scraped without ServiceMonitor resources. |
kxi-obs-srv.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-obs-srv.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-obs-srv.observe |
object |
{} |
Configuration for limiting the observed target pods. |
kxi-obs-srv.observe.container |
string |
"" |
Limit observation to specific container name. |
kxi-obs-srv.observe.pod |
string |
"" |
Limit observation to specific pod name. |
kxi-obs-srv.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-obs-srv.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-obs-srv.port |
int |
8080 |
Port number to assign to the exposed container port. |
kxi-obs-srv.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-obs-srv.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-obs-srv.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-obs-srv.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-obs-srv.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-obs-srv.readinessProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-obs-srv.readinessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-obs-srv.readinessProbe.path |
string |
"/v1/ready" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-obs-srv.readinessProbe.periodSeconds |
int |
60 |
How often (in seconds) to perform the probe. |
kxi-obs-srv.readinessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-obs-srv.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-obs-srv.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-obs-srv.readinessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-obs-srv.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-obs-srv.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-obs-srv.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-obs-srv.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-obs-srv.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-obs-srv.service.name |
string |
"http" |
Set exposed Service Port name. Refer to Service Ports. |
kxi-obs-srv.service.port |
int |
80 |
Set exposed Service Port. Refer to Service Ports. |
kxi-obs-srv.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-obs-srv.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-obs-srv.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-obs-srv.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-obs-srv.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-obs-srv.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-obs-srv.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-obs-srv.startupProbe.enabled |
bool |
true |
Enable probe. |
kxi-obs-srv.startupProbe.failureThreshold |
int |
3 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-obs-srv.startupProbe.path |
string |
"/v1/alive" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-obs-srv.startupProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-obs-srv.startupProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-obs-srv.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-obs-srv.status |
object |
{} |
Configuration for the exposed status endpoint API. Sets default query parameters. |
kxi-obs-srv.status.cacheEnabled |
bool |
true |
Enable or disable the internal cache of pod status. Allows for faster API response. |
kxi-obs-srv.status.cacheRefreshSecond |
int |
30 |
Interval in seconds between each internal cache refresh. |
kxi-obs-srv.status.containerIgnore |
list |
[] |
List of specific container names to explicitly ignore and filter from status output. |
kxi-obs-srv.status.containerIgnoreRegex |
string |
"^[a-zA-Z0-9-]*sidecar$" |
Regular expression string used to filter out matching container names from status output. |
kxi-obs-srv.status.enabled |
bool |
true |
Enable or disable the status endpoint. |
kxi-obs-srv.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-obs-srv.updateStrategy |
object |
{} |
Configuration for Deployment updates."Recreate" will delete all Deployment Pods."RollingUpdate" orchestrates a controlled update.Refer to UpgradeStrategy. |
kxi-obs-srv.updateStrategy.type |
string |
"RollingUpdate" |
Update type. Permitted values - "RollingUpdate", "Recreate". |
kxi-obs-srv.zap |
object |
{} |
Configure the zap logging library. |
kxi-obs-srv.zap.logFormat |
string |
"json" |
Define the output structure for the logs. |
kxi-obs-srv.zap.logLevel |
string |
"info" |
The minimum log severity level to output. |
kxi-obs-srv.zap.stacktraceLevel |
string |
"panic" |
The log level at which stack traces are captured and attached. |
kxi-obs-srv.zap.timeEncoding |
string |
"iso8601" |
The formatting for the log timestamps. |
kxi-package-manager¶
Configuration for the kxi-package-manager Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-package-manager.affinity |
object |
{} |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-package-manager.auth |
object |
{} |
Authentication configuration. |
kxi-package-manager.auth.enabled |
bool |
true |
Enable authentication. |
kxi-package-manager.autoscaling.enabled |
bool |
false |
Enable use of HPA within application. |
kxi-package-manager.autoscaling.maxReplicas |
int |
10 |
Maximum permitted replicas to be running. |
kxi-package-manager.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
kxi-package-manager.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
kxi-package-manager.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
kxi-package-manager.autoscaling.targetCPUUtilizationPercentage |
int |
80 |
Threshold to trigger a scale in replica based on average CPU utilization. |
kxi-package-manager.deploymentAnnotations |
object |
{} |
Custom annotations to be applied to the Deployment resource. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-package-manager.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
kxi-package-manager.encryption |
object |
{} |
Configure Encryption. |
kxi-package-manager.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-package-manager.env |
object |
{} |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
kxi-package-manager.externalDatabase |
object |
{} |
Configure PostgreSQL database. |
kxi-package-manager.externalDatabase.createDatabase |
bool |
true |
Enable job to create initial database within external postgres. |
kxi-package-manager.externalDatabase.database |
string |
"<.Release.Namespace>-kxi-package-manager" |
Name for a custom database. |
kxi-package-manager.externalDatabase.existingSecret |
string |
"" |
Name of the existing kubernetes secret contain Postgres authentication details. |
kxi-package-manager.externalDatabase.existingSecretPasswordKey |
string |
"" |
Field within secret containing password. |
kxi-package-manager.externalDatabase.existingSecretUserKey |
string |
"" |
Field within secret containing Username. |
kxi-package-manager.externalDatabase.host |
string |
"" |
Target Postgres Database. |
kxi-package-manager.externalDatabase.username |
string |
"" |
Configure the Postgres database username. |
kxi-package-manager.feature_flags |
object |
{ |
Feature flags configuration. |
kxi-package-manager.feature_flags.disable_uuid |
bool |
false |
Disable UUID generation. |
kxi-package-manager.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-package-manager.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-package-manager.image.component |
string |
"kxi-package-manager" |
Image component. |
kxi-package-manager.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-package-manager.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-package-manager.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
kxi-package-manager.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within the chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-package-manager.keycloak |
object |
{} |
Configure Keycloak Authz |
kxi-package-manager.keycloak.clientEnabled |
bool |
true |
Enable Keycloak client |
kxi-package-manager.keycloak.clientId |
string |
"kxi-package-manager" |
Keycloak Client ID |
kxi-package-manager.keycloak.clientSecret |
string |
"kxi-package-manager-client-secret" |
Keycloak Client Secret |
kxi-package-manager.keycloakRealmInit |
object |
{} |
Configure the Keycloak Realm init job. Used to check for the successful import of keycloak realm. |
kxi-package-manager.keycloakRealmInit.image |
object |
{} |
Configure the Keycloak realm check job image details. Refer to Images. |
kxi-package-manager.keycloakRealmInit.image.component |
string |
"curl-jq" |
Image component. |
kxi-package-manager.keycloakRealmInit.image.tag |
string |
"2.1.0" |
Image tag. |
kxi-package-manager.keycloakRealmInit.jobName |
string |
"" |
Keycloak config CLI job to lookup. Job is checked for successful import Keycloak realm. |
kxi-package-manager.license |
object |
{} |
Configure the KX License to be used by kdb applications. |
kxi-package-manager.license.asFile |
bool |
true |
Mount License secret as file to the container. If false will be set a ENV Var within container. |
kxi-package-manager.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-package-manager.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-package-manager.livenessProbe.failureThreshold |
int |
8 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Needs to be unresponsive for 120 secs |
kxi-package-manager.livenessProbe.path |
string |
"/healthz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-package-manager.livenessProbe.periodSeconds |
int |
30 |
How often (in seconds) to perform the probe. |
kxi-package-manager.livenessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-package-manager.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-package-manager.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-package-manager.livenessProbe.timeoutSeconds |
int |
5 |
Number of seconds after which the probe times out. |
kxi-package-manager.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-package-manager.metrics.enabled |
bool |
true |
Enable metric generation. |
kxi-package-manager.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-package-manager.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
kxi-package-manager.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
kxi-package-manager.metrics.serviceMonitor.path |
string |
"/metrics" |
Service endpoint of targeted component to scrape metrics from. |
kxi-package-manager.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-package-manager.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-package-manager.packages |
object |
{} |
Configure Packaging within chart. |
kxi-package-manager.packages.artifacts |
string |
"packaging/artifacts" |
Path for artifacts. |
kxi-package-manager.packages.deployments |
string |
"packaging/deployments" |
Path for deployments. |
kxi-package-manager.packages.enabled |
bool |
true |
Enabled Packaging. |
kxi-package-manager.packages.migrations |
object |
{ |
Migration configuration. |
kxi-package-manager.packages.migrations.enabled |
bool |
true |
Enable migrations. |
kxi-package-manager.packages.mount |
string |
"/opt/kx/shared" |
Mount location for Packages volume. |
kxi-package-manager.packages.path |
string |
"packaging/packages" |
Sub path within Packages mount where packages will be located. |
kxi-package-manager.packages.storage |
string |
"postgres" |
Package storage location |
kxi-package-manager.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-package-manager.podDisruptionBudget |
object |
{} |
Provisions a Pod Disruption Budget (PDB) to restrict pod evictions. NOTE that only one of minAvailable and maxUnavailable may be set.Refer to Configure PDB. |
kxi-package-manager.podDisruptionBudget.enabled |
bool |
false |
Enable Pod Disruption Budget (PDB) for the application. |
kxi-package-manager.podDisruptionBudget.minAvailable |
int |
1 |
Minimum replicas required by this workload, expressed as an integer or percentage. |
kxi-package-manager.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-package-manager.port |
int |
8080 |
Port number to assign to the exposed container port. |
kxi-package-manager.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-package-manager.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-package-manager.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-package-manager.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-package-manager.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-package-manager.readinessProbe.failureThreshold |
int |
8 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-package-manager.readinessProbe.path |
string |
"/healthz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-package-manager.readinessProbe.periodSeconds |
int |
30 |
How often (in seconds) to perform the probe. |
kxi-package-manager.readinessProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-package-manager.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-package-manager.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-package-manager.readinessProbe.timeoutSeconds |
int |
5 |
Number of seconds after which the probe times out. |
kxi-package-manager.replicaCount |
int |
3 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-package-manager.resources |
object |
{} |
Container resource requests and limits. Refer to Container Resources. |
kxi-package-manager.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-package-manager.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-package-manager.service.port |
int |
8080 |
Set exposed Service Port. Refer to Service Ports. |
kxi-package-manager.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-package-manager.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-package-manager.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-package-manager.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-package-manager.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-package-manager.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-package-manager.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-package-manager.startupProbe.enabled |
bool |
true |
Enable probe. |
kxi-package-manager.startupProbe.failureThreshold |
int |
45 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-package-manager.startupProbe.initialDelaySeconds |
int |
5 |
Number of seconds after the container has started before startup probes are initiated. |
kxi-package-manager.startupProbe.path |
string |
"/startupz" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-package-manager.startupProbe.periodSeconds |
int |
5 |
How often (in seconds) to perform the probe. |
kxi-package-manager.startupProbe.port |
int |
8080 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-package-manager.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-package-manager.startupProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-package-manager.startupProbe.timeoutSeconds |
int |
5 |
Number of seconds after which the probe times out. |
kxi-package-manager.tmpVolume |
object |
{} |
Configure the mounted emptyDir tmp volume. |
kxi-package-manager.tmpVolume.sizeLimit |
string |
"100Mi" |
Container tmp emptyDir size limit. |
kxi-package-manager.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-package-manager.updateStrategy |
object |
{} |
Configuration for Deployment updates."Recreate" will delete all Deployment Pods."RollingUpdate" orchestrates a controlled update.Refer to UpgradeStrategy. |
kxi-package-manager.updateStrategy.type |
string |
"Recreate" |
Update type. Permitted values - "RollingUpdate", "Recreate". |
kxi-scratchpad-manager¶
Configuration for the kxi-scratchpad-manager Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-scratchpad-manager.affinity |
string |
"hard" |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-scratchpad-manager.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
kxi-scratchpad-manager.autoscaling.enabled |
bool |
false |
Enable use of HPA within deployment. |
kxi-scratchpad-manager.autoscaling.maxReplicas |
int |
1 |
Maximum permitted replicas to be running. |
kxi-scratchpad-manager.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
kxi-scratchpad-manager.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
kxi-scratchpad-manager.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
kxi-scratchpad-manager.autoscaling.targetCPUUtilizationPercentage |
int |
80 |
Threshold to trigger a scale in replica based on average CPU utilization. |
kxi-scratchpad-manager.cleanup |
object |
{} |
This setting controls whether a pre-delete helm hook for cleaning up Scratchpad instances is triggered upon helm uninstall. Although functional, it is disabled by default because at the moment there are (unlikely) scenarios where a pre-delete hook can fail and the whole uninstall command will time out. The pre-delete hook and this setting are to be removed, once scratchpad pods can delete themselves due to inactivity. |
kxi-scratchpad-manager.cleanup.annotations |
object |
{} |
Additional annotations for the cleanup job. |
kxi-scratchpad-manager.cleanup.backoffLimit |
int |
0 |
Number of retries for the cleanup job if it fails. |
kxi-scratchpad-manager.cleanup.enabled |
bool |
true |
Whether cleanup happens upon uninstall. |
kxi-scratchpad-manager.cleanup.ttlSecondsAfterFinished |
int |
300 |
How long the job hangs in the cluster as completed after finishing. |
kxi-scratchpad-manager.configAnnotations |
object |
{} |
Custom annotations to be applied to ConfigMap resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.configdir |
string |
"/etc/appconfig" |
Mount location for ConfigMap resource. |
kxi-scratchpad-manager.e2e |
object |
{ |
Values for manager end to end tests |
kxi-scratchpad-manager.enableServiceLinks |
bool |
false |
Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. |
kxi-scratchpad-manager.encryption |
object |
{} |
Configure Encryption. |
kxi-scratchpad-manager.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-scratchpad-manager.entitlements |
object |
{} |
Configure the use of Entitlements within chart. |
kxi-scratchpad-manager.env |
list |
[] |
List of default environment variables to inject into containers. |
kxi-scratchpad-manager.externalDatabase |
object |
{} |
Configuration for external database. Only used when postgresql.enabled is set to false |
kxi-scratchpad-manager.externalDatabase.connectionPoolLifetime |
int |
86400 |
Lifetime of a connection pool that the Scratchpad Manager creates when connecting to postgres |
kxi-scratchpad-manager.externalDatabase.createDatabase |
bool |
true |
Application should attempt to create database during initialization. |
kxi-scratchpad-manager.externalDatabase.database |
string |
"<.Release.Name>-kxi-scratchpad-manager" |
Name of external database to connect to. |
kxi-scratchpad-manager.externalDatabase.existingSecret |
string |
"" |
Name of an existing Kubernetes Secret containing the database credentials. |
kxi-scratchpad-manager.externalDatabase.existingSecretPasswordKey |
string |
"" |
Key within existingSecret that containers database password. |
kxi-scratchpad-manager.externalDatabase.existingSecretUserKey |
string |
"" |
Key within existingSecret that containers database username. |
kxi-scratchpad-manager.externalDatabase.host |
string |
"" |
Hostname of external database server. |
kxi-scratchpad-manager.externalDatabase.password |
string |
"" |
Password to authenticate with the external database. |
kxi-scratchpad-manager.externalDatabase.port |
int |
5432 |
Port number of external database server. |
kxi-scratchpad-manager.externalDatabase.username |
string |
"" |
Username to authenticate with the external database. |
kxi-scratchpad-manager.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-scratchpad-manager.http |
object |
{} |
HTTP server configuration. |
kxi-scratchpad-manager.http.idleTimeout |
int |
0 |
Maximum duration in seconds to wait for the next request when keep-alives are enabled. If zero, the value of readTimeout is used. |
kxi-scratchpad-manager.http.readTimeout |
int |
0 |
Maximum duration in seconds for reading the entire request, including the body. A zero or negative value means there will be no timeout. |
kxi-scratchpad-manager.http.writeTimeout |
int |
0 |
Maximum duration in seconds before timing out writes of the response. |
kxi-scratchpad-manager.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-scratchpad-manager.image.component |
string |
"kxi-scratchpad-manager" |
Image component. |
kxi-scratchpad-manager.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-scratchpad-manager.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-scratchpad-manager.image.tag |
string |
".Chart.AppVersion" |
Image tag. |
kxi-scratchpad-manager.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-scratchpad-manager.initDBJob |
object |
{} |
Configuration for the initContainer used to create initial DB. |
kxi-scratchpad-manager.initDBJob.image |
object |
{} |
Configure the Postgres image details. Refer to Images. |
kxi-scratchpad-manager.initDBJob.image.component |
string |
"postgresql" |
Image component. |
kxi-scratchpad-manager.initDBJob.image.repository |
string |
"docker.io/bitnamilegacy" |
Image repository. |
kxi-scratchpad-manager.initDBJob.image.tag |
string |
"15.0.0-debian-11-r1" |
Image tag. |
kxi-scratchpad-manager.initDBJob.image.useLocal |
bool |
true |
When enabled, global configuration is ignored and local configuration is used. |
kxi-scratchpad-manager.initDBJob.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-scratchpad-manager.k8ApiCheck |
object |
{} |
This setting configures the init container on scratchpad-manager deployment. The container is meant to validate that kubernetes API server is available before starting the manager app, since in some environments it isn't available right away. |
kxi-scratchpad-manager.k8ApiCheck.enabled |
bool |
true |
Flag for enabling / disabling the check |
kxi-scratchpad-manager.k8ApiCheck.failureThreshold |
int |
60 |
Numbers of retries for the Kubernetes API server check |
kxi-scratchpad-manager.k8ApiCheck.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-scratchpad-manager.keycloak |
object |
{} |
Configure Keycloak realm within the release. |
kxi-scratchpad-manager.keycloak.configSecret |
string |
"keycloak-realm" |
Kubernetes Secret containing realm configuration. |
kxi-scratchpad-manager.keycloak.realm |
string |
"realm" |
Keycloak realm created and imported for this release. |
kxi-scratchpad-manager.kxi-scratchpad |
object |
{} |
Configuration for the kxi-scratchpad instances. |
kxi-scratchpad-manager.kxi-scratchpad.ignoreQhome |
int |
1 |
A flag regulating the Scratchpad internal behavior, passed as an environment variable |
kxi-scratchpad-manager.kxi-scratchpad.image |
object |
{} |
Configure Scratchpad instance Image details. Refer to Images. |
kxi-scratchpad-manager.kxi-scratchpad.image.component |
string |
"kxi-scratchpad" |
What the scratchpad image is called in the repository |
kxi-scratchpad-manager.kxi-scratchpad.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-scratchpad-manager.kxi-scratchpad.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-scratchpad-manager.kxi-scratchpad.image.tag |
string |
"1.19.0" |
Image tag. |
kxi-scratchpad-manager.kxi-scratchpad.kurlTimeoutSeconds |
int |
55 |
Default timeout for kurl calls performed by the Scratchpad |
kxi-scratchpad-manager.kxi-scratchpad.liveLogging |
object |
{} |
A setting regulating the Scratchpad internal behavior, passed as an environment variable |
kxi-scratchpad-manager.kxi-scratchpad.liveLogging.enabled |
bool |
true |
If set to true the value of the corresponding environment variable is set to true on the Scratchpad. LiveLogging controls whether scratchpad I/O from Q debug statements are duplicated into the Scratchpad manager /scratchpad/events endpoint. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe |
object |
{} |
Configure Liveness Probe for Scratchpad Instance. Refer to Configure Probes. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.failureThreshold |
int |
15 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.periodSeconds |
int |
5 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.port |
int |
12126 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-scratchpad-manager.kxi-scratchpad.livenessProbe.timeoutSeconds |
int |
2 |
Number of seconds after which the probe times out. |
kxi-scratchpad-manager.kxi-scratchpad.name |
string |
"kxi-scratchpad" |
Name of scratchpad instances used in pod annotations |
kxi-scratchpad-manager.kxi-scratchpad.port |
int |
12125 |
Port number on the pod where the main Scratchpad process is exposed |
kxi-scratchpad-manager.kxi-scratchpad.priorityClass |
object |
{} |
Configure the Pod Priority Classes for Scratch pad instances. |
kxi-scratchpad-manager.kxi-scratchpad.priorityClass.description |
string |
"This priority class is used to determine the priority of scratchpad instances created by scratchpad manager" |
Brief description for Priority Class. |
kxi-scratchpad-manager.kxi-scratchpad.priorityClass.enabled |
bool |
true |
Enable the use of Priority Classes. |
kxi-scratchpad-manager.kxi-scratchpad.priorityClass.name |
string |
"scratchpad-priority-v2" |
Name of Priority Class to apply. |
kxi-scratchpad-manager.kxi-scratchpad.priorityClass.value |
int |
0 |
Integer value to be assigned to Priority Class. Value less than 1000000000. |
kxi-scratchpad-manager.kxi-scratchpad.quickStartup |
object |
{} |
Configures scratchpad pre-provisioning. |
kxi-scratchpad-manager.kxi-scratchpad.quickStartup.enabled |
bool |
true |
When enabled, scratchpad-manager will initialize a pool of scratchpads that will be ready for quick assignment to the user. |
kxi-scratchpad-manager.kxi-scratchpad.quickStartup.provisionPool |
int |
1 |
The number of pre-initialized scratchpads |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe |
object |
{} |
Configure Readiness Probe for Scratchpad Instance. Refer to Configure Probes. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.failureThreshold |
int |
10 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.initialDelaySeconds |
int |
5 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.port |
int |
12126 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-scratchpad-manager.kxi-scratchpad.readinessProbe.timeoutSeconds |
int |
2 |
Number of seconds after which the probe times out. |
kxi-scratchpad-manager.kxi-scratchpad.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-scratchpad-manager.kxi-scratchpad.serviceAccount |
object |
{} |
Configure ServiceAccount to be used by Scratchpad Instance. Refer to Service Accounts. |
kxi-scratchpad-manager.kxi-scratchpad.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.kxi-scratchpad.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-scratchpad-manager.kxi-scratchpad.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-scratchpad-manager.kxi-scratchpad.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-scratchpad-manager.kxi-scratchpad.sidecarPodPort |
int |
12126 |
Port number where scratchpad pod exposes sibling process |
kxi-scratchpad-manager.kxi-scratchpad.spInteractive |
int |
1 |
A flag regulating the Scratchpad internal behavior, passed as an environment variable |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe |
object |
{} |
Configure Startup Probe for Scratchpad Instance. Refer to Configure Probes. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.enabled |
bool |
true |
Enable probe. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.failureThreshold |
int |
10 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.port |
int |
12126 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.kxi-scratchpad.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.kxi-scratchpad.timeoutSeconds |
int |
60 |
Default timeout for executing commands on the Scratchpad |
kxi-scratchpad-manager.kxi-scratchpad.tmpVolume |
object |
{} |
Configure the mounted emptyDir tmp volume. |
kxi-scratchpad-manager.kxi-scratchpad.tmpVolume.medium |
string |
"" |
Container tmp emptyDir medium.Permitted values - "", "disk" or "memory". |
kxi-scratchpad-manager.kxi-scratchpad.tmpVolume.sizeLimit |
string |
"250Mi" |
Container tmp emptyDir size limit. |
kxi-scratchpad-manager.license |
object |
{} |
Configure the KX License to be used within this chart. |
kxi-scratchpad-manager.license.asFile |
bool |
true |
Mount License secret as file to the container. If false will be set a ENV Var within container. |
kxi-scratchpad-manager.license.secretName |
string |
"license" |
Name of existing Kubernetes secret containing encoded license. |
kxi-scratchpad-manager.license.type |
string |
"k4" |
Supersedes the onDemand field, user can set type of license contained within their existing license secret.Permitted values - "kx", "kc" or "k4". |
kxi-scratchpad-manager.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-scratchpad-manager.livenessProbe.enabled |
bool |
true |
Enable probe. |
kxi-scratchpad-manager.livenessProbe.failureThreshold |
int |
5 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.livenessProbe.initialDelaySeconds |
int |
30 |
Number of seconds after the container has started before liveness probes are initiated. |
kxi-scratchpad-manager.livenessProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.livenessProbe.periodSeconds |
int |
10 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.livenessProbe.port |
int |
10100 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.livenessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.livenessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-scratchpad-manager.livenessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-scratchpad-manager.logLevel |
string |
"INFO" |
Set verbosity level for the audit logs. E.g "INFO", "DEBUG", "ERROR". |
kxi-scratchpad-manager.maxScratchpads |
int |
50 |
This setting sets the maximum number of scratchpads that the Scratchpad manager will be able to provision. |
kxi-scratchpad-manager.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-scratchpad-manager.metrics.enabled |
bool |
false |
Enable metric generation. |
kxi-scratchpad-manager.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-scratchpad-manager.metrics.serviceMonitor.enabled |
bool |
false |
Deploy ServiceMonitor resources. |
kxi-scratchpad-manager.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-scratchpad-manager.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-scratchpad-manager.packages |
object |
{} |
Configure Packaging within chart. |
kxi-scratchpad-manager.packages.enabled |
bool |
true |
Enabled Packaging. |
kxi-scratchpad-manager.packages.mount |
string |
"/opt/kx/packaging" |
Mount location for Packages volume. |
kxi-scratchpad-manager.packages.path |
string |
"packages" |
Sub path within Packages mount where packages will be located. |
kxi-scratchpad-manager.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-scratchpad-manager.port |
int |
10100 |
Port number to assign to the exposed container port. |
kxi-scratchpad-manager.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-scratchpad-manager.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-scratchpad-manager.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-scratchpad-manager.readinessProbe.enabled |
bool |
true |
Enable probe. |
kxi-scratchpad-manager.readinessProbe.failureThreshold |
int |
5 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.readinessProbe.initialDelaySeconds |
int |
10 |
Number of seconds after the container has started before readiness probes are initiated. |
kxi-scratchpad-manager.readinessProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.readinessProbe.periodSeconds |
int |
5 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.readinessProbe.port |
int |
10100 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.readinessProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.readinessProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-scratchpad-manager.readinessProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-scratchpad-manager.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-scratchpad-manager.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-scratchpad-manager.scratchpadMaxInactivityMins |
int |
60 |
Number of minutes after which the Scratchpad manager cleans up a scratchpad from the cluster due to inactivity. |
kxi-scratchpad-manager.scratchpadProxyBufferSize |
int |
20 |
Maximum number of requests that can be buffered for the Scratchpad while the Scratchpad is busy processing one. |
kxi-scratchpad-manager.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-scratchpad-manager.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-scratchpad-manager.service.port |
int |
80 |
Set exposed Service Port. Refer to Service Ports. |
kxi-scratchpad-manager.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-scratchpad-manager.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-scratchpad-manager.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-scratchpad-manager.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-scratchpad-manager.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-scratchpad-manager.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-scratchpad-manager.startupProbe.enabled |
bool |
false |
Enable probe. |
kxi-scratchpad-manager.startupProbe.failureThreshold |
int |
5 |
Minimum consecutive failures for the probe to be considered failed after having succeeded. |
kxi-scratchpad-manager.startupProbe.initialDelaySeconds |
int |
10 |
Number of seconds after the container has started before startup probes are initiated. |
kxi-scratchpad-manager.startupProbe.path |
string |
"/health" |
Where probeType is "httpGet", Path to access on the HTTP server. |
kxi-scratchpad-manager.startupProbe.periodSeconds |
int |
3 |
How often (in seconds) to perform the probe. |
kxi-scratchpad-manager.startupProbe.port |
int |
10100 |
Where probeType is either "httpGet" or "tcpSocket", Name or number of the port to access on the container. |
kxi-scratchpad-manager.startupProbe.probeType |
string |
"httpGet" |
Probe type. Permitted values - "httpGet", "tcpSocket" or "exec". |
kxi-scratchpad-manager.startupProbe.successThreshold |
int |
1 |
Minimum consecutive successes for the probe to be considered successful after having failed. |
kxi-scratchpad-manager.startupProbe.timeoutSeconds |
int |
3 |
Number of seconds after which the probe times out. |
kxi-scratchpad-manager.tests |
object |
{} |
Configuration for test hooks defined in helm charts. |
kxi-scratchpad-manager.tests.annotations |
object |
{} |
Custom annotations to be applied to test resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-scratchpad-manager.tmpVolume |
object |
{} |
Configure the mounted emptyDir tmp volume. |
kxi-scratchpad-manager.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-scratchpad-manager.updateStrategy |
object |
{} |
Configuration for Deployment updates."Recreate" will delete all Deployment Pods."RollingUpdate" orchestrates a controlled update.Refer to UpgradeStrategy. |
kxi-scratchpad-manager.updateStrategy.maxSurge |
int |
1 |
Where type: "RollingUpdate", Maximum amount of pods permitted to be created beyond the defined replicaCount May be expressed as an integer or percentage. |
kxi-scratchpad-manager.updateStrategy.maxUnavailable |
int |
1 |
Where type: "RollingUpdate", Maximum amount of pods permitted to be unavailable during upgrade.May be expressed as an integer or percentage. |
kxi-scratchpad-manager.updateStrategy.type |
string |
"RollingUpdate" |
Update type. Permitted values - "RollingUpdate", "Recreate". |
kxi-sp¶
The Stream Processor is used to build and run pipelines for ingesting, transforming, enriching, and analyzing streaming or batch data.
Configuration for the kxi-sp Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-sp.affinity |
string |
"hard" |
Pod Anti Affinity rules. Permits object defining podAntiAffinity in full or simple string.hard - Builds a requiredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.soft - Builds a preferredDuringSchedulingIgnoredDuringExecution Node level podAntiAffinity.hard-az - Builds a requiredDuringSchedulingIgnoredDuringExecution Zone level podAntiAffinity.soft-az - Builds a preferredDuringSchedulingIgnoredDuringExecution Zone and Node level podAntiAffinity.Refer to Pod Affinity. |
kxi-sp.auditLog |
object |
{} |
Enable and configure audit logging. |
kxi-sp.auditLog.enabled |
bool |
false |
Enable audit logging. |
kxi-sp.auth |
object |
{} |
Authentication configuration. |
kxi-sp.auth.enabled |
bool |
true |
Enable authentication. |
kxi-sp.autoscaling |
object |
{} |
Provisions a HorizontalPodAutoscaler (HPA) resource for the workload.Refer to Autoscaling. |
kxi-sp.autoscaling.enabled |
bool |
false |
Enable use of HPA within application. |
kxi-sp.autoscaling.maxReplicas |
int |
1 |
Maximum permitted replicas to be running. |
kxi-sp.autoscaling.minReplicas |
int |
1 |
Minimum permitted replicas to be running. |
kxi-sp.autoscaling.scaleDownPolicy |
list |
[] |
Policies to apply when scaling down the replica set. |
kxi-sp.autoscaling.scaleUpPolicy |
list |
[] |
Policies to apply when scaling up the replica set. |
kxi-sp.autoscaling.targetCPUUtilizationPercentage |
int |
80 |
Threshold to trigger a scale in replica based on average CPU utilization. |
kxi-sp.betaFeatures |
bool |
false |
Enables optional beta features in a preview mode. Beta features are not intended to be used in production and are subject to change. |
kxi-sp.ctlImage |
object |
{} |
Configure Pipeline Controller Image repository details. Refer to Images. |
kxi-sp.ctlImage.component |
string |
"kxi-sp-controller" |
Image component. |
kxi-sp.ctlImage.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-sp.ctlImage.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-sp.debug |
bool |
false |
Flag indicating whether tty and stdin are enabled across the SP cluster |
kxi-sp.defaultWorkerThreads |
int |
0 |
Default secondary threads for new pipeline submissions. |
kxi-sp.encryption |
object |
{} |
Configure Encryption. |
kxi-sp.encryption.enabled |
bool |
false |
Enable encryption within chart. |
kxi-sp.env |
object |
{} |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
kxi-sp.fullnameOverride |
string |
"" |
Override the default fully qualified app name. By default resources are named using <.Release.Name>-<.Chart.Name>.Used when generating resource names. |
kxi-sp.image |
object |
{} |
Configure Chart Image repository details. Refer to Images. |
kxi-sp.image.component |
string |
"kxi-sp-coordinator" |
Image component. |
kxi-sp.image.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-sp.image.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-sp.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within the chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
kxi-sp.instanceParam |
object |
{} |
Custom arguments to pass to container. Dictionary of key-value pairs. |
kxi-sp.license |
object |
{} |
Configure the KX License to be used by kdb applications. |
kxi-sp.license.asFile |
bool |
true |
Mount License secret as file to the container. If false will be set a ENV Var within container. |
kxi-sp.license.onDemand |
bool |
false |
Deprecated Indicates license secret contains a kc.lic. |
kxi-sp.license.type |
string |
"k4" |
Supersedes the onDemand field, user can set type of license contained within their existing license secret.Permitted values - "kx", "kc" or "k4". |
kxi-sp.livenessProbe |
object |
{} |
Configure Liveness Probe for chart. Refer to Configure Probes. |
kxi-sp.metrics |
object |
{} |
Configure the metrics collection for this application. |
kxi-sp.metrics.enabled |
bool |
true |
Enable metric generation. |
kxi-sp.metrics.frequency |
int |
5 |
Frequency in seconds sidecar should scrape metrics from main container. |
kxi-sp.metrics.handler |
object |
{} |
Enable metric capture for each of the .z.* kdb handlers, .e.g { pg: true }.Refer to dotz. |
kxi-sp.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
kxi-sp.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
kxi-sp.metrics.serviceMonitor.enabled |
bool |
false |
Deploy ServiceMonitor resources. |
kxi-sp.metrics.serviceMonitor.path |
string |
"/metrics" |
Service endpoint of targeted component to scrape metrics from. |
kxi-sp.mlImage |
object |
{} |
Configure Pipeline ML Image repository details. Refer to Images. |
kxi-sp.mlImage.component |
string |
"kxi-ml" |
Image component. |
kxi-sp.mlImage.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-sp.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
kxi-sp.nodeSelector |
object |
{} |
Node labels for pod assignment. This constrains the pods to run only on nodes that match the specified labels. Dictionary of key-value pairs. Refer to NodeSelector. |
kxi-sp.persistence.checkpointDir |
string |
"/sp/checkpoints" |
Set checkpoint Persistent Volume Claim mount location. |
kxi-sp.persistence.controllerCheckpointFreq |
int |
5000 |
Pipeline controller checkpoint frequency |
kxi-sp.persistence.enabled |
bool |
true |
Whether persistent volumes are enabled on pipelines. Note: checkpointing for recovery requires this be enabled |
kxi-sp.persistence.storage |
string |
"20Gi" |
Requests storage size for Persistent Volume Claim Storage allocated to each worker/controller |
kxi-sp.persistence.storageClassName |
string |
"" |
Pre-configured storage class name to be used for persistent volumes. If not specified will use the Kubernetes cluster's default storage class. |
kxi-sp.persistence.workerCheckpointFreq |
int |
5000 |
Pipeline worker checkpoint frequency |
kxi-sp.podAnnotations |
object |
{} |
Custom annotations to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-sp.podDisruptionBudget |
object |
{} |
Provisions a Pod Disruption Budget (PDB) to restrict pod evictions. NOTE that only one of minAvailable and maxUnavailable may be set.Refer to Configure PDB. |
kxi-sp.podDisruptionBudget.enabled |
bool |
false |
Enable Pod Disruption Budget (PDB) for the application. |
kxi-sp.podDisruptionBudget.minAvailable |
int |
1 |
Minimum replicas required by this workload, expressed as an integer or percentage. |
kxi-sp.podLabels |
object |
{} |
Custom labels to be applied to Pod resources. Dictionary of key-value pairs. Refer to Object Labels. |
kxi-sp.podSecurityContext |
object |
{} |
Pod Level Security Context - Configure the Pod Security Context. Refer to Pod Security Context. |
kxi-sp.port |
int |
5000 |
Port number to assign to the exposed container port. |
kxi-sp.pyImage |
object |
{} |
Configure Pipeline Python Image repository details. Refer to Images. |
kxi-sp.pyImage.component |
string |
"kxi-sp-python" |
Image component. |
kxi-sp.pyImage.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-sp.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
kxi-sp.rbac.annotations |
object |
{} |
Custom annotations to add to the Role resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-sp.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
kxi-sp.readinessProbe |
object |
{} |
Configure Readiness Probe for chart. Refer to Configure Probes. |
kxi-sp.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
kxi-sp.resourceAnnotations |
object |
{} |
Custom annotations to be applied to Workload resources. StatefulSet and Deployment resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-sp.resources |
object |
{ |
Container resource requests and limits. Refer to Container Resources. |
kxi-sp.securityContext |
object |
{} |
Container Level Security Context - Configure the Container Security Context. Refer to Security Context. |
kxi-sp.service |
object |
{} |
Provisions the Kubernetes Service required to expose the workloads. |
kxi-sp.service.port |
int |
5000 |
Set exposed Service Port. Refer to Service Ports. |
kxi-sp.service.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
kxi-sp.serviceAccount |
object |
{} |
Configure ServiceAccount to be used within chart.Refer to Service Accounts. |
kxi-sp.serviceAccount.annotations |
object |
{} |
Custom annotations to add to the Service Account. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-sp.serviceAccount.autoMount |
bool |
true |
Automatically mount a Service Account's API credentials. |
kxi-sp.serviceAccount.create |
bool |
true |
Specifies whether a Service Account should be created. |
kxi-sp.serviceAccount.name |
string |
"" |
The name of the Service Account to use. If not set and create is true, a name is generated using the fullname template. |
kxi-sp.sidecar |
object |
{} |
Configure the KXI Sidecar. |
kxi-sp.sidecar.image |
object |
{} |
Configure Sidecar Image details within the release. Refer to Images. |
kxi-sp.startupProbe |
object |
{} |
Configure Startup Probe for chart. Refer to Configure Probes. |
kxi-sp.tests |
object |
{} |
Configuration for test hooks defined in helm charts. |
kxi-sp.tests.annotations |
object |
{} |
Custom annotations to be applied to test resources. Dictionary of key-value pairs. Refer to Object Annotations. |
kxi-sp.tests.testSA |
bool |
false |
Test service account. |
kxi-sp.tmpVolume |
object |
{} |
Configure the mounted emptyDir tmp volume. |
kxi-sp.tolerations |
list |
[] |
Tolerations for pod assignment. This allows the pods to be scheduled on nodes with matching taints. Refer to Taint and Tolerations. |
kxi-sp.workImage |
object |
{} |
Configure Pipeline Worker Image repository details. Refer to Images. |
kxi-sp.workImage.component |
string |
"kxi-sp-worker" |
Image component. |
kxi-sp.workImage.pullPolicy |
string |
"IfNotPresent" |
Image pull policy. Refer to Image Pull Policy. |
kxi-sp.workImage.repository |
string |
"portal.dl.kx.com/" |
Image repository. |
kxi-theme¶
The keycloak theme is used to customize the look and feel of the Keycloak login pages.
Configuration for the kxi-theme Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
kxi-theme.loginTheme |
string |
"insights" |
Theme to select and deploy for Keycloak realm. |
qe-gateway¶
The Service Gateway for Query Environments (QEs) provides an isolated query path used for ad-hoc exploration and analysis so those workloads do not impact the main query path.
Configuration for the qe-gateway Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
qe-gateway.aggregator |
object |
{} |
Configuration for the the Aggregator subchart. |
qe-gateway.aggregator.additionalLabels |
object |
{ |
Custom labels to be applied to Aggregator resources. Dictionary of key-value pairs. Refer to Object Labels. |
qe-gateway.aggregator.coordinator.nameOverride |
string |
"qe-resource-coordinator" |
Override configured resource-coordinator name. Used when generating resource names. |
qe-gateway.aggregator.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
qe-gateway.aggregator.nameOverride |
string |
"qe-aggregator" |
Override Chart name. Used when generating resource names. |
qe-gateway.aggregator.packages |
object |
{} |
Configure Packaging within chart. |
qe-gateway.aggregator.packages.enabled |
bool |
true |
Enabled Packaging. |
qe-gateway.aggregator.replicaCount |
int |
3 |
This sets the replicaSet count.Refer to ReplicaSet. |
qe-gateway.entitlements |
object |
{} |
Configure the use of Entitlements within chart. |
qe-gateway.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within the chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
qe-gateway.metrics |
object |
{} |
Configure the metrics collection for this application. |
qe-gateway.metrics.enabled |
bool |
true |
Enable metric generation. |
qe-gateway.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
qe-gateway.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
qe-gateway.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
qe-gateway.metrics.serviceMonitor.path |
string |
"/metrics" |
Service endpoint of targeted component to scrape metrics from. |
qe-gateway.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
qe-gateway.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
qe-gateway.resource-coordinator |
object |
{} |
Configuration for the the Resource Coordinator subchart. |
qe-gateway.resource-coordinator.additionalLabels |
object |
{ |
Custom labels to be applied to Resource Coordinator resources. Dictionary of key-value pairs. Refer to Object Labels. |
qe-gateway.resource-coordinator.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
qe-gateway.resource-coordinator.nameOverride |
string |
"qe-resource-coordinator" |
Override Chart name. Used when generating resource names. |
qe-gateway.resource-coordinator.packages |
object |
{} |
Configure Packaging within chart. |
qe-gateway.resource-coordinator.packages.enabled |
bool |
true |
Enabled Packaging. |
qe-gateway.resource-coordinator.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
qe-gateway.resource-coordinator.sandBoxApis |
list |
[ |
Permitted API when Resource Coordinator is deployed without a QE instance |
qe-gateway.sg-gateway |
object |
{} |
Configuration for the the SG Gateway subchart. |
qe-gateway.sg-gateway.additionalLabels |
object |
{ |
Custom labels to be applied to SG Gateway resources. Dictionary of key-value pairs. Refer to Object Labels. |
qe-gateway.sg-gateway.auth.enabled |
bool |
true |
Enable authentication within subchart. |
qe-gateway.sg-gateway.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
qe-gateway.sg-gateway.externalService |
object |
{} |
Provisions the external Kubernetes Service required to expose the workloads externally. |
qe-gateway.sg-gateway.externalService.enabled |
bool |
false |
Enable or disable the External Service resource |
qe-gateway.sg-gateway.externalService.type |
string |
"ClusterIP" |
Sets the Service type. Refer to Service Types. |
qe-gateway.sg-gateway.metrics |
object |
{} |
Configure the metrics collection for this application. |
qe-gateway.sg-gateway.metrics.enabled |
bool |
true |
Enable metric generation. |
qe-gateway.sg-gateway.nameOverride |
string |
"qe-gateway" |
Override Chart name. Used when generating resource names. |
qe-gateway.sg-gateway.replicaCount |
int |
1 |
This sets the replicaSet count.Refer to ReplicaSet. |
qe-gateway.sg-gateway.ssl.enabled |
bool |
true |
Enable SSL within subchart service resources. |
service-gateway¶
The Service Gateway is the main query path for query requests into databases.
Configuration for the service-gateway Subchart.
| Key | Type | Default | Description |
|---|---|---|---|
service-gateway.aggregator |
object |
{} |
Configuration for the the Aggregator subchart. |
service-gateway.aggregator.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
service-gateway.aggregator.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
service-gateway.aggregator.packages |
object |
{} |
Configure Packaging within chart. |
service-gateway.aggregator.packages.enabled |
bool |
true |
Enabled Packaging. |
service-gateway.entitlements |
object |
{} |
Configure the use of Entitlements within chart. |
service-gateway.imagePullSecrets |
list |
[] |
Image pull secrets to be applied to all pods within the chart. For pulling an image from a private repository. Refer to Image Pull Secrets. |
service-gateway.metrics |
object |
{} |
Configure the metrics collection for this application. |
service-gateway.metrics.enabled |
bool |
true |
Enable metric generation. |
service-gateway.metrics.serviceMonitor |
object |
{} |
Configure the ServiceMonitor resource. Refer to ServiceMonitor. |
service-gateway.metrics.serviceMonitor.additionalLabels |
object |
{} |
Custom labels to be applied to ServiceMonitor resource. Dictionary of key-value pairs. May be required to allow Prometheus to identify ServiceMonitors. Refer to Object Labels. |
service-gateway.metrics.serviceMonitor.enabled |
bool |
true |
Deploy ServiceMonitor resources. |
service-gateway.metrics.serviceMonitor.path |
string |
"/metrics" |
Service endpoint of targeted component to scrape metrics from. |
service-gateway.rbac |
object |
{} |
Configure Role-Based Access Control (RBAC) for the application. |
service-gateway.rbac.create |
bool |
true |
Enable creation of Role-Based Access Control (RBAC) resources. |
service-gateway.resource-coordinator |
object |
{} |
Configuration for the the Resource Coordinator subchart. |
service-gateway.resource-coordinator.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
service-gateway.resource-coordinator.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
service-gateway.resource-coordinator.packages |
object |
{} |
Configure Packaging within chart. |
service-gateway.resource-coordinator.packages.enabled |
bool |
true |
Enabled Packaging. |
service-gateway.resource-coordinator.sandBoxApis |
list |
[ |
Permitted API when Resource Coordinator is deployed without a QE instance |
service-gateway.sg-gateway |
object |
{} |
Configuration for the the SG Gateway subchart. |
service-gateway.sg-gateway.auth.enabled |
bool |
true |
Enable authentication within subchart. |
service-gateway.sg-gateway.env |
object |
{ |
Map of default environment variables to inject into containers. E.g. { "STANDARD_ENV" : "value", "COMPLEX_ENV": { "valueFrom": { "fieldRef": { "fieldPath": "metadata.name" } } } }. |
service-gateway.sg-gateway.externalService |
object |
{} |
Provisions the external Kubernetes Service required to expose the workloads externally. |
service-gateway.sg-gateway.externalService.enabled |
bool |
true |
Enable the External Service resource. |
service-gateway.sg-gateway.metrics |
object |
{} |
Configure the metrics collection for this application. |
service-gateway.sg-gateway.metrics.enabled |
bool |
true |
Enable metric generation. |
service-gateway.sg-gateway.nameOverride |
string |
"" |
Override Chart name. Used when generating resource names. |
service-gateway.sg-gateway.ssl.enabled |
bool |
true |
Enable SSL within subchart service resources. |