From 106c673d7a9a021c4e741ffbf6aebb5d50db4ad7 Mon Sep 17 00:00:00 2001 From: devOpsHelm Date: Mon, 11 Mar 2024 13:16:09 +0000 Subject: [PATCH] Update API reference doc --- docs/modules/ROOT/pages/api-ref.adoc | 41 +++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index a37e3a4e..3ec6a285 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -96,6 +96,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -124,9 +125,9 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> -* <> * <> * <> +* <> * <> * <> * <> @@ -152,6 +153,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -694,7 +696,7 @@ HazelcastPersistenceConfiguration contains the configuration for Hazelcast Persi m| clusterDataRecoveryPolicy | Configuration of the cluster recovery strategy. m| <> | false | "FullRecoveryOnly" m| startupAction | StartupAction represents the action triggered when the cluster starts to force the cluster startup. m| <> | 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| *<> | false | - +m| pvc | Configuration of PersistenceVolumeClaim. m| *<> | false | - m| restore | Restore configuration m| <> | false | {} |=== @@ -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| *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 | - @@ -735,6 +737,7 @@ m| tls | Hazelcast TLS configuration m| *<> | false | - m| serialization | Hazelcast serialization configuration m| *<> | 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| *<> | false | - +m| localDevices | Hazelcast LocalDevice configuration m| []<> | 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 | - @@ -1111,6 +1114,22 @@ m| nestedGroupSearch | NestedGroupSearch enables searching for nested LDAP group <> +=== 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| *int32 | false | 4096 +m| readIOThreadCount | ReadIOThreadCount is Read IO thread count. m| *int32 | false | 4 +m| writeIOThreadCount | WriteIOThreadCount is Write IO thread count. m| *int32 | false | 4 +m| pvc | Configuration of PersistenceVolumeClaim. m| *<> | false | - +|=== + +<
> + === MCJVMConfiguration MCJVMConfiguration is a ManagementCenter JVM configuration @@ -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| []<> | false | - m| nearCache | InMemoryFormat specifies near cache configuration for map m| *<> | false | - m| eventJournal | EventJournal specifies event journal configuration of the Map m| *<> | false | - +m| tieredStore | TieredStore enables the Hazelcast's Tiered-Store feature for the Map m| *<> | false | - m| merkleTree | MerkleTree defines the configuration for the Merkle tree data structure. m| *<> | false | - |=== @@ -1428,7 +1448,7 @@ m| size | Size is maximum size of the Near Cache used for max-size-policy m| uin <
> -=== PersistencePvcConfiguration +=== PvcConfiguration @@ -1754,6 +1774,19 @@ m| mutualAuthentication | Mutual authentication configuration. It’s None by de <
> +=== 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| *resource.Quantity | false | "256M" +m| diskDeviceName | diskDeviceName defines the name of the device for a given disk tier. m| string | false | - +|=== + +<
> + === Topic Topic is the Schema for the topics API