Hazelcast Platform Operator API Docs

type

Type represents how a batch of replication events is considered successfully replicated.

AcknowledgementType

false

ACK_ON_OPERATION_COMPLETE

timeout

Timeout represents the time in milliseconds the source cluster waits for the acknowledgement. After timeout, the events will be resent.

int32

false

60000

memberServerSocketEndpointConfig

ServerSocketEndpointConfig

false

-

clientServerSocketEndpointConfig

ServerSocketEndpointConfig

false

-

wan

[]WANConfig

false

-

repository

Repository to pull Hazelcast Platform Operator Agent(https://github.com/hazelcast/platform-operator-agent)

string

false

"docker.io/hazelcast/platform-operator-agent"

version

Version of Hazelcast Platform Operator Agent.

string

false

"latest-snapshot"

resources

Compute Resources required by the Agent container.

*corev1.ResourceRequirements

false

-

name

Name of the attribute https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#creating-custom-query-attributes

string

true

-

extractorClassName

Name of the extractor class https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#implementing-a-valueextractor

string

true

-

simple

*SimpleAuthentication

false

-

size

Size represents the maximum batch size.

int32

false

500

maximumDelay

MaximumDelay represents the maximum delay in milliseconds. If the batch size is not reached, the events will be sent after the maximum delay.

int32

false

1000

uniqueKey

string

true

-

uniqueKeyTransition

UniqueKeyTransition

true

-

secretName

Name of the secret with credentials for cloud providers.

string

false

-

bucketURI

URL of the bucket to download HotBackup folders. AWS S3, GCP Bucket and Azure Blob storage buckets are supported. Example bucket URIs: - AWS S3 → s3://bucket-name/path/to/folder - GCP Bucket → gs://bucket-name/path/to/folder - Azure Blob → azblob://bucket-name/path/to/folder

string

true

-

sessionTTLSeconds

SessionTTLSeconds is the duration for a CP session to be kept alive after the last received heartbeat. Must be greater than or equal to SessionHeartbeatIntervalSeconds and smaller than or equal to MissingCpMemberAutoRemovalSeconds.

*int32

false

-

sessionHeartbeatIntervalSeconds

SessionHeartbeatIntervalSeconds Interval in seconds for the periodically committed CP session heartbeats. Must be smaller than SessionTTLSeconds.

*int32

false

-

missingCpMemberAutoRemovalSeconds

MissingCpMemberAutoRemovalSeconds is the duration in seconds to wait before automatically removing a missing CP member from the CP Subsystem.

*int32

false

-

failOnIndeterminateOperationState

FailOnIndeterminateOperationState indicated whether CP Subsystem operations use at-least-once and at-most-once execution guarantees.

*bool

false

-

dataLoadTimeoutSeconds

DataLoadTimeoutSeconds is the timeout duration in seconds for CP members to restore their persisted data from disk

*int32

false

-

pvc

PVC is the configuration of PersistenceVolumeClaim.

*PvcConfiguration

false

-

metadata

metav1.ObjectMeta

false

-

spec

CacheSpec

true

-

status

CacheStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]Cache

true

-

name

Name of the data structure config to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully.

string

false

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

backupCount

Number of synchronous backups.

*int32

false

1

asyncBackupCount

Number of asynchronous backups.

int32

false

0

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

keyType

Class name of the key type

string

false

-

valueType

Class name of the value type

string

false

-

persistenceEnabled

When enabled, cache data will be persisted.

bool

false

false

inMemoryFormat

InMemoryFormat specifies in which format data will be stored in your cache

InMemoryFormatType

false

BINARY

eventJournal

EventJournal specifies event journal configuration of the Cache

*EventJournal

false

-

state

State of the data structure

DataStructureConfigState

false

-

message

Message explaining the current state

string

false

-

memberStatuses

Holds status of data structure for each Hazelcast member

map[string]DataStructureConfigState

false

-

realm

string

false

-

priorityGrant

*bool

