This is a prerelease version.

View latest

Hazelcast Platform Operator API Docs

A reference guide to the Hazelcast Platform Operator CRD types.

Hazelcast Platform Operator API Docs

This is a reference for the Hazelcast Platform Operator API types. These are all the types and fields that are used in the Hazelcast Platform Operator CRDs.

This document was generated from comments in the Go code in the api/ directory.

Table of Contents

AcknowledgementSetting

Field Description Type Required Default

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

AdvancedNetwork

Field Description Type Required Default

memberServerSocketEndpointConfig

 

ServerSocketEndpointConfig

false

-

clientServerSocketEndpointConfig

 

ServerSocketEndpointConfig

false

-

wan

 

[]WANConfig

false

-

AgentConfiguration

Field Description Type Required Default

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

"0.1.29"

resources

Compute Resources required by the Agent container.

*corev1.ResourceRequirements

false

-

AttributeConfig

Field Description Type Required Default

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

-

BatchSetting

Field Description Type Required Default

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

BitmapIndexOptionsConfig

Field Description Type Required Default

uniqueKey

 

string

true

-

uniqueKeyTransition

 

UniqueKeyTransition

true

-

BucketConfiguration

Field Description Type Required Default

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

-

Deprecated

Field Description Type Required Default

secret

secret is a deprecated alias for secretName.

string

false

-

CPSubsystem

CPSubsystem contains the configuration of a component of a Hazelcast that builds a strongly consistent layer for a set of distributed data structures

Field Description Type Required Default

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

-

Cache

Cache is the Schema for the caches API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

CacheSpec

true

-

status

 

CacheStatus

false

-

CacheList

CacheList contains a list of Cache

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]Cache

true

-

CacheSpec

CacheSpec defines the desired state of Cache It cannot be updated after the Cache is created

Field Description Type Required Default

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

-

CacheStatus

CacheStatus defines the observed state of Cache

Field Description Type Required Default

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

-

CompactSerializationConfig

CompactSerializationConfig is the configuration for the Hazelcast Compact serialization.

Field Description Type Required Default

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

-

CronHotBackup

CronHotBackup is the Schema for the cronhotbackups API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

CronHotBackupSpec

true

-

status

 

CronHotBackupStatus

false

-

CronHotBackupList

CronHotBackupList contains a list of CronHotBackup

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]CronHotBackup

true

-

CronHotBackupSpec

CronHotBackupSpec defines the desired state of CronHotBackup

Field Description Type Required Default

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

CustomConfig

CustomConfig contains the name of the custom configuration object

Field Description Type Required Default

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

-

DataStructureSpec

Field Description Type Required Default

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

-

DataStructureStatus

Field Description Type Required Default

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

-

DurableExecutorServiceConfiguration

Field Description Type Required Default

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

-

EntryListenerConfiguration

Field Description Type Required Default

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

EventJournal

Field Description Type Required Default

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

EvictionConfig

Field Description Type Required Default

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"

ExecutorServiceConfiguration

Field Description Type Required Default

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

-

ExposeExternallyConfiguration

ExposeExternallyConfiguration defines how to expose Hazelcast cluster to external clients

Field Description Type Required Default

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

-

ExternalConnectivityConfiguration

ExternalConnectivityConfiguration defines how to expose Management Center pod.

Field Description Type Required Default

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

-

ExternalConnectivityIngress

ExternalConnectivityIngress defines ingress configuration of Management Center

Field Description Type Required Default

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

"/"

ExternalConnectivityRoute

ExternalConnectivityRoute defines OpenShift route configuration of Management Center

Field Description Type Required Default

hostname

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

string

true

-

GlobalSerializer

GlobalSerializer is registered as a fallback serializer to handle all other objects if a serializer cannot be located for them.

Field Description Type Required Default

overrideJavaSerialization

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

*bool

false

-

className

Class name of the GlobalSerializer.

string

true

-

Hazelcast

Hazelcast is the Schema for the hazelcasts API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

HazelcastSpec

false

-

status

 

HazelcastStatus

false

-

HazelcastClusterConfig

Field Description Type Required Default

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.

*TLS

false

-

HazelcastClusterStatus

HazelcastClusterStatus defines the status of the Hazelcast cluster

Field Description Type Required Default

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

-

HazelcastEndpoint

HazelcastEndpoint is the Schema for the hazelcastendpoints API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

HazelcastEndpointSpec

false

-

status

 

HazelcastEndpointStatus

false

-

HazelcastEndpointList

HazelcastEndpointList contains a list of HazelcastEndpoint

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]HazelcastEndpoint

true

-

HazelcastEndpointSpec

HazelcastEndpointSpec defines the desired state of HazelcastEndpoint

Field Description Type Required Default

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

-

HazelcastEndpointStatus

