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

MemberServerSocketEndpointConfig

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

"0.1.16"

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

-

secret

Name of the secret with credentials for cloud providers.

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

true

-

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

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

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

-

port

uint

false

-

interfaces

[]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

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

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

-

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

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

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

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

-

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

Initial values will be filled with its fields' default values.

HazelcastSpec

false

{"repository" : "docker.io/hazelcast/hazelcast"}

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.

TLS

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.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

-

baseDir

Persistence base directory.

string

true

-

clusterDataRecoveryPolicy

Configuration of the cluster recovery strategy.

DataRecoveryPolicyType

false

"FullRecoveryOnly"

startupAction

StartupAction represents the action triggered when the cluster starts to force the cluster startup.

PersistenceStartupAction

false

-

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.

PersistencePvcConfiguration

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"

version

Version of Hazelcast Platform.

string

false

"5.2.3"

imagePullPolicy

Pull policy for the Hazelcast Platform image

corev1.PullPolicy

false

"IfNotPresent"

imagePullSecrets

Image pull secrets for the Hazelcast Platform image

[]corev1.LocalObjectReference

false

-

licenseKeySecret

Name of the secret with Hazelcast Enterprise License Key.

string

false

-

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.16"}

jet

Jet Engine configuration

JetEngineConfiguration

false

{enabled: true, resourceUploadEnabled: false}

userCodeDeployment

User Codes to Download into CLASSPATH

UserCodeDeploymentConfig

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

-

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

-

externalAddresses

External addresses of the Hazelcast cluster members

string

false

-

wanAddresses

WAN addresses of the Hazelcast cluster members

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

-

secret

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

-

enabled

When false, disables Jet Engine.

*bool

false

true

resourceUploadEnabled

When true, enables resource uploading for Jet jobs.

bool

false

false

metadata

metav1.ObjectMeta

false

-

spec

Initial values will be filled with its fields' default values.

ManagementCenterSpec

false

{"repository" : "docker.io/hazelcast/management-center"}

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.2.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

-

licenseKeySecret

Name of the secret with Hazelcast Enterprise License Key.

string

false

-

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.

PersistenceConfiguration

false

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

scheduling

Scheduling details

SchedulingConfiguration

false

{}

resources

Compute Resources required by the MC container.

corev1.ResourceRequirements

false

{}

phase

Phase of the Management Center

Phase

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

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

-

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

-

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

writeCoealescing

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

-

interfaces

[]string

false

-

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

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

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

-

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

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

false

-

cacheLocalEntries

CacheLocalEntries specifies whether the local entries are cached

*bool

false

true

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

-

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"

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

-

storageClassName

Name of StorageClass which this persistent volume belongs to.

*string

false

-

metadata

metav1.ObjectMeta

false

-

spec

QueueSpec

true

-

status

QueueStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]Queue

true

-

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

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

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

-

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

-

metadata

metav1.ObjectMeta

false

-

spec

ReplicatedMapSpec

true

-

status

ReplicatedMapStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]ReplicatedMap

true

-

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

-

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

-

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

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

-

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

-

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

affinity

Affinity

*corev1.Affinity

false

-

tolerations

Tolerations

[]corev1.Toleration

false

-

nodeSelector

NodeSelector

map[string]string

false

-

topologySpreadConstraints

TopologySpreadConstraints

[]corev1.TopologySpreadConstraint

false

-

secretName

Name of the secret with TLS certificate and key.

string

false

-

metadata

metav1.ObjectMeta

false

-

spec

TopicSpec

true

-

status

TopicStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]Topic

true

-

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

-

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

-

clientEnabled

When true, allows user code deployment from clients.

*bool

false

-

bucketConfig

Bucket config where JAR files will be downloaded into Java CLASSPATH.

*BucketConfiguration

false

-

triggerSequence

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

string

false

-

configMaps

Names of the list of ConfigMaps. Files in each ConfigMap will be put under Java CLASSPATH.

[]string

false

-

port

uint

false

-

portCount

uint

false

-

serviceType

corev1.ServiceType

false

-

name

string

false

-

metadata

metav1.ObjectMeta

false

-

spec

WanReplicationSpec

true

-

status

WanReplicationStatus

false

-

metadata

metav1.ListMeta

false

-

items

[]WanReplication

true

-

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

-

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}

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

-

"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.

"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.

"SET"

"LIST"

"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.

"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,

"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.

"Smart"

ExposeExternallyTypeSmart exposes each Hazelcast member with a separate external address.

"Unisocket"

ExposeExternallyTypeUnisocket exposes all Hazelcast members with one external address.

"ClusterIP"

ExternalConnectivityTypeClusterIP exposes Management Center with ClusterIP service.

"NodePort"

ExternalConnectivityTypeNodePort exposes Management Center with NodePort service.

"LoadBalancer"

ExternalConnectivityTypeLoadBalancer exposes Management Center with LoadBalancer service.

"DISCARD_AFTER_MUTATION"

"THROW_EXCEPTION"

"THROW_EXCEPTION_ONLY_IF_REPLICATION_ACTIVE"

"Serial"

"Parallel"

"G1"

"NODE"

"ZONE"

"Unknown"

"Pending"

"NotStarted"

"InProgress"

"Failure"

"Success"

"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.

"SORTED"

"HASH"

"BITMAP"

"LAZY"

Loading is asynchronous. It is the default mode.

"EAGER"

Loading is blocked until all partitions are loaded.

"OFF"

"FATAL"

"ERROR"

"WARN"

"INFO"

"DEBUG"

"TRACE"

"ALL"

"Failed"

"Success"

"Pending"

"Persisting"

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

"Terminating"

"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.

"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

"STANDARD"

NativeMemoryStandard allocate memory using default OS memory manager

"POOLED"

NativeMemoryPooled is Hazelcast own pooling memory allocator

"PASSIVE"

"ACTIVE"

"SHUT_DOWN"

"STARTING"

"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.

"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

"BINARY"

RMInMemoryFormatBinary Data will be stored in serialized binary format.

"OBJECT"

RMInMemoryFormatObject Data will be stored in deserialized form.

"Map"

"Hazelcast"

"Unknown"

"Failed"

"InProgress"

"Succeeded"

"OBJECT"

"LONG"

"RAW"

"Failed"

"Pending"

"Success"

"Persisting"

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

"Terminating"