false

-

onJoinOperation

ClientOnJoinOperation

false

-

all

*PermissionItem

false

-

permissions

map[string][]PermissionWithName

false

-

clientSecretName

string

false

-

secretName

Name of the secret with TLS certificate and key.

string

true

-

clientAuthentication

Mutual authentication configuration for the client. It is None by default which means the client side of connection is not authenticated.

MutualAuthentication

false

"None"

serializers

Serializers is the list of explicit serializers to be registered.

[]string

false

-

classes

Classes is the list of class names for which a zero-config serializer will be registered, without implementing an explicit serializer.

[]string

false

-

metadata

metav1.ObjectMeta

false

-

spec

CronHotBackupSpec

true

-

status

CronHotBackupStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]CronHotBackup

true

-

schedule

Schedule contains a crontab-like expression that defines the schedule in which HotBackup will be started. If the Schedule is empty the HotBackup will start only once when applied.

string

true

-

hotBackupTemplate

Specifies the hot backup that will be created when executing a CronHotBackup.

HotBackupTemplateSpec

true

-

successfulHotBackupsHistoryLimit

The number of successful finished hot backups to retain.

*int32

false

5

failedHotBackupsHistoryLimit

The number of failed finished hot backups to retain.

*int32

false

3

suspend

When true, CronHotBackup will stop creating HotBackup CRs until it is disabled

bool

false

false

customConfigCmName

Name of the ConfigMap with the Hazelcast custom configuration. This configuration from the ConfigMap might be overridden by the Hazelcast CR configuration.

string

false

-

customConfigSecretName

Name of the Secret with the Hazelcast custom configuration. This configuration from the ConfigMap might be overridden by the Hazelcast CR configuration.

string

false

-

name

Name of the data structure config to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully.

string

false

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

backupCount

Number of synchronous backups.

*int32

false

1

asyncBackupCount

Number of asynchronous backups.

int32

false

0

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

state

State of the data structure

DataStructureConfigState

false

-

message

Message explaining the current state

string

false

-

memberStatuses

Holds status of data structure for each Hazelcast member

map[string]DataStructureConfigState

false

-

host

Host to database

string

true

-

secretName

Name of the secret that contains DB credentials

string

true

-

name

The name of the executor service

string

false

"default"

poolSize

The number of executor threads per member.

int32

false

16

durability

Durability of the executor.

int32

false

1

capacity

Capacity of the executor task per partition.

int32

false

100

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

className

ClassName is the fully qualified name of the class that implements any of the Listener interface.

string

true

-

includeValues

IncludeValues is an optional attribute that indicates whether the event will contain the map value. Defaults to true.

*bool

false

true

local

Local is an optional attribute that indicates whether the map on the local member can be listened to. Defaults to false.

bool

false

false

capacity

Capacity sets the capacity of the ringbuffer underlying the event journal.

int32

false

10000

timeToLiveSeconds

TimeToLiveSeconds indicates how long the items remain in the event journal before they are expired.

int32

false

0

evictionPolicy

Eviction policy to be applied when map reaches its max size according to the max size policy.

EvictionPolicyType

false

"NONE"

maxSize

Max size of the map.

int32

false

0

maxSizePolicy

Policy for deciding if the maxSize is reached.

MaxSizePolicyType

false

"PER_NODE"

name

The name of the executor service

string

false

"default"

poolSize

The number of executor threads per member.

int32

false

8

queueCapacity

Task queue capacity of the executor.

int32

false

0

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

type

Specifies how members are exposed. Valid values are: - "Smart" (default): each member pod is exposed with a separate external address - "Unisocket": all member pods are exposed with one external address

ExposeExternallyType

false

"Smart"

discoveryServiceType

Type of the service used to discover Hazelcast cluster.

corev1.ServiceType

false

"LoadBalancer"

memberAccess

