Skip to content

Commit

Permalink
Update API reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@devOpsHelm
devOpsHelm committed Mar 11, 2024
1 parent 78bbc27 commit 106c673
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions docs/modules/ROOT/pages/api-ref.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<JetJobStatusPhase,JetJobStatusPhase>>
* <<JetRemoteFileConfiguration,JetRemoteFileConfiguration>>
* <<LDAPProvider,LDAPProvider>>
* <<LocalDeviceConfig,LocalDeviceConfig>>
* <<LoggingLevel,LoggingLevel>>
* <<MCJVMConfiguration,MCJVMConfiguration>>
* <<MCPersistenceConfiguration,MCPersistenceConfiguration>>
Expand Down Expand Up @@ -124,9 +125,9 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<NearCache,NearCache>>
* <<NearCacheEviction,NearCacheEviction>>
* <<NodeState,NodeState>>
* <<PersistencePvcConfiguration,PersistencePvcConfiguration>>
* <<PersistenceStartupAction,PersistenceStartupAction>>
* <<Phase,Phase>>
* <<PvcConfiguration,PvcConfiguration>>
* <<Queue,Queue>>
* <<QueueList,QueueList>>
* <<QueueSetting,QueueSetting>>
Expand All @@ -152,6 +153,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<Serializer,Serializer>>
* <<ServerSocketEndpointConfig,ServerSocketEndpointConfig>>
* <<TLS,TLS>>
* <<TieredStore,TieredStore>>
* <<Topic,Topic>>
* <<TopicList,TopicList>>
* <<TopicSpec,TopicSpec>>
Expand Down Expand Up @@ -694,7 +696,7 @@ HazelcastPersistenceConfiguration contains the configuration for Hazelcast Persi
m| clusterDataRecoveryPolicy | Configuration of the cluster recovery strategy. m| <<DataRecoveryPolicyType,DataRecoveryPolicyType>> | false | "FullRecoveryOnly"
m| startupAction | StartupAction represents the action triggered when the cluster starts to force the cluster startup. m| <<PersistenceStartupAction,PersistenceStartupAction>> | false | -
m| 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). m| int32 | false | -
m| pvc | Configuration of PersistenceVolumeClaim. m| &#42;<<PersistencePvcConfiguration,PersistencePvcConfiguration>> | false | -
m| pvc | Configuration of PersistenceVolumeClaim. m| &#42;<<PvcConfiguration,PvcConfiguration>> | false | -
m| restore | Restore configuration m| <<RestoreConfiguration,RestoreConfiguration>> | false | {}
|===

Expand All @@ -709,7 +711,7 @@ HazelcastSpec defines the desired state of Hazelcast
| Field | Description | Type | Required | Default
m| clusterSize | Number of Hazelcast members in the cluster. m| &#42;int32 | false | 3
m| repository | Repository to pull the Hazelcast Platform image from. m| string | false | "docker.io/hazelcast/hazelcast"
m| version | Version of Hazelcast Platform. m| string | false | "5.3.5"
m| version | Version of Hazelcast Platform. m| string | false | "5.4.0-SNAPSHOT"
m| imagePullPolicy | Pull policy for the Hazelcast Platform image m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#pullpolicy-v1-core[corev1.PullPolicy] | false | "IfNotPresent"
m| imagePullSecrets | Image pull secrets for the Hazelcast Platform image m| []https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core[corev1.LocalObjectReference] | false | -
m| licenseKeySecretName | Name of the secret with Hazelcast Enterprise License Key. m| string | false | -
Expand All @@ -735,6 +737,7 @@ m| tls | Hazelcast TLS configuration m| &#42;<<TLS,TLS>> | false | -
m| serialization | Hazelcast serialization configuration m| &#42;<<SerializationConfig,SerializationConfig>> | false | -
m| customConfigCmName | Name of the ConfigMap with the Hazelcast custom configuration. This configuration from the ConfigMap might be overridden by the Hazelcast CR configuration. m| string | false | -
m| sql | Hazelcast SQL configuration m| &#42;<<SQL,SQL>> | false | -
m| localDevices | Hazelcast LocalDevice configuration m| []<<LocalDeviceConfig,LocalDeviceConfig>> | false | -
m| annotations | Hazelcast Kubernetes resource annotations m| map[string]string | false | -
m| labels | Hazelcast Kubernetes resource labels m| map[string]string | false | -
m| 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/ m| string | false | -
Expand Down Expand Up @@ -1111,6 +1114,22 @@ m| nestedGroupSearch | NestedGroupSearch enables searching for nested LDAP group

<<Table of Contents,Back to TOC>>

=== LocalDeviceConfig



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| name | Name represents the name of the local device m| string | true | -
m| blockSize | BlockSize defines Device block/sector size in bytes. m| &#42;int32 | false | 4096
m| readIOThreadCount | ReadIOThreadCount is Read IO thread count. m| &#42;int32 | false | 4
m| writeIOThreadCount | WriteIOThreadCount is Write IO thread count. m| &#42;int32 | false | 4
m| pvc | Configuration of PersistenceVolumeClaim. m| &#42;<<PvcConfiguration,PvcConfiguration>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== MCJVMConfiguration

MCJVMConfiguration is a ManagementCenter JVM configuration
Expand Down Expand Up @@ -1274,6 +1293,7 @@ m| inMemoryFormat | InMemoryFormat specifies in which format data will be stored
m| 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. m| []<<EntryListenerConfiguration,EntryListenerConfiguration>> | false | -
m| nearCache | InMemoryFormat specifies near cache configuration for map m| &#42;<<NearCache,NearCache>> | false | -
m| eventJournal | EventJournal specifies event journal configuration of the Map m| &#42;<<EventJournal,EventJournal>> | false | -
m| tieredStore | TieredStore enables the Hazelcast's Tiered-Store feature for the Map m| &#42;<<TieredStore,TieredStore>> | false | -
m| merkleTree | MerkleTree defines the configuration for the Merkle tree data structure. m| &#42;<<MerkleTreeConfig,MerkleTreeConfig>> | false | -
|===

Expand Down Expand Up @@ -1428,7 +1448,7 @@ m| size | Size is maximum size of the Near Cache used for max-size-policy m| uin

<<Table of Contents,Back to TOC>>

=== PersistencePvcConfiguration
=== PvcConfiguration



Expand Down Expand Up @@ -1754,6 +1774,19 @@ m| mutualAuthentication | Mutual authentication configuration. It’s None by de

<<Table of Contents,Back to TOC>>

=== TieredStore



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| memoryCapacity | MemoryCapacity sets Memory tier capacity, i.e., how much main memory should this tier consume at most. m| &#42;resource.Quantity | false | "256M"
m| diskDeviceName | diskDeviceName defines the name of the device for a given disk tier. m| string | false | -
|===

<<Table of Contents,Back to TOC>>

=== Topic

Topic is the Schema for the topics API
Expand Down

0 comments on commit 106c673

Please sign in to comment.