HazelcastEndpointStatus defines the observed state of HazelcastEndpoint

Field Description Type Required Default

address

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

string

false

-

HazelcastList

HazelcastList contains a list of Hazelcast

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]Hazelcast

true

-

HazelcastMemberStatus

HazelcastMemberStatus defines the observed state of the individual Hazelcast member.

Field Description Type Required Default

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

-

HazelcastPersistenceConfiguration

HazelcastPersistenceConfiguration contains the configuration for Hazelcast Persistence and K8s storage.

Field Description Type Required Default

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

{}

Deprecated

Field Description Type Required Default

baseDir

BaseDir is deprecated. Use restore.localConfig to restore from a local backup.

string

false

-

startupAction

DEPRECATED: DeprecatedStartupAction is deprecated. Use ClusterDataRecoveryPolicy PartialRecoveryMostComplete instead. DeprecatedStartupAction represents the action triggered when the cluster starts to force the cluster startup.

PersistenceStartupAction

false

-

HazelcastSpec

HazelcastSpec defines the desired state of Hazelcast

Field Description Type Required Default

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.0-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: "0.1.29"}

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

-

Deprecated

Field Description Type Required Default

licenseKeySecret

licenseKeySecret is a deprecated alias for licenseKeySecretName.

string

false

-

userCodeDeployment

User Codes to Download into CLASSPATH

*UserCodeDeploymentConfig

false

-

HazelcastStatus

HazelcastStatus defines the observed state of Hazelcast

Field Description Type Required Default

clusterSize

Number of Hazelcast 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

{}

HotBackup

HotBackup is the Schema for the hot backup API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

HotBackupSpec

true

-

status

 

HotBackupStatus

false

-

HotBackupList

HotBackupList contains a list of HotBackup

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]HotBackup

true

-

HotBackupSpec

HotBackupSpec defines the Spec of HotBackup

Field Description Type Required Default

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

-

Deprecated

Field Description Type Required Default

secret

secret is a deprecated alias for secretName.

string

false

-

HotBackupStatus

HotBackupStatus defines the observed state of HotBackup

Field Description Type Required Default

state

 

HotBackupState

false

-

message

 

string

false

-

backupUUIDs

 

[]string

false

-

HotBackupTemplateSpec

Field Description Type Required Default

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

-

IndexConfig

Field Description Type Required Default

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

{}

JVMConfiguration

JVMConfiguration is a Hazelcast JVM configuration

Field Description Type Required Default

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

-

JVMGCConfiguration

JVMGCConfiguration is for configuring JVM Garbage Collector

Field Description Type Required Default

logging

Logging enables logging when set to true

*bool

false

-

collector

Collector is the Garbage Collector type

*GCType

false

-

JVMMemoryConfiguration

JVMMemoryConfiguration is a JVM memory configuration

Field Description Type Required Default

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

-

JavaFilterConfig

Field Description Type Required Default

blacklist

Java deserialization protection Blacklist.

*SerializationFilterList

false

-

whitelist

Java deserialization protection Whitelist.

*SerializationFilterList

false

-

JetEdgeDefaults

Field Description Type Required Default

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

-

JetEngineConfiguration

Field Description Type Required Default

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

{}

JetInstance

Field Description Type Required Default

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

-

JetJob

JetJob is the Schema for the jetjobs API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

JetJobSpec

false

-

status

 

JetJobStatus

false

-

JetJobList

JetJobList contains a list of JetJob

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]JetJob

true

-

JetJobSnapshot

JetJobSnapshot is the Schema for the jetjobsnapshots API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

JetJobSnapshotSpec

true

-

status

 

JetJobSnapshotStatus

false

{state: "Waiting"}

JetJobSnapshotList

JetJobSnapshotList contains a list of JetJobSnapshot

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]JetJobSnapshot

true

-

JetJobSnapshotSpec

JetJobSnapshotSpec defines the desired state of JetJobSnapshot

Field Description Type Required Default

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

-

JetJobSnapshotStatus

JetJobSnapshotStatus defines the observed state of JetJobSnapshot

Field Description Type Required Default

state

 

JetJobSnapshotState

false

-

message

 

string

false

-

creationTime

 

*metav1.Time

false

-

JetJobSpec

JetJobSpec defines the desired state of JetJob

Field Description Type Required Default

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

-

JetJobStatus

JetJobStatus defines the observed state of JetJob

Field Description Type Required Default

id

 

int64

true

-

phase

 

JetJobStatusPhase

true

-

submissionTime

 

*metav1.Time

false

-

completionTime

 

*metav1.Time

false

-

failureText

 

string

false

-

suspensionCause

 

string

false

-

JetRemoteFileConfiguration

Field Description Type Required Default

bucketConfig

Bucket config from where the JAR files will be downloaded.

*BucketConfiguration

false