How each member is accessed from the external client. Only available for "Smart" client and valid values are: - "NodePortExternalIP" (default): each member is accessed by the NodePort service and the node external IP/hostname - "NodePortNodeName": each member is accessed by the NodePort service and the node name - "LoadBalancer": each member is accessed by the LoadBalancer service external address

MemberAccess

false

-

type

How Management Center is exposed. Valid values are: - "ClusterIP" - "NodePort" - "LoadBalancer" (default)

ExternalConnectivityType

false

"LoadBalancer"

ingress

Ingress configuration of Management Center

*ExternalConnectivityIngress

false

-

route

OpenShift Route configuration of Management Center

*ExternalConnectivityRoute

false

-

hostname

Hostname of Management Center exposed by Ingress. Ingress controller will use this hostname to route inbound traffic.

string

true

-

ingressClassName

IngressClassName of the ingress object.

string

false

-

annotations

Annotations added to the ingress object.

map[string]string

false

-

path

Path of the ingress rule.

string

false

"/"

hostname

Hostname of Management Center exposed by route. Openshift routers will use this hostname to route inbound traffic.

string

true

-

metadata

metav1.ObjectMeta

false

-

spec

FlowSpec

false

-

status

FlowStatus

false

-

ingress

Ingress configuration of Flow

*ExternalConnectivityIngress

false

-

route

OpenShift Route configuration of Flow

*ExternalConnectivityRoute

false

-

metadata

metav1.ListMeta

false

-

items

[]Flow

true

-

size

Number of Flow instances.

*int32

false

3

repository

Repository to pull the Flow image from.

string

false

"docker.io/hazelcast/hazelcast-flow"

version

Version of Flow.

string

false

"5.5.0"

imagePullPolicy

Pull policy for the Flow image

corev1.PullPolicy

false

"IfNotPresent"

imagePullSecrets

Image pull secrets for the Flow image

[]corev1.LocalObjectReference

false

-

licenseKeySecretName

Name of the secret with Hazelcast Enterprise License Key.

string

true

-

scheduling

Scheduling details

*SchedulingConfiguration

false

-

resources

Compute Resources required by the Hazelcast container.

*corev1.ResourceRequirements

false

-

externalConnectivity

Configuration to expose Flow to outside.

*FlowExternalConnectivityConfiguration

false

{}

database

Configuration for Flow database

DatabaseConfig

true

-

env

Env configuration of environment variables

[]corev1.EnvVar

false

-

annotations

Flow Kubernetes resource annotations

map[string]string

false

-

labels

Flow Kubernetes resource labels

map[string]string

false

-

phase

Phase of the Flow

FlowPhase

false

-

message

Message about the Flow state

string

false

-

size

Size of Flow members in the cluster.

int32

false

-

overrideJavaSerialization

If set to true, will replace the internal Java serialization.

*bool

false

-

className

Class name of the GlobalSerializer.

string

true

-

metadata

metav1.ObjectMeta

false

-

spec

HazelcastSpec

false

-

status

HazelcastStatus

false

-

name

Name of the Hazelcast cluster that Management Center will connect to, default is dev.

string

false

"dev"

address

IP address or DNS name of the Hazelcast cluster. If the cluster is exposed with a service name in a different namespace, use the following syntax "<service-name>.<service-namespace>".

string

true

-

tls

TLS client configuration.

*ClientTLS

false

-

security

Security client configuration.

*ClientSecurity

false

-

readyMembers

ReadyMembers represents the number of members that are connected to cluster from the desired number of members in the format <ready>/<desired>

string

false

-

metadata

metav1.ObjectMeta

false

-

spec

HazelcastEndpointSpec

false

-

status

HazelcastEndpointStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]HazelcastEndpoint

true

-

type

Type defines the endpoint connection. It is used to identify the target of the endpoint.

HazelcastEndpointType

true

-

port

Port of the endpoint.

int32

true

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

address

Address is the external address of the endpoint. It is taken from the corresponding service.

string

false

-

metadata

metav1.ListMeta

false

-

items

[]Hazelcast

