Skip to main content

MarkLogic Server on Kubernetes

Helm Chart parameters

This table describes the list of available parameters for the Helm chart:

Name

Description

Default Value

As of Version

replicaCount

Number of MarkLogic nodes

1

1.0.0

updateStrategy.type

Update strategy for MarkLogic pods

OnDelete

1.1.0

terminationGracePeriod

The number of seconds until the MarkLogic Pod terminates gracefully

120

1.0.0

clusterDomain

Domain for the Kubernetes cluster

cluster.local

1.0.0

group.name

Group name for joining MarkLogic cluster

Default

1.0.0

group.enableXdqpSsl

Parameter to enable SSL encryption for XDQP

true

1.0.0

bootstrapHostName

Host name of MarkLogic bootstrap host (to join a cluster)

""

1.0.0

image.repository

Repository for MarkLogic image

marklogicdb/marklogic-db

1.0.0

image.tag

Image tag for MarkLogic image

11.1.0-centos-1.1.2

1.1.0

image.pullPolicy

Image pull policy for MarkLogic image

IfNotPresent

1.0.0

initContainers.configureGroup.image

Image for configureGroup InitContainer

curlimages/curl:8.6.0

1.1.0

initContainers.configureGroup.pullPolicy

Pull policy for configureGroup InitContainer

IfNotPresent

1.1.0

initContainers.copyCerts.image

Image for copyCerts InitContainer

redhat/ubi9:9.3

1.1.0

initContainers.copyCerts.pullPolicy

Pull policy for copyCerts InitContainer

IfNotPresent

1.1.0

imagePullSecrets

Registry secret names (as an array)

[]

1.0.0

hugepages.enabled

Parameter to enable Hugepage on MarkLogic

false

1.1.0

hugepages.mountPath

Mountpath for Hugepages

/dev/hugepages

1.1.0

resources

Resource limits for the MarkLogic container

{}

1.0.0

nameOverride

String to override the app name

""

1.0.0

fullnameOverride

String to completely replace the generated name

""

1.0.0

auth.secretName

Kubernetes secret name for MarkLogic admin credentials

""

1.0.0

auth.adminUsername

Username for the default MarkLogic administrator

""

1.0.0

auth.adminPassword

Password for the default MarkLogic administrator

""

1.0.0

auth.walletPassword

Password for the wallet

"

1.0.0

tls.enableOnDefaultAppServers

Parameter to enalbe TLS on Default App Servers (8000, 8001, 8002)

false

1.1.0

tls.certSecretNames

Names of the secrets that contain the named certificate

[]

1.1.0

tls.caSecretName

Name of the secret that contain the CA certificate

""

1.1.0

enableConverters

Parameter to install converters for the client (if they are not already installed).

false

1.0.0

license.key

Parameter to indicate the installed MarkLogic license key

""

1.0.0

license.licensee

Parameter to set the MarkLogic licensee information

""

1.0.0

affinity

Affinity for MarkLogic pods assignment

{}

1.0.0

topologySpreadConstraints

POD Topology Spread Constraints to spread Pods across cluster

[]

1.1.0

nodeSelector

Node labels for MarkLogic pods assignment

{}

1.0.0

persistence.enabled

Parameter to enable MarkLogic data persistence using Persistence Volume Claim (PVC). If set to false, EmptyDir will be used.

true

1.0.0

persistence.storageClass

The storage class for the MarkLogic data volume. Leave this parameter empty to use the default storage class.

""

1.0.0

persistence.size

Size of storage request for the MarkLogic data volume

10Gi

1.0.0

persistence.annotations

Annotations for Persistence Volume Claim (PVC)

{}

1.0.0

persistence.accessModes

Access mode for persistence volume

["ReadWriteOnce"]

1.0.0

additionalVolumeClaimTemplates

List of additional volumeClaimTemplates to each MarkLogic container

[]

1.0.0

additionalVolumes

List of additional volumes to add to the MarkLogic containers

[]

1.0.0

additionalVolumeMounts

List of mount points for the additional volumes to add to the MarkLogic containers

[]

1.0.0

additionalContainerPorts

List of ports exposed at the container level (in addition to the default ports).

Typically, this parameter is not updated. Use `service.additionalPorts` to expose the app server ports.

[]

1.0.0

service.annotations

Annotations for MarkLogic service

{}

1.0.0

service.type

Default service type

ClusterIP

1.0.0

service.additionalPorts

List of ports in addition to the defaults exposed at the service level

[]

1.1.0

serviceAccount.create

Parameter to enable creating a service account for a MarkLogic Pod

true

1.0.0

serviceAccount.annotations

Annotations for the MarkLogic service account

{}

1.0.0

serviceAccount.name

Name of the serviceAccount

""

1.0.0

priorityClassName

Name of the PriortyClass defined to set pod priority

""

1.0.0

networkPolicy.enabled

Parameter to enable network policy

false

1.0.0

networkPolicy.customRules

Placeholder to specify selectors

{}

1.0.0

networkPolicy.ports

Parameter to specify the ports where traffic is allowed

[{port:8000, endPort: 8020, protocol: TCP}]

1.0.0

containerSecurityContext.enabled

Parameter to enable security context for MarkLogic containers

true

1.0.0

containerSecurityContext.runAsUser