-

remoteURL

URL from where the file will be downloaded.

string

false

-

LDAPProvider

Field Description Type Required Default

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

LocalDeviceConfig

Field Description Type Required Default

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

-

MCJVMConfiguration

MCJVMConfiguration is a ManagementCenter JVM configuration

Field Description Type Required Default

args

Args is for arbitrary JVM arguments

[]string

false

-

MCPersistenceConfiguration

Field Description Type Required Default

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"

ManagementCenter

ManagementCenter is the Schema for the managementcenters API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

ManagementCenterSpec

false

-

status

 

ManagementCenterStatus

false

-

ManagementCenterConfig

Field Description Type Required Default

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

ManagementCenterList

ManagementCenterList contains a list of ManagementCenter

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]ManagementCenter

true

-

ManagementCenterSpec

ManagementCenterSpec defines the desired state of ManagementCenter.

Field Description Type Required Default

repository

Repository to pull the Management Center image from.

string

false

"docker.io/hazelcast/management-center"

version

Version of Management Center.

string

false

"5.4.1"

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

-

Deprecated

Field Description Type Required Default

licenseKeySecret

licenseKeySecret is a deprecated alias for licenseKeySecretName.

string

false

-

ManagementCenterStatus

ManagementCenterStatus defines the observed state of ManagementCenter.

Field Description Type Required Default

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

-

Map

Map is the Schema for the maps API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

MapSpec

true

-

status

 

MapStatus

false

-

MapList

MapList contains a list of Map

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]Map

true

-

MapSpec

MapSpec defines the desired state of Hazelcast Map Config

Field Description Type Required Default

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

-

MapStatus

MapStatus defines the observed state of Map

Field Description Type Required Default

state

 

MapConfigState

false

-

message

 

string

false

-

memberStatuses

 

map[string]MapConfigState

false

-

MapStoreConfig

Field Description Type Required Default

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

-

MerkleTreeConfig

Field Description Type Required Default

depth

Depth of the merkle tree.

int32

false

10

MultiMap

MultiMap is the Schema for the multimaps API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

MultiMapSpec

true

-

status

 

MultiMapStatus

false

-

MultiMapList

MultiMapList contains a list of MultiMap

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]MultiMap

true

-

MultiMapSpec

MultiMapSpec defines the desired state of MultiMap

Field Description Type Required Default

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

-

binary

Specifies in which format data will be stored in your MultiMap. false: OBJECT true: BINARY

bool

false

false

collectionType

Type of the value collection

CollectionType

false

SET

MultiMapStatus

MultiMapStatus defines the observed state of MultiMap

Field Description Type Required Default

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

-

NativeMemoryConfiguration

NativeMemoryConfiguration is a Hazelcast HD memory configuration

Field Description Type Required Default

allocatorType

AllocatorType specifies one of 2 types of mechanism for allocating memory to HD

NativeMemoryAllocatorType

false

"STANDARD"

size

Size of the total native memory to allocate

resource.Quantity

false

"512M"

minBlockSize

MinBlockSize is the size of smallest block that will be allocated. It is used only by the POOLED memory allocator.

int32

false

-

pageSize

PageSize is the size of the page in bytes to allocate memory as a block. It is used only by the POOLED memory allocator.

int32

false

4194304

metadataSpacePercentage

MetadataSpacePercentage defines percentage of the allocated native memory that is used for the metadata of other map components such as index (for predicates), offset, etc.

int32

false

12

NearCache

Field Description Type Required Default

name

Name is name of the near cache

string

false

default

inMemoryFormat

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

InMemoryFormatType

false

BINARY

invalidateOnChange

InvalidateOnChange specifies whether the cached entries are evicted when the entries are updated or removed

*bool

false

true

timeToLiveSeconds

TimeToLiveSeconds maximum number of seconds for each entry to stay in the Near Cache

uint

false

0

maxIdleSeconds

MaxIdleSeconds Maximum number of seconds each entry can stay in the Near Cache as untouched (not read)

uint

false

0

eviction

NearCacheEviction specifies the eviction behavior in Near Cache

NearCacheEviction

true

{evictionPolicy: NONE, maxSizePolicy: ENTRY_COUNT}

cacheLocalEntries

CacheLocalEntries specifies whether the local entries are cached

*bool

false

true

NearCacheEviction

Field Description Type Required Default

evictionPolicy

EvictionPolicy to be applied when near cache reaches its max size according to the max size policy.

EvictionPolicyType

false

"NONE"

maxSizePolicy

MaxSizePolicy for deciding if the maxSize is reached.

MaxSizePolicyType

false

"ENTRY_COUNT"

size

Size is maximum size of the Near Cache used for max-size-policy

uint32

false

0

PvcConfiguration

Field Description Type Required Default

accessModes

AccessModes contains the actual access modes of the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