true

-

podName

PodName is the name of the Hazelcast member pod.

string

false

-

uid

Uid is the unique member identifier within the cluster.

string

false

-

ip

Ip is the IP address of the member within the cluster.

string

false

-

version

Version represents the Hazelcast version of the member.

string

false

-

state

State represents the observed state of the member.

NodeState

false

-

master

Master flag is set to true if the member is master.

bool

false

-

lite

Lite is the flag that is true when the member is lite-member.

bool

false

-

ownedPartitions

OwnedPartitions represents the partitions count on the member.

int32

false

-

connected

Ready is the flag that is set to true when the member is successfully started, connected to cluster and ready to accept connections.

bool

false

-

message

Message contains the optional message with the details of the cluster state.

string

false

-

reason

Reason contains the optional reason of member crash or restart.

string

false

-

restartCount

RestartCount is the number of times the member has been restarted.

int32

false

-

clusterDataRecoveryPolicy

Configuration of the cluster recovery strategy.

DataRecoveryPolicyType

false

"PartialRecoveryMostComplete"

dataRecoveryTimeout

DataRecoveryTimeout is timeout for each step of data recovery in seconds. Maximum timeout is equal to DataRecoveryTimeout*2 (for each step: validation and data-load).

int32

false

-

pvc

Configuration of PersistenceVolumeClaim.

*PvcConfiguration

false

-

restore

Restore configuration

RestoreConfiguration

false

{}

clusterSize

Number of Hazelcast members in the cluster.

*int32

false

3

repository

Repository to pull the Hazelcast Platform image from.

string

false

"docker.io/hazelcast/hazelcast-enterprise"

version

Version of Hazelcast Platform.

string

false

"5.5.3-SNAPSHOT"

imagePullPolicy

Pull policy for the Hazelcast Platform image

corev1.PullPolicy

false

"IfNotPresent"

imagePullSecrets

Image pull secrets for the Hazelcast Platform image

[]corev1.LocalObjectReference

false

-

licenseKeySecretName

Name of the secret with Hazelcast Enterprise License Key.

string

true

-

exposeExternally

Configuration to expose Hazelcast cluster to external clients.

*ExposeExternallyConfiguration

false

-

clusterName

Name of the Hazelcast cluster.

string

false

"dev"

scheduling

Scheduling details

*SchedulingConfiguration

false

-

resources

Compute Resources required by the Hazelcast container.

*corev1.ResourceRequirements

false

-

persistence

Persistence configuration

*HazelcastPersistenceConfiguration

false

-

agent

B&R Agent configurations

AgentConfiguration

false

{repository: "docker.io/hazelcast/platform-operator-agent", version: "latest-snapshot"}

jet

Jet Engine configuration

*JetEngineConfiguration

false

{enabled: true, resourceUploadEnabled: false}

executorServices

Java Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/executor-service

[]ExecutorServiceConfiguration

false

-

durableExecutorServices

Durable Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/durable-executor-service

[]DurableExecutorServiceConfiguration

false

-

scheduledExecutorServices

Scheduled Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/scheduled-executor-service

[]ScheduledExecutorServiceConfiguration

false

-

properties

Hazelcast system properties, see https://docs.hazelcast.com/hazelcast/latest/system-properties

map[string]string

false

-

loggingLevel

Logging level for Hazelcast members

LoggingLevel

false

"INFO"

highAvailabilityMode

Configuration to create clusters resilient to node and zone failures

HighAvailabilityMode

false

-

jvm

Hazelcast JVM configuration

*JVMConfiguration

false

-

nativeMemory

Hazelcast Native Memory (HD Memory) configuration

*NativeMemoryConfiguration

false

-

advancedNetwork

Hazelcast Advanced Network configuration

*AdvancedNetwork

false

-

managementCenter

Hazelcast Management Center Configuration

*ManagementCenterConfig

false

-

tls

Hazelcast TLS configuration

*TLS

false

-

serialization

