MarkLogicGroup API

Save PDF

Last Updated: April 14, 2026
4 minute read

MarkLogic Server
Documentation

The MarklogicGroup API defines and configures options at the group level.

Custom Type	Field	Type	Description	Default	Constraint
`MarklogicGroups`	`replicas`	`int32`	Number of MarkLogic Nodes for specific group	1
	`name`	`string`	Name for the statefulSet
	`labels`	`map[string]string`	Labels for the statefulSet
	`annotations`	`map[string]string`	Annotations for the statefulSet
	`groupConfig`	`GroupConfig`	MarkLogic Group Configuration for Group name and XDQP SSL
	`image`	`string`	Container Image for MarkLogic server for specific MarkLogic group
	`imagePullPolicy`	`string`	Image pull policy for specific MarkLogic group
	`imagePullSecrets`	`[]corev1.LocalObjectReference`	Registry secret names as an array for specific MarkLogic group
	`persistence`	`persistence`	Persistence for MarkLogic group
	`service`	`Service`	Service for MarkLogic Group
	`resources`	`*corev1.ResourceRequirements`	CPU or memory request for specific
	`affinity`	`*corev1.Affinity`	Affinity for MarkLogic pods assignment in this group
	`topologySpreadConstraints`	`[]corev1.TopologySpreadConstraint`	POD Topology Spread Constraints to spread Pods for this group
	`nodeSelector`	`map[string]string`	Node labels for MarkLogic pods assignment in this group
	`priorityClassName`	`string`	Name of a Priority Class defined to set pod priority for this group
	`hugePages`	`HugePages`	Config Huge Pages on MarkLogic for this group
	`logCollection`	`LogCollection`	Configure log collection of MarkLogic server logs for this group
	`haproxy`	`HAProxy`	Configure HAProxy Load Balancer for MarkLogic Server in this group
	`tls`	`Tls`	Configure TLS on Default App Servers (8000, 8001, 8002) on this group
	`additionalVolumes`	`[]corev1.Volume`	List of additional volumes to add to the MarkLogic containers for this group
	`additionalVolumeMounts`	`[]corev1.VolumeMount`	List of mount points for the additional volumes to add to the MarkLogic containers for this group
	`isBootstrap`	`bool`	Whether this group is the bootstrap node
GroupConfig	name	string	Group name for joining MarkLogic Cluster	“Default”
enableXdqpSsl	bool	SSL encryption for XDQP	true
License	key	string	Set MarkLogic license key installed		TODO: change this field using secret
Licensee	string	Set MarkLogic licensee information
persistence	size	string	Size of persistence request for MarkLogic data volume		Pattern Matching. ex “10Gi”
	`storageClassName`	`string`	persistence class for MarkLogic data volume, leave empty to use the default persistence class	““
Service	`type`	`corev1.ServiceType`	Default service type
	`additionalPorts`	`[]corev1.ServicePort`	List of ports in addition to the defaults exposed at the service level
	`annotations`	`map[string]string`	Annotations for MarkLogic service
`HugePages`	`enabled`	`bool`	Parameter to enable Hugepages on MarkLogic	false
	`mountPath`	`string`	Mountpath for Hugepages	`/dev/hugepages`
`LogCollection`	`enabled`	boolean	Parameter to enable cluster wide log collection of MarkLogic server logs	false
	`image`	`string`	Image repository and tag for fluent-bit container	`fluent/fluent-bit:4.1.1`
	`imagePullSecrets`	`[]corev1.LocalObjectReference`	Image Pull Secrets for fluent-bit container	[]
	`resources`	`*corev1.ResourceRequirements`	The resource requirement for the fluent-bit container
	`files`	`LogFilesConfig`	Parameter to set which MarkLogic log to use when log collection is enabled
	`outputs`	`string`	Configure desired output for fluent-bit
	`filters`	`string`	Configure desired filters for fluent-bit, leave empty to use the defaults
	`outputs`	`string`	Configure desired output for fluent-bit, leave empty to use the defaults
	`parsers`	`string`	Configure desired parser for fluent-bit, leave empty to use the defaults
`LogFilesConfig`	`errorLogs`	`bool`	Parameter to enable collection of MarkLogic error logs when log collection is enabled
	`accessLogs`	`bool`	Parameter to enable collection of MarkLogic access logs when log collection is enabled
	`requestLogs`	`bool`	Parameter to enable collection of MarkLogic request logs when log collection is enabled
	`crashLogs`	`bool`	Parameter to enable collection of MarkLogic crash logs when log collection is enabled
	`auditLogs`	`bool`	Parameter to enable collection of MarkLogic audit logs when log collection is enabled
`HAProxy`	`enabled`	`bool`	Parameter to enable the HAProxy Load Balancer for MarkLogic Server
	`appServers`	`[]AppServers`	App Server Port and Path for HAProxy
	`pathBasedRouting`	`bool`	Parameter to enable path based routing on the HAProxy Load Balancer for MarkLogic	false
	`tcpPorts`	`Tcpports`	Configure TCP port routing on HAProxy
`Ingress`	`enabled`	`bool`	Enable an ingress resource for the MarkLogic Cluster
	`ingressClassName`	`string`	Defines which ingress controller will implement the resource
	`labels`	`map[string]string`	Additional ingress labels
	`annotations`	`map[string]string`	Additional ingress annotations
	`host`	`string`	List of ingress hosts
	`tls`	`[]networkingv1.IngressTLS`	Configure TLS for Ingress
	`additionalHosts`	`[]networkingv1.IngressRule`	List of ingress additional hosts
`Tcpports`	`enabled`	`bool`	Parameter to enable TCP port routing on HAProxy	false
	`ports`	`[]TcpPort`	TCP Ports and load balancing type configuration for HAproxy
`TcpPort`	`port`	`int32`	Number for TCP Port
	`name`	`string`	Name for TCP Port
	`type`	`string`	Type for TCP Port
`TlsForHAProxy`	`enabled`	`bool`	Parameter to enable TLS for HAProxy
	`secretName`	`string`	Name of the secret that stores the certificate
	`certFileName`	`string`	The name of the certificate file in the secret
`Timeout`	`client`	`int32`	Timeout client measures inactivity during periods that we would expect the client to be speaking	`600`
	`connect`	`int32`	Timeout connect configures the time that HAProxy will wait for a TCP connection to a backend server to be established	`600`
	`server`	`int32`	Timeout server measures inactivity when we’d expect the backend server to be speaking	`600`
`Stats`	`enabled`	`bool`	Parameter to enable the basic auth for stats page
	`port`	`int32`	Port for stats page	1024
	`auth`	`StatsAuth`	Configure Credential for stats page
`StatsAuth`	`enabled`	`bool`	Parameter to enable the basic auth for stats page
	`username`	`string`	Username for stats page
	`password`	`string`	Password for stats page
`AppServers`	`name`	`string`	Name for the App Server
	`type`	`string`	Type for the App Server
	`port`	`int32`	Port Number for App Server
	`targetPort`	`int32`	Target Port for App Server
	`path`	`string`	Path used for path based routing
Tls	`enableOnDefaultAppServers`	boolean	Parameter to enalbe TLS on Default App Servers (8000, 8001, 8002)	false
	`certSecretNames`	`[]string`	Names of the secrets that contain the named certificate
	`caSecretName`	`string`	Name of the secret that contain the CA certificate

MarkLogic® Server on Kubernetes

MarkLogicGroup API

Table of Contents

MarkLogicGroup API