[]corev1.PersistentVolumeAccessMode

false

-

requestStorage

A description of the PVC request capacity.

*resource.Quantity

false

"8Gi"

storageClassName

Name of StorageClass which this persistent volume belongs to.

*string

false

-

Queue

Queue is the Schema for the queues API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

QueueSpec

true

-

status

 

QueueStatus

false

-

QueueList

QueueList contains a list of Queue

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]Queue

true

-

QueueSetting

QueueSetting defines the configuration for Hazelcast WAN queue

Field Description Type Required Default

capacity

Capacity is the total capacity of WAN queue.

int32

false

10000

fullBehavior

FullBehavior represents the behavior of the new arrival when the queue is full.

FullBehaviorSetting

false

DISCARD_AFTER_MUTATION

QueueSpec

QueueSpec defines the desired state of Queue It cannot be updated after the Queue is created

Field Description Type Required Default

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

-

maxSize

Max size of the queue.

int32

false

0

emptyQueueTTLSeconds

Time in seconds after which the Queue will be destroyed if it stays empty or unused. If the values is not provided the Queue will never be destroyed.

*int32

false

-1

priorityComparatorClassName

The name of the comparator class. If the class name is provided, the Queue becomes Priority Queue. You can learn more at https://docs.hazelcast.com/hazelcast/latest/data-structures/priority-queue.

string

false

-

QueueStatus

QueueStatus defines the observed state of Queue

Field Description Type Required Default

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

-

RemoteFileConfiguration

Field Description Type Required Default

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

-

ReplicatedMap

ReplicatedMap is the Schema for the replicatedmaps API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

ReplicatedMapSpec

true

-

status

 

ReplicatedMapStatus

false

-

ReplicatedMapList

ReplicatedMapList contains a list of ReplicatedMap

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]ReplicatedMap

true

-

ReplicatedMapSpec

ReplicatedMapSpec defines the desired state of ReplicatedMap

Field Description Type Required Default

name

Name of the ReplicatedMap config to be created. If empty, CR name will be used.

string

false

-

asyncFillup

AsyncFillup specifies whether the ReplicatedMap is available for reads before the initial replication is completed

*bool

false

true

inMemoryFormat

InMemoryFormat specifies in which format data will be stored in the ReplicatedMap

RMInMemoryFormatType

false

OBJECT

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource.

string

true

-

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

ReplicatedMapStatus

ReplicatedMapStatus defines the observed state of ReplicatedMap

Field Description Type Required Default

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

-

ResourceSpec

Field Description Type Required Default

name

Name is the name of custom resource to which WAN replication applies.

string

true

-

kind

Kind is the kind of custom resource to which WAN replication applies.

ResourceKind

false

Map

RestoreConfiguration

RestoreConfiguration contains the configuration for Restore operation

Field Description Type Required Default

bucketConfig

Bucket Configuration from which the backup will be downloaded.

*BucketConfiguration

false

-

hotBackupResourceName

Name of the HotBackup resource from which backup will be fetched.

string

false

-

localConfig

Configuration to restore from local backup

*RestoreFromLocalConfiguration

false

-

RestoreFromLocalConfiguration

Field Description Type Required Default

pvcNamePrefix

PVC name prefix used in existing PVCs

PVCNamePrefix

false

"persistence"

baseDir

Persistence base directory

string

false

-

backupDir

Local backup base directory

string

false

-

backupFolder

Backup directory

string

false

-

RestoreStatus

Field Description Type Required Default

state

State shows the current phase of the restore process of the cluster.

RestoreState

false

-

remainingValidationTime

RemainingValidationTime show the time in seconds remained for the restore validation step.

int64

false

-

remainingDataLoadTime

RemainingDataLoadTime show the time in seconds remained for the restore data load step.

int64

false

-

SQL

Field Description Type Required Default

statementTimeout

StatementTimeout defines the timeout in milliseconds that is applied to queries without an explicit timeout.

int32

false

0

catalogPersistenceEnabled

CatalogPersistenceEnabled sets whether SQL Catalog persistence is enabled for the node. With SQL Catalog persistence enabled you can restart the whole cluster without losing schema definition objects (such as MAPPINGs, TYPEs, VIEWs and DATA CONNECTIONs). The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Feature is disabled by default.

bool

false

false

ScheduledExecutorServiceConfiguration

Field Description Type Required Default

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

capacityPolicy

The active policy for the capacity setting.

string

false

PER_NODE

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

SchedulingConfiguration

SchedulingConfiguration defines the pods scheduling details

Field Description Type Required Default

affinity

Affinity

*corev1.Affinity

false

-

tolerations

Tolerations

[]corev1.Toleration

false

-

nodeSelector

NodeSelector

map[string]string

false

-

topologySpreadConstraints

