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. |
ExposeExternallyConfiguration
ExposeExternallyConfiguration defines how to expose Hazelcast cluster to external clients
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
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 |
false |
"Smart" |
|
|
Type of the service used to discover Hazelcast cluster. |
false |
"LoadBalancer" |
|
|
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 |
false |
- |
Hazelcast
Hazelcast is the Schema for the hazelcasts API
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
false |
{"repository" : "docker.io/hazelcast/hazelcast"} |
|
|
|
false |
- |
HazelcastClusterStatus
HazelcastClusterStatus defines the status of the Hazelcast cluster
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
ReadyMembers represents the number of members that are connected to cluster from the desired number of members in the format <ready>/<desired> |
|
true |
- |
HazelcastList
HazelcastList contains a list of Hazelcast
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
true |
- |
HazelcastMemberStatus
HazelcastMemberStatus defines the observed state of the individual Hazelcast member.
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
PodName is the name of the Hazelcast member pod. |
|
false |
- |
|
Uid is the unique member identifier within the cluster. |
|
false |
- |
|
Ip is the IP address of the member within the cluster. |
|
false |
- |
|
Version represents the Hazelcast version of the member. |
|
false |
- |
|
Ready is the flag that is set to true when the member is successfully started, connected to cluster and ready to accept connections. |
|
true |
- |
|
Message contains the optional message with the details of the cluster state. |
|
false |
- |
|
Reason contains the optional reason of member crash or restart. |
|
false |
- |
|
RestartCount is the number of times the member has been restarted. |
|
true |
- |
HazelcastPersistenceConfiguration
HazelcastPersistenceConfiguration contains the configuration for Hazelcast Persistence and K8s storage.
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Persistence base directory. |
|
true |
- |
|
Configuration of the cluster recovery strategy. |
false |
"FullRecoveryOnly" |
|
|
AutoForceStart enables the detection of constantly failing cluster and trigger the Force Start action. |
|
false |
false |
|
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). |
|
false |
- |
|
Configuration of PersistenceVolumeClaim. |
false |
- |
|
|
Host Path directory. |
|
false |
- |
HazelcastSpec
HazelcastSpec defines the desired state of Hazelcast
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Number of Hazelcast members in the cluster. |
|
false |
3 |
|
Repository to pull the Hazelcast Platform image from. |
|
false |
"docker.io/hazelcast/hazelcast" |
|
Version of Hazelcast Platform. |
|
false |
"5.1" |
|
Pull policy for the Hazelcast Platform image |
false |
"IfNotPresent" |
|
|
Image pull secrets for the Hazelcast Platform image |
false |
- |
|
|
Name of the secret with Hazelcast Enterprise License Key. |
|
false |
- |
|
Configuration to expose Hazelcast cluster to external clients. |
false |
{} |
|
|
Name of the Hazelcast cluster. |
|
false |
"dev" |
|
Scheduling details |
false |
{} |
|
|
Persistence configuration |
false |
{} |
HazelcastStatus
HazelcastStatus defines the observed state of Hazelcast
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Phase of the Hazelcast cluster |
false |
- |
|
|
Status of the Hazelcast cluster |
false |
- |
|
|
Message about the Hazelcast cluster state |
|
false |
- |
|
External addresses of the Hazelcast cluster members |
|
false |
- |
|
Status of Hazelcast members |
false |
- |
PersistencePvcConfiguration
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
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 |
false |
- |
|
|
A description of the PVC request capacity. |
|
false |
- |
|
Name of StorageClass which this persistent volume belongs to. |
|
false |
- |
SchedulingConfiguration
SchedulingConfiguration defines the pods scheduling details
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Affinity |
false |
- |
|
|
Tolerations |
false |
- |
|
|
NodeSelector |
|
false |
- |
|
TopologySpreadConstraints |
false |
- |
ExternalConnectivityConfiguration
ExternalConnectivityConfiguration defines how to expose Management Center pod.
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
How Management Center is exposed. Valid values are: - "ClusterIP" - "NodePort" - "LoadBalancer" (default) |
false |
"LoadBalancer" |
HazelcastClusterConfig
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Name of the Hazelcast cluster that Management Center will connect to, default is dev. |
|
false |
"dev" |
|
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>". |
|
true |
- |
ManagementCenter
ManagementCenter is the Schema for the managementcenters API
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
false |
{"repository" : "docker.io/hazelcast/management-center"} |
|
|
|
false |
- |
ManagementCenterList
ManagementCenterList contains a list of ManagementCenter
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
true |
- |
ManagementCenterSpec
ManagementCenterSpec defines the desired state of ManagementCenter.
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Repository to pull the Management Center image from. |
|
false |
"docker.io/hazelcast/management-center" |
|
Version of Management Center. |
|
false |
"5.1.1" |
|
Pull policy for the Management Center image |
false |
"IfNotPresent" |
|
|
Image pull secrets for the Management Center image |
false |
- |
|
|
Name of the secret with Hazelcast Enterprise License Key. |
|
false |
- |
|
Connection configuration for the Hazelcast clusters that Management Center will monitor. |
false |
- |
|
|
Configuration to expose Management Center to outside. |
false |
{type: "LoadBalancer"} |
|
|
Configuration for Management Center persistence. |
false |
{enabled: true, size: "10Gi"} |
|
|
Scheduling details |
false |
- |
ManagementCenterStatus
ManagementCenterStatus defines the observed state of ManagementCenter.
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
Phase of the Management Center |
false |
- |
|
|
Message about the Management Center state |
|
false |
- |
|
External addresses of the Management Center instance |
|
false |
- |
PersistenceConfiguration
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
When true, MC will use a PersistentVolumeClaim to store data. |
|
false |
true |
|
Name of the PersistentVolumeClaim MC will use for persistence. If not empty, MC will use the existing claim instead of creating a new one. |
|
false |
- |
|
StorageClass from which PersistentVolumeClaim will be created. |
|
false |
- |
|
Size of the created PersistentVolumeClaim. |
|
false |
"10Gi" |
HotBackup
HotBackup is the Schema for the hot backup API
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
false |
- |
|
|
|
true |
- |
HotBackupList
HotBackupList contains a list of HotBackup
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
|
false |
- |
|
|
|
true |
- |
HotBackupSpec
HotBackupSpec defines the Spec of HotBackup
Field | Description | Type | Required | Default |
---|---|---|---|---|
|
HazelcastResourceName defines the name of the Hazelcast resource |
|
true |
- |
|
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. |
|
false |
- |
DataRecoveryPolicyType
DataRecoveryPolicyType represents the options for data recovery policy when the whole cluster restarts.
Value | Description |
---|---|
|
FullRecovery does not allow partial start of the cluster and corresponds to "cluster-data-recovery-policy.FULL_RECOVERY_ONLY" configuration option. |
|
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. |
|
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. |
ExposeExternallyType
ExposeExternallyType describes how Hazelcast members are exposed.
Value | Description |
---|---|
|
ExposeExternallyTypeSmart exposes each Hazelcast member with a separate external address. |
|
ExposeExternallyTypeUnisocket exposes all Hazelcast members with one external address. |
MemberAccess
MemberAccess describes how each Hazelcast member is accessed from the external client.
Value | Description |
---|---|
|
MemberAccessNodePortExternalIP lets the client access Hazelcast member with the NodePort service and the node external IP/hostname |
|
MemberAccessNodePortNodeName lets the client access Hazelcast member with the NodePort service and the node name |
|
MemberAccessLoadBalancer lets the client access Hazelcast member with the LoadBalancer service |
Phase
Phase represents the current state of the cluster
Value | Description |
---|---|
|
Running phase is the state when all the members of the cluster are successfully started |
|
Failed phase is the state of error during the cluster startup |
|
Pending phase is the state of starting the cluster when not all the members are started yet |
ExternalConnectivityType
ExternalConnectivityType describes how Management Center is exposed.
Value | Description |
---|---|
|
ExternalConnectivityTypeClusterIP exposes Management Center with ClusterIP service. |
|
ExternalConnectivityTypeNodePort exposes Management Center with NodePort service. |
|
ExternalConnectivityTypeLoadBalancer exposes Management Center with LoadBalancer service. |