From e51bbd291ca12f93206b6f33c5f2756ed63a6a44 Mon Sep 17 00:00:00 2001 From: devOpsHelm Date: Tue, 26 Mar 2024 14:48:33 +0000 Subject: [PATCH] Update API reference doc --- docs/modules/ROOT/pages/api-ref.adoc | 41 ++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index 063ad16e..23ed85dd 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -126,6 +126,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -143,6 +144,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -210,7 +212,7 @@ m| wan |   m| []<> | false | - |=== | Field | Description | Type | Required | Default m| repository | Repository to pull Hazelcast Platform Operator Agent(https://github.com/hazelcast/platform-operator-agent) m| string | false | "docker.io/hazelcast/platform-operator-agent" -m| version | Version of Hazelcast Platform Operator Agent. m| string | false | "0.1.23" +m| version | Version of Hazelcast Platform Operator Agent. m| string | false | "0.1.24" m| resources | Compute Resources required by the Agent container. m| *https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | - |=== @@ -719,6 +721,12 @@ m| dataRecoveryTimeout | DataRecoveryTimeout is timeout for each step of data re m| pvc | Configuration of PersistenceVolumeClaim. m| *<> | false | - m| restore | Restore configuration m| <> | false | {} |=== +==== Deprecated +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| baseDir | BaseDir is deprecated. Use restore.localConfig to restore from a local backup. m| string | false | - +|=== <> @@ -740,7 +748,7 @@ m| clusterName | Name of the Hazelcast cluster. m| string | false | "dev" m| scheduling | Scheduling details m| *<> | false | - m| resources | Compute Resources required by the Hazelcast container. m| *https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | - m| persistence | Persistence configuration m| *<> | false | - -m| agent | B&R Agent configurations m| <> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.23"} +m| agent | B&R Agent configurations m| <> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.24"} m| jet | Jet Engine configuration m| *<> | false | {enabled: true, resourceUploadEnabled: false} m| userCodeDeployment | User Codes to Download into CLASSPATH m| *<> | false | - m| executorServices | Java Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/executor-service m| []<> | false | - @@ -1647,6 +1655,22 @@ RestoreConfiguration contains the configuration for Restore operation | Field | Description | Type | Required | Default m| bucketConfig | Bucket Configuration from which the backup will be downloaded. m| *<> | false | - m| hotBackupResourceName | Name of the HotBackup resource from which backup will be fetched. m| string | false | - +m| localConfig | Configuration to restore from local backup m| *<> | false | - +|=== + +<
> + +=== RestoreFromLocalConfiguration + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| pvcNamePrefix | PVC name prefix used in existing PVCs m| <> | false | "persistence" +m| baseDir | Persistence base directory m| string | false | - +m| backupDir | Local backup base directory m| string | false | - +m| backupFolder | Backup directory m| string | false | - |=== <
> @@ -2453,6 +2477,19 @@ m| "STARTING" |   <
> +=== PVCNamePrefix + +PVCNamePrefix specifies the prefix of existing PVCs + +[cols="5,10"options="header"] +|=== +| Value | Description +m| "persistence" | Persistence format is persistence. +m| "hot-restart-persistence" | HotRestartPersistence format is hot-restart-persistence. +|=== + +<
> + === PersistenceStartupAction PersistenceStartupAction represents the action triggered on the cluster startup to force the cluster startup.