TopologySpreadConstraints

[]corev1.TopologySpreadConstraint

false

-

SecurityProviders

Field Description Type Required Default

ldap

LDAP security provider

*LDAPProvider

false

-

SerializationConfig

SerializationConfig contains the configuration for the Hazelcast serialization.

Field Description Type Required Default

byteOrder

Specifies the byte order that the serialization will use.

ByteOrder

false

BigEndian

overrideDefaultSerializers

Allows override of built-in default serializers.

bool

false

false

enableCompression

Enables compression when default Java serialization is used.

bool

false

false

enableSharedObject

Enables shared object when default Java serialization is used.

bool

false

false

allowUnsafe

Allow the usage of unsafe.

bool

false

false

dataSerializableFactories

Lists class implementations of Hazelcast’s DataSerializableFactory.

[]string

false

-

portableFactories

Lists class implementations of Hazelcast’s PortableFactory.

[]string

false

-

globalSerializer

List of global serializers.

*GlobalSerializer

false

-

serializers

List of serializers (classes) that implemented using Hazelcast’s StreamSerializer, ByteArraySerializer etc.

[]Serializer

false

-

compactSerialization

Configuration attributes the compact serialization.

*CompactSerializationConfig

false

-

javaSerializationFilter

Blacklist and whitelist for deserialized classes when Java serialization is used.

*JavaFilterConfig

false

-

SerializationFilterList

Field Description Type Required Default

classes

List of class names to be filtered.

[]string

false

-

packages

List of packages to be filtered

[]string

false

-

prefixes

List of prefixes to be filtered.

[]string

false

-

Serializer

Serializer allows to plug in a custom serializer for serializing objects.

Field Description Type Required Default

typeClass

Name of the class that will be serialized via this implementation.

string

true

-

className

Class name of the implementation of the serializer class.

string

true

-

ServerSocketEndpointConfig

Field Description Type Required Default

interfaces

 

[]string

false

-

TLS

Field Description Type Required Default

secretName

Name of the secret with TLS certificate and key.

string

true

-

mutualAuthentication

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

MutualAuthentication

false

"None"

TieredStore

Field Description Type Required Default

memoryCapacity

MemoryCapacity sets Memory tier capacity, i.e., how much main memory should this tier consume at most.

*resource.Quantity

false

"256M"

diskDeviceName

diskDeviceName defines the name of the device for a given disk tier.

string

false

-

Topic

Topic is the Schema for the topics API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

TopicSpec

true

-

status

 

TopicStatus

false

-

TopicList

TopicList contains a list of Topic

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]Topic

true

-

TopicSpec

TopicSpec defines the desired state of Topic

Field Description Type Required Default

name

Name of the topic config to be created. If empty, CR name will be used.

string

false

-

globalOrderingEnabled

globalOrderingEnabled allows all nodes listening to the same topic get their messages in the same order the same order

bool

false

false

multiThreadingEnabled

multiThreadingEnabled enables multi-threaded processing of incoming messages a single thread will handle all topic messages

bool

false

false

hazelcastResourceName

HazelcastResourceName defines the name of the Hazelcast resource for which topic config will be created

string

true

-

userCodeNamespace

Name of the User Code Namespace applied to this instance

string

false

-

TopicStatus

TopicStatus defines the observed state of Topic

Field Description Type Required Default

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

-

UserCodeDeploymentConfig

UserCodeDeploymentConfig contains the configuration for User Code download operation

Field Description Type Required Default

clientEnabled

When true, allows user code deployment from clients.

*bool

false

-

triggerSequence

A string for triggering a rolling restart for re-downloading the user code.

string

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

-

UserCodeNamespace

UserCodeNamespace is the Schema for the usercodenamespaces API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

UserCodeNamespaceSpec

false

-

status

 

UserCodeNamespaceStatus

false

-

UserCodeNamespaceList

UserCodeNamespaceList contains a list of UserCodeNamespace

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]UserCodeNamespace

true

-

UserCodeNamespaceSpec

UserCodeNamespaceSpec defines the desired state of UserCodeNamespace

Field Description Type Required Default

bucketConfig

Bucket config from where the JAR files will be downloaded.

*BucketConfiguration

false

-

hazelcastResourceName

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

string

true

-

UserCodeNamespaceStatus

UserCodeNamespaceStatus defines the observed state of UserCodeNamespace

Field Description Type Required Default

state

 

UserCodeNamespaceState

false

-

message

 

string

false

-

UserCodeNamespacesConfig

Field Description Type Required Default

classFilter

Blacklist and whitelist for classes when User Code Namespaces is used.

*JavaFilterConfig

false

-

WANConfig

Field Description Type Required Default

port

 

uint

false

-

portCount

 

uint

false

-

serviceType

 

corev1.ServiceType

false

-

name

 