User ID for running the entrypoint of the container process

1000

1.0.0

containerSecurityContext.runAsNonRoot

When set to true, this parameter indicates that the container must run as a non-root user

true

1.0.0

containerSecurityContext.allowPrivilegeEscalation

Controls whether a process can gain more privileges than its parent process

true

1.0.0

livenessProbe.enabled

Parameter to enable the liveness probe

true

1.0.0

livenessProbe.initialDelaySeconds

Parameter to indicate the Initial delay for the liveness probe (in seconds)

300

1.1.0

livenessProbe.periodSeconds

Period seconds for the liveness probe

20

1.1.0

livenessProbe.timeoutSeconds

Timeout for the liveness probe (in seconds)

5

1.0.0

livenessProbe.failureThreshold

Failure threshold for the liveness probe

15

1.10

livenessProbe.successThreshold

Success threshold for the liveness probe

1

1.0.0

readinessProbe.enabled

Parameter to enable the readiness probe

false

1.1.0

readinessProbe.initialDelaySeconds

Initial delay for the readiness probe (in seconds)

10

1.0.0

readinessProbe.periodSeconds

Period seconds for the readiness probe

60

1.0.0

readinessProbe.timeoutSeconds

Timeout for the readiness probe (in seconds)

5

1.0.0

readinessProbe.failureThreshold

Failure threshold for the readiness probe

3

1.0.0

readinessProbe.successThreshold

Success threshold for the readiness probe

1

1.0.0

startupProbe.enabled

Parameter to enable the startup probe

false

1.1.0

startupProbe.initialDelaySeconds

Initial delay for the startup probe (in seconds)

10

1.0.0

startupProbe.periodSeconds

Period seconds for the startup probe

20

1.0.0

startupProbe.timeoutSeconds

Timeout for the startup probe (in seconds)

1

1.0.0

startupProbe.failureThreshold

Failure threshold for the startup probe

30

1.0.0

startupProbe.successThreshold

Success threshold for the startup probe

1

1.0.0

logCollection.enabled

Parameter to enable cluster-wide log collection of Marklogic server logs 

false

1.0.0

logCollection.image

Image repository and tag for the fluent-bit container

fluent/fluent-bit:2.2.2 

1.1.0

logCollection.resources.requests.cpu

The requested cpu resource for the fluent-bit container 

100m

1.0.0

logCollection.resources.requests.memory

The requested memory resource for the fluent-bit container 

128Mi

1.0.0

logCollection.resources.limits.cpu

The cpu resource limit for the fluent-bit container 

100m

1.0.0

logCollection.resources.limits.memory

The memory resource limit for the fluent-bit container

128Mi 

1.0.0

logCollection.files.errorLogs

Parameter to enable the collection of MarkLogic error logs when clog collection is enabled

true

1.0.0

logCollection.files.accessLogs

Parameter to enable the collection of MarkLogic access logs (when log collection is enabled)

true

1.0.0

logCollection.files.requestLogs

Parameter to enable collection of MarkLogic request logs (when log collection is enabled)

true

1.0.0

logCollection.files.crashLog

Parameter to enable collection of MarkLogic crash logs (when log collection is enabled)

true

1.0.0

logCollection.files.auditLogs

Parameter to enable collection of MarkLogic audit logs (when log collection is enabled)

true

1.0.0

logCollection.outputs

Parameter to configure the desired output for fluent-bit

""

1.0.0

haproxy.enabled

Parameter to enable the HAProxy Load Balancer for MarkLogic Server

false

1.0.0

haproxy.existingConfigmap

Name of an existing configmap with configuration for HAProxy

marklogic-haproxy 

1.0.0

haproxy.replicaCount

Number of HAProxy Deployments

2

1.0.0

haproxy.restartWhenUpgrade.enabled

Parameter to automatically roll deployments for every helm upgrade

true

1.0.0

haproxy.stats.enabled

Parameter to enable the stats page for HAProxy

false

1.0.0

haproxy.stats.port

Port for the stats page

1024

1.0.0

haproxy.stats.auth.enabled

Parameter to enable the basic auth for the stats page

false

1.0.0

haproxy.stats.auth.username

Username for the stats page

""

1.0.0

haproxy.stats.auth.password

Password for the stats page

""

1.0.0

haproxy.service.type

The service type of the HAproxy

ClusterIP

1.0.0

haproxy.ports

Ports and load balancing type configuration for HAproxy

[]

1.0.0

haproxy.tls.enabled

Parameter to enable TLS for HAProxy

false

1.0.0

haproxy.tls.secretName

Name of the secret that stores the certificate

""

1.0.0

haproxy.tls.certFileName

The name of the certificate file in the secret

""

1.0.0

haproxy.nodeSelector

Node labels for HAProxy pods assignment

{}

1.0.0

haproxy.affinity

Affinity for HAProxy pods assignment

{}

1.0.0

haproxy.resources.requests.cpu

The requested CPU resource for the HAProxy container

250m

1.0.0

haproxy.resources.requests.memory

The requested memory resource for the HAProxy container

128Mi

1.0.0

haproxy.resources.limits.cpu

The CPU resource limit for the HAProxy container

250m

1.0.0

haproxy.resources.limits.memory

The memory resource limit for the HAProxy container

128Mi

1.0.0