Hazelcast serialization configuration

*SerializationConfig

false

-

customConfigCmName

Name of the ConfigMap with the Hazelcast custom configuration. This configuration from the ConfigMap might be overridden by the Hazelcast CR configuration.

string

false

-

customConfigSecretName

Name of the Secret with the Hazelcast custom configuration. This configuration from the ConfigMap might be overridden by the Hazelcast CR configuration.

string

false

-

sql

Hazelcast SQL configuration

*SQL

false

-

localDevices

Hazelcast LocalDevice configuration

[]LocalDeviceConfig

false

-

annotations

Hazelcast Kubernetes resource annotations

map[string]string

false

-

labels

Hazelcast Kubernetes resource labels

map[string]string

false

-

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run Hazelcast cluster. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

string

false

-

cpSubsystem

CPSubsystem is the configuration of the Hazelcast CP Subsystem.

*CPSubsystem

false

-

userCodeNamespaces

UserCodeNamespaces provide a container for Java classpath resources, such as user code and accompanying artifacts like property files

*UserCodeNamespacesConfig

false

-

env

Env configuration of environment variables

[]corev1.EnvVar

false

-

liteMember

*LiteMember

false

-

security

*Security

false

-

clusterSize

Number of Hazelcast members in the cluster.

int32

false

-

liteMemberCount

Number of Hazelcast lite members in the cluster.

int32

false

-

selector

Selector is a label selector used by HorizontalPodAutoscaler to autoscale Hazelcast resource.

string

false

-

phase

Phase of the Hazelcast cluster

Phase

false

-

hazelcastClusterStatus

Status of the Hazelcast cluster

HazelcastClusterStatus

false

-

message

Message about the Hazelcast cluster state

string

false

-

members

Status of Hazelcast members

[]HazelcastMemberStatus

false

-

restore

Status of restore process of the Hazelcast cluster

RestoreStatus

false

{}

metadata

metav1.ObjectMeta

false

-

spec

HotBackupSpec

true

-

status

HotBackupStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]HotBackup

true

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource

string

true

-

bucketURI

URL of the bucket to download HotBackup folders. AWS S3, GCP Bucket and Azure Blob storage buckets are supported. Example bucket URIs: - AWS S3 → s3://bucket-name/path/to/folder - GCP Bucket → gs://bucket-name/path/to/folder - Azure Blob → azblob://bucket-name/path/to/folder

string

false

-

secretName

Name of the secret with credentials for cloud providers.

string

false

-

state

HotBackupState

false

-

message

string

false

-

backupUUIDs

[]string

false

-

metadata

Standard object’s metadata of the hot backups created from this template.

metav1.ObjectMeta

false

-

spec

Specification of the desired behavior of the hot backup.

HotBackupSpec

true

-

name

Name of the index config.

string

false

-

type

Type of the index. See https://docs.hazelcast.com/hazelcast/latest/query/indexing-maps#index-types

IndexType

true

-

attributes

Attributes of the index.

[]string

false

-

bitMapIndexOptions

Options for "BITMAP" index type. See https://docs.hazelcast.com/hazelcast/latest/query/indexing-maps#configuring-bitmap-indexes

*BitmapIndexOptionsConfig

false

-

memory

Memory is a JVM memory configuration

*JVMMemoryConfiguration

false

-

gc

GC is for configuring JVM Garbage Collector

*JVMGCConfiguration

false

-

args

Args is for arbitrary JVM arguments

[]string

false

-

logging

Logging enables logging when set to true

*bool

false

-

collector

Collector is the Garbage Collector type

*GCType

false

-

initialRAMPercentage

InitialRAMPercentage configures JVM initial heap size

*string

false

-

minRAMPercentage

MinRAMPercentage sets the minimum heap size for a JVM

*string

false

-

maxRAMPercentage

MaxRAMPercentage sets the maximum heap size for a JVM

*string

false

-

blacklist

Java deserialization protection Blacklist.

*SerializationFilterList