string

false

-

WanReplication

WanReplication is the Schema for the wanreplications API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

WanReplicationSpec

true

-

status

 

WanReplicationStatus

false

-

WanReplicationList

WanReplicationList contains a list of WanReplication

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]WanReplication

true

-

WanReplicationMapStatus

Field Description Type Required Default

resourceName

ResourceName is the name of the Map Custom Resource.

string

false

-

publisherId

PublisherId is the ID used for WAN publisher ID

string

false

-

status

Status is the status of WAN replication

WanStatus

false

-

message

Message is the field to show detail information or error

string

false

-

WanReplicationSpec

WanReplicationSpec defines the desired state of WanReplication

Field Description Type Required Default

resources

Resources is the list of custom resources to which WAN replication applies.

[]ResourceSpec

true

-

targetClusterName

ClusterName is the clusterName field of the target Hazelcast resource.

string

true

-

endpoints

Endpoints is the target cluster comma separated endpoint list .

string

true

-

queue

Queue is the configuration for WAN events queue.

QueueSetting

false

{capacity: 10000, fullBehavior: DISCARD_AFTER_MUTATION}

batch

Batch is the configuration for WAN events batch.

BatchSetting

false

{size: 500, maximumDelay: 1000}

acknowledgement

Acknowledgement is the configuration for the condition when the next batch of WAN events are sent.

AcknowledgementSetting

false

{type: ACK_ON_OPERATION_COMPLETE, timeout: 60000}

syncConsistencyCheckStrategy

SyncConsistencyCheckStrategy is the strategy for checking the consistency of data between replicas.

SyncConsistencyCheckStrategy

false

-

WanReplicationStatus

WanReplicationStatus defines the observed state of WanReplication

Field Description Type Required Default

status

Status is the status of WAN replication

WanStatus

false

-

message

Message is the field to show detail information or error

string

false

-

wanReplicationMapsStatus

WanReplicationMapsStatus is the WAN Replication status of the Maps given in the spec directly or indirectly by Hazelcast resource.

map[string]WanReplicationMapStatus

false

-

WanSync

WanSync is the Schema for the wansyncs API

Field Description Type Required Default

metadata

 

metav1.ObjectMeta

false

-

spec

 

WanSyncSpec

true

-

status

 

WanSyncStatus

false

-

WanSyncList

WanSyncList contains a list of WanSync

Field Description Type Required Default

metadata

 

metav1.ListMeta

false

-

items

 

[]WanSync

true

-

WanSyncMapStatus

Field Description Type Required Default

resourceName

ResourceName is the name of the Map Custom Resource.

string

false

-

publisherId

PublisherId is the ID used for WAN publisher ID

string

false

-

phase

Status is the status of the resource WAN sync

WanSyncPhase

false

-

message

Message is the field to show detail information or error

string

false

-

WanSyncSpec

WanSyncSpec defines the desired state of WanSync

Field Description Type Required Default

wanReplicationResourceName

WanReplicationResourceName is the name of WanReplication CR that contains the WAN publisher configuration. If specified the Sync operation will use existing WAN publisher.

string

true

-

WanSyncStatus

WanSyncStatus defines the observed state of WanSync

Field Description Type Required Default

status

Status is the status of WAN Sync

WanSyncPhase

false

-

message

Message is the field to show detail information or error

string

false

-

wanSyncMapsStatus

WanSyncMapStatus is the WAN Sync status of the Maps given in the spec directly or indirectly by Hazelcast resource.

map[string]WanSyncMapStatus

false

-

AcknowledgementType

Value Description

"ACK_ON_RECEIPT"

Replication event is considered successful as soon as it is received by target cluster.

"ACK_ON_OPERATION_COMPLETE"

Replication event is considered successful when it is received and applied by the target cluster.

ByteOrder

Value Description

"Native"

NativeByteOrder uses the native byte order of the underlying platform.

"BigEndian"

BigEndian uses the big-endian byte order.

"LittleEndian"

LittleEndian uses the kittle-endian byte order.

CapacityPolicyType

CapacityPolicyType represents the active policy types for the capacity setting

Value Description

"PER_NODE"

CapacityPolicyPerNode is the policy for limiting the maximum number of tasks in each Hazelcast instance

"PER_PARTITION"

CapacityPolicyPerPartition is the policy for limiting the maximum number of tasks within each partition.

CollectionType

CollectionType represents the value collection options for storing the data in the multiMap.

Value Description

"SET"

 

"LIST"

 

DataRecoveryPolicyType

DataRecoveryPolicyType represents the options for data recovery policy when the whole cluster restarts.

Value Description

"FullRecoveryOnly"

FullRecovery does not allow partial start of the cluster and corresponds to "cluster-data-recovery-policy.FULL_RECOVERY_ONLY" configuration option.