false

-

whitelist

Java deserialization protection Whitelist.

*SerializationFilterList

false

-

queueSize

Sets the capacity of processor-to-processor concurrent queues.

*int32

false

-

packetSizeLimit

Limits the size of the packet in bytes.

*int32

false

-

receiveWindowMultiplier

Sets the scaling factor used by the adaptive receive window sizing function.

*int8

false

-

enabled

When false, disables Jet Engine.

*bool

false

true

resourceUploadEnabled

When true, enables resource uploading for Jet jobs.

bool

false

false

bucketConfig

Bucket config from where the JAR files will be downloaded.

*BucketConfiguration

false

-

configMaps

Names of the list of ConfigMaps. Files in each ConfigMap will be downloaded.

[]string

false

-

remoteURLs

List of URLs from where the files will be downloaded.

[]string

false

-

instance

Jet Instance Configuration

*JetInstance

false

{}

edgeDefaults

Jet Edge Defaults Configuration

*JetEdgeDefaults

false

{}

cooperativeThreadCount

The number of threads Jet creates in its cooperative multithreading pool. Its default value is the number of cores

*int32

false

-

flowControlPeriodMillis

The duration of the interval between flow-control packets.

int32

false

100

backupCount

The number of synchronous backups to configure on the IMap that Jet needs internally to store job metadata and snapshots.

int32

false

1

scaleUpDelayMillis

The delay after which the auto-scaled jobs restart if a new member joins the cluster.

int32

false

10000

losslessRestartEnabled

Specifies whether the Lossless Cluster Restart feature is enabled.

bool

false

false

maxProcessorAccumulatedRecords

Specifies the maximum number of records that can be accumulated by any single processor instance. Default value is Long.MAX_VALUE

*int64

false

-

metadata

metav1.ObjectMeta

false

-

spec

JetJobSpec

false

-

status

JetJobStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]JetJob

true

-

metadata

metav1.ObjectMeta

false

-

spec

JetJobSnapshotSpec

true

-

status

JetJobSnapshotStatus

false

{state: "Waiting"}

metadata

metav1.ListMeta

false

-

items

[]JetJobSnapshot

true

-

name

Name of the exported snapshot

string

false

-

cancelJob

CancelJob determines whether the job is canceled after exporting snapshot

bool

false

false

jetJobResourceName

JetJobResourceName is the name of the JetJob CR where the Snapshot is exported from

string

true

-

state

JetJobSnapshotState

false

-

message

string

false

-

creationTime

*metav1.Time

false

-

name

Name of the JetJob to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully.

string

false

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

state

State is used to manage the job state.

JetJobState

true

Running

jarName

JarName specify the name of the Jar to run that is present on the member.

string

true

-

mainClass

MainClass is the name of the main class that will be run on the submitted job.

string

false

-

initialSnapshotResourceName

InitialSnapshotResourceName specify the name of the JetJobSnapshot object from which the JetJob is initialized.

string

false

-

parameters

Parameters to be passed to Jet Job.

[]string

false

-

bucketConfig

Bucket config from where the JAR files will be downloaded.

*BucketConfiguration

false

-

remoteURL

URL from where the file will be downloaded.

string

false

-

id

int64

true

-

phase

JetJobStatusPhase

true

-

submissionTime

*metav1.Time

false

-

completionTime

*metav1.Time

false

-

failureText

string

false

-

suspensionCause

string

false

-

bucketConfig

Bucket config from where the JAR files will be downloaded.

*BucketConfiguration

false

-

remoteURL

URL from where the file will be downloaded.

string

false

-

url

URL of your LDAP server, including schema (ldap://) and port.

string

true

-

credentialsSecretName

CredentialsSecretName is the name of the secret that contains username and password of a user that has admin privileges on the LDAP server. The username must be the DN of the user. It is used to connect to the server when authenticating users.

string

true

-

userDN

DN to be used for searching users.

string

true

-

groupDN

DN to be used for searching groups.

string

true

-

adminGroups

Members of these groups and its nested groups have admin privileges on the Management Center.

[]string

true

-

userGroups

Members of these groups and its nested groups have read and write privileges on the Management Center.

[]string

true

-

readonlyUserGroups

Members of these groups and its nested groups have only read privilege on the Management Center.

[]string

true

-

metricsOnlyGroups

Members of these groups and its nested groups have the privilege to see only the metrics on the Management Center.

[]string

true

-

userSearchFilter

LDAP search filter expression to search for the users. For example, uid={0} searches for a username that matches with the uid attribute.

string

true

-

groupSearchFilter

LDAP search filter expression to search for the groups. For example, uniquemember={0} searches for a group that matches with the uniquemember attribute.

string

true

-

nestedGroupSearch

NestedGroupSearch enables searching for nested LDAP groups.

bool

true

false

count

int32

true

-

scheduling

Scheduling details

*SchedulingConfiguration

false

-

jvm

Hazelcast JVM configuration

*JVMConfiguration

false

-

resources

Compute Resources required by the Hazelcast container.

*corev1.ResourceRequirements

false

-

env

Env configuration of environment variables

[]corev1.EnvVar

false

-

name

Name represents the name of the local device

string

true

-

blockSize

BlockSize defines Device block/sector size in bytes.

*int32

false

4096

readIOThreadCount

ReadIOThreadCount is Read IO thread count.

*int32

false

4

writeIOThreadCount

WriteIOThreadCount is Write IO thread count.

*int32

false

4

pvc

Configuration of PersistenceVolumeClaim.

*PvcConfiguration

false

-

args

Args is for arbitrary JVM arguments

[]string

false

-

enabled

When true, MC will use a PersistentVolumeClaim to store data.

*bool

false

true

existingVolumeClaimName

Name of the PersistentVolumeClaim MC will use for persistence. If not empty, MC will use the existing claim instead of creating a new one.

string

false

-

storageClass

StorageClass from which PersistentVolumeClaim will be created.

*string

false

-

size

Size of the created PersistentVolumeClaim.

*resource.Quantity

false

"10Gi"

metadata

metav1.ObjectMeta

false

-

spec

ManagementCenterSpec

false

-

status

ManagementCenterStatus

false

-

scriptingEnabled

Allows you to execute scripts that can automate interactions with the cluster.

bool

false

false

consoleEnabled

Allows you to execute commands from a built-in console in the user interface.

bool

false

false

dataAccessEnabled

Allows you to access contents of Hazelcast data structures via SQL Browser or Map Browser.

bool

false

false

metadata

metav1.ListMeta

false

-

items

[]ManagementCenter

true

-

repository

Repository to pull the Management Center image from.

string

false

"docker.io/hazelcast/management-center"

version

Version of Management Center.

string

false

"5.6.0"

imagePullPolicy

Pull policy for the Management Center image

corev1.PullPolicy

false

"IfNotPresent"

imagePullSecrets

Image pull secrets for the Management Center image

[]corev1.LocalObjectReference

false

-

licenseKeySecretName

Name of the secret with Hazelcast Enterprise License Key.

string

true

-

hazelcastClusters

Connection configuration for the Hazelcast clusters that Management Center will monitor.

[]HazelcastClusterConfig

false

-

externalConnectivity

Configuration to expose Management Center to outside.

*ExternalConnectivityConfiguration

false

{type: "LoadBalancer"}

persistence

Configuration for Management Center persistence.

*MCPersistenceConfiguration

false

{enabled: true, size: "10Gi"}

scheduling

Scheduling details

*SchedulingConfiguration

false

{}

resources

Compute Resources required by the MC container.

*corev1.ResourceRequirements

false

{}

jvm

ManagementCenter JVM configuration

*MCJVMConfiguration

false

-

securityProvider

SecurityProviders to authenticate users in Management Center

*SecurityProviders

false

-

annotations

ManagementCenter Kubernetes resource annotations

map[string]string

false

-

labels

ManagementCenter Kubernetes resource labels

map[string]string

false

-

env

Env configuration of environment variables

[]corev1.EnvVar

false

-

phase

Phase of the Management Center

MCPhase

false

-

configured

Configured is a flag that indicates if the configuration step has successfully passed

bool

false

-

message

Message about the Management Center state

string

false

-

externalAddresses

External addresses of the Management Center instance

string

false

-

metadata

metav1.ObjectMeta

false

-

spec

MapSpec

true

-

status

MapStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]Map