"PartialRecoveryMostRecent"

MostRecent allow partial start with the members that have most up-to-date partition table and corresponds to "cluster-data-recovery-policy.PARTIAL_RECOVERY_MOST_RECENT" configuration option.

"PartialRecoveryMostComplete"

MostComplete allow partial start with the members that have most complete partition table and corresponds to "cluster-data-recovery-policy.PARTIAL_RECOVERY_MOST_COMPLETE" configuration option.

DataStructureConfigState

Value Description

"Failed"

Data structure is not successfully applied.

"Success"

Data structure configuration is applied successfully.

"Pending"

Data structure configuration is being applied

"Persisting"

The config is added into all members but waiting for the config to be persisted into ConfigMap

"Terminating"

Data structure is marked to be deleted,

EvictionPolicyType

Value Description

"LRU"

Least recently used entries will be removed.

"LFU"

Least frequently used entries will be removed.

"NONE"

No eviction.

"RANDOM"

Randomly selected entries will be removed.

ExposeExternallyType

ExposeExternallyType describes how Hazelcast members are exposed.

Value Description

"Smart"

ExposeExternallyTypeSmart exposes each Hazelcast member with a separate external address.

"Unisocket"

ExposeExternallyTypeUnisocket exposes all Hazelcast members with one external address.

ExternalConnectivityType

ExternalConnectivityType describes how Management Center is exposed.

Value Description

"ClusterIP"

ExternalConnectivityTypeClusterIP exposes Management Center with ClusterIP service.

"NodePort"

ExternalConnectivityTypeNodePort exposes Management Center with NodePort service.

"LoadBalancer"

ExternalConnectivityTypeLoadBalancer exposes Management Center with LoadBalancer service.

FullBehaviorSetting

Value Description

"DISCARD_AFTER_MUTATION"

 

"THROW_EXCEPTION"

 

"THROW_EXCEPTION_ONLY_IF_REPLICATION_ACTIVE"

 

GCType

GCType is Garbage Collector type

Value Description

"Serial"

 

"Parallel"

 

"G1"

 

HazelcastEndpointType

Value Description

"Discovery"

 

"Member"

 

"WAN"

 

HighAvailabilityMode

Value Description

"NODE"

 

"ZONE"

 

HotBackupState

Value Description

"Unknown"

 

"Pending"

 

"NotStarted"

 

"InProgress"

 

"Failure"

 

"Success"

 

InMemoryFormatType

InMemoryFormatType represents the format options for storing the data in the map/cache.

Value Description

"BINARY"

InMemoryFormatBinary Data will be stored in serialized binary format.

"OBJECT"

InMemoryFormatObject Data will be stored in deserialized form.

"NATIVE"

InMemoryFormatNative Data will be stored in the map that uses Hazelcast’s High-Density Memory Store feature.

IndexType

Value Description

"SORTED"

 

"HASH"

 

"BITMAP"

 

InitialModeType

Value Description

"LAZY"

Loading is asynchronous. It is the default mode.

"EAGER"

Loading is blocked until all partitions are loaded.

JetJobSnapshotState

Value Description

"Waiting"

 

"Exporting"

 

"Exported"

 

"Failed"

 

JetJobState

Value Description

"Running"

 

"Suspended"

 

"Canceled"

 

"Restarted"

 

JetJobStatusPhase

Value Description

"Failed"

 

"NotRunning"

 

"Starting"

 

"Running"

 

"Suspended"

 

"SuspendedExportingSnapshot"

 

"Completing"

 

"ExecutionFailed"

 

"Completed"

 

LoggingLevel

LoggingLevel controls log verbosity for Hazelcast.

Value Description

"OFF"

 

"FATAL"

 

"ERROR"

 

"WARN"

 

"INFO"

 

"DEBUG"

 

"TRACE"

 

"ALL"

 

MCPhase

MCPhase represents the current state of the cluster

Value Description

"Running"

McRunning phase is the state when the ManagementCenter is successfully started

"Failed"

McFailed phase is the state of error during the ManagementCenter startup

"Configuring"

McConfiguring phase is the state of configuring the ManagementCenter and might be restated

"Pending"

McPending phase is the state of starting the cluster when the ManagementCenter is not started yet

"Terminating"

McTerminating phase is the state where deletion of ManagementCenter and dependent resources happen

MapConfigState

Value Description

"Failed"

 

"Success"

 

"Pending"

 

"Persisting"

Map config is added into all members but waiting for map to be persistent into ConfigMap

"Terminating"

 

MaxSizePolicyType

Value Description

"PER_NODE"

Maximum number of map entries in each cluster member. You cannot set the max-size to a value lower than the partition count (which is 271 by default).

"PER_PARTITION"

Maximum number of map entries within each partition.

"USED_HEAP_PERCENTAGE"

Maximum used heap size percentage per map for each Hazelcast instance. If, for example, JVM is configured to have 1000 MB and this value is 10, then the map entries will be evicted when used heap size exceeds 100 MB. It does not work when "in-memory-format" is set to OBJECT.

"USED_HEAP_SIZE"

Maximum used heap size in megabytes per map for each Hazelcast instance. It does not work when "in-memory-format" is set to OBJECT.

"FREE_HEAP_PERCENTAGE"

Minimum free heap size percentage for each Hazelcast instance. If, for example, JVM is configured to have 1000 MB and this value is 10, then the map entries will be evicted when free heap size is below 100 MB.

"FREE_HEAP_SIZE"

Minimum free heap size in megabytes for each Hazelcast instance.

"USED_NATIVE_MEMORY_SIZE"

Maximum used native memory size in megabytes per map for each Hazelcast instance. It is available only in Hazelcast Enterprise HD.

"USED_NATIVE_MEMORY_PERCENTAGE"

Maximum used native memory size percentage per map for each Hazelcast instance. It is available only in Hazelcast Enterprise HD.

"FREE_NATIVE_MEMORY_SIZE"

Minimum free native memory size in megabytes for each Hazelcast instance. It is available only in Hazelcast Enterprise HD.

"FREE_NATIVE_MEMORY_PERCENTAGE"

Minimum free native memory size percentage for each Hazelcast instance. It is available only in Hazelcast Enterprise HD.

"ENTRY_COUNT"

Maximum size based on the entry count in the Near Cache Warning: This policy is specific to near cache.

MemberAccess

MemberAccess describes how each Hazelcast member is accessed from the external client.

Value Description

"NodePortExternalIP"

MemberAccessNodePortExternalIP lets the client access Hazelcast member with the NodePort service and the node external IP/hostname

"NodePortNodeName"

MemberAccessNodePortNodeName lets the client access Hazelcast member with the NodePort service and the node name

"LoadBalancer"

MemberAccessLoadBalancer lets the client access Hazelcast member with the LoadBalancer service

MutualAuthentication

Value Description

"None"

Client side of connection is not authenticated.

"Required"

Server asks for client certificate. If the client does not provide a keystore or the provided keystore is not verified against member’s truststore, the client is not authenticated.

"Optional"

Server asks for client certificate, but client is not required to provide any valid certificate.

NativeMemoryAllocatorType

NativeMemoryAllocatorType is one of 2 types of mechanism for allocating HD Memory

Value Description

"STANDARD"

NativeMemoryStandard allocate memory using default OS memory manager

"POOLED"

NativeMemoryPooled is Hazelcast own pooling memory allocator

NodeState

Value Description

"PASSIVE"

 

"ACTIVE"

 

"SHUT_DOWN"

 

"STARTING"

 

PVCNamePrefix

PVCNamePrefix specifies the prefix of existing PVCs

Value Description

"persistence"

Persistence format is persistence.

"hot-restart-persistence"

HotRestartPersistence format is hot-restart-persistence.

PersistenceStartupAction

PersistenceStartupAction represents the action triggered on the cluster startup to force the cluster startup.

Value Description

"ForceStart"

ForceStart will trigger the force start action on the startup

"PartialStart"

PartialStart will trigger the partial start action on the startup. Can be used only with the MostComplete or MostRecent DataRecoveryPolicyType type.

Phase

Phase represents the current state of the cluster

Value Description

"Running"

Running phase is the state when all the members of the cluster are successfully started

"Failed"

Failed phase is the state of error during the cluster startup

"Pending"

Pending phase is the state of starting the cluster when not all the members are started yet

"Terminating"

Terminating phase is the state where deletion of cluster scoped resources and Hazelcast dependent resources happen

RMInMemoryFormatType

RMInMemoryFormatType represents the format options for storing the data in the ReplicatedMap.

Value Description

"BINARY"

RMInMemoryFormatBinary Data will be stored in serialized binary format.

"OBJECT"

RMInMemoryFormatObject Data will be stored in deserialized form.

ResourceKind

Value Description

"Map"

 

"Hazelcast"

 

RestoreState

Value Description

"Unknown"

 

"Failed"

 

"InProgress"

 

"Succeeded"

 

SyncConsistencyCheckStrategy

Value Description

UniqueKeyTransition

Value Description

"OBJECT"

 

"LONG"

 

"RAW"

 

UserCodeNamespaceState

Value Description

"Pending"

 

"Failure"

 

"Success"

 

WanStatus

Value Description

"Failed"

 

"Pending"

 

"Success"

 

"Persisting"

The config is added into all members but waiting for the config to be persisted into ConfigMap

"Terminating"

 

WanSyncPhase

Value Description

"NotStarted"

 

"Failed"

 

"Pending"

 

"Completed"