true

-

name

Name of the data structure config to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully.

string

false

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

backupCount

Number of synchronous backups.

*int32

false

1

asyncBackupCount

Number of asynchronous backups.

int32

false

0

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

timeToLiveSeconds

Maximum time in seconds for each entry to stay in the map. If it is not 0, entries that are older than this time and not updated for this time are evicted automatically. It can be updated.

int32

false

0

maxIdleSeconds

Maximum time in seconds for each entry to stay idle in the map. Entries that are idle for more than this time are evicted automatically. It can be updated.

int32

false

0

eviction

Configuration for removing data from the map when it reaches its max size. It can be updated.

EvictionConfig

false

{maxSize: 0, evictionPolicy: NONE, maxSizePolicy: PER_NODE}

indexes

Indexes to be created for the map data. You can learn more at https://docs.hazelcast.com/hazelcast/latest/query/indexing-maps. It cannot be updated after map config is created successfully.

[]IndexConfig

false

-

attributes

Attributes to be used with Predicates API. You can learn more at https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#creating-custom-query-attributes

[]AttributeConfig

false

-

persistenceEnabled

When enabled, map data will be persisted. It cannot be updated after map config is created successfully.

bool

false

false

mapStore

Configuration options when you want to load/store the map entries from/to a persistent data store such as a relational database You can learn more at https://docs.hazelcast.com/hazelcast/latest/data-structures/working-with-external-data

*MapStoreConfig

false

-

inMemoryFormat

InMemoryFormat specifies in which format data will be stored in your map

InMemoryFormatType

false

BINARY

entryListeners

EntryListeners contains the configuration for the map-level or entry-based events listeners provided by the Hazelcast’s eventing framework. You can learn more at https://docs.hazelcast.com/hazelcast/latest/events/object-events.

[]EntryListenerConfiguration

false

-

nearCache

InMemoryFormat specifies near cache configuration for map

*NearCache

false

-

eventJournal

EventJournal specifies event journal configuration of the Map

*EventJournal

false

-

tieredStore

TieredStore enables the Hazelcast’s Tiered-Store feature for the Map

*TieredStore

false

-

merkleTree

MerkleTree defines the configuration for the Merkle tree data structure.

*MerkleTreeConfig

false

-

state

MapConfigState

false

-

message

string

false

-

memberStatuses

map[string]MapConfigState

false

-

initialMode

Sets the initial entry loading mode.

InitialModeType

false

LAZY

className

Name of your class implementing MapLoader and/or MapStore interface.

string

true

-

writeDelaySeconds

Number of seconds to delay the storing of entries.

int32

false

-

writeBatchSize

Used to create batches when writing to map store.

int32

false

1

writeCoalescing

It is meaningful if you are using write behind in MapStore. When it is set to true, only the latest store operation on a key during the write-delay-seconds will be reflected to MapStore.

*bool

false

true

propertiesSecretName

Properties can be used for giving information to the MapStore implementation

string

false

-

depth

Depth of the merkle tree.

int32

false

10

metadata

metav1.ObjectMeta

false

-

spec

MultiMapSpec

true

-

status

MultiMapStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]MultiMap

true

-

name

Name of the data structure config to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully.

string

false

-

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for.

string

true

-

backupCount

Number of synchronous backups.

*int32

false

1

asyncBackupCount

Number of asynchronous backups.

int32

false

0