Skip to content

Commit

Permalink
Update API reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
devOpsHelm committed Mar 26, 2024
1 parent c1d69cb commit e51bbd2
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions docs/modules/ROOT/pages/api-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<NearCache,NearCache>>
* <<NearCacheEviction,NearCacheEviction>>
* <<NodeState,NodeState>>
* <<PVCNamePrefix,PVCNamePrefix>>
* <<PersistenceStartupAction,PersistenceStartupAction>>
* <<Phase,Phase>>
* <<PvcConfiguration,PvcConfiguration>>
Expand All @@ -143,6 +144,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<ResourceKind,ResourceKind>>
* <<ResourceSpec,ResourceSpec>>
* <<RestoreConfiguration,RestoreConfiguration>>
* <<RestoreFromLocalConfiguration,RestoreFromLocalConfiguration>>
* <<RestoreState,RestoreState>>
* <<RestoreStatus,RestoreStatus>>
* <<SQL,SQL>>
Expand Down Expand Up @@ -210,7 +212,7 @@ m| wan | &#160; m| []<<WANConfig,WANConfig>> | 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| &#42;https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | -
|===

Expand Down Expand Up @@ -719,6 +721,12 @@ m| dataRecoveryTimeout | DataRecoveryTimeout is timeout for each step of data re
m| pvc | Configuration of PersistenceVolumeClaim. m| &#42;<<PvcConfiguration,PvcConfiguration>> | false | -
m| restore | Restore configuration m| <<RestoreConfiguration,RestoreConfiguration>> | 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 | -
|===

<<Table of Contents,Back to TOC>>

Expand All @@ -740,7 +748,7 @@ m| clusterName | Name of the Hazelcast cluster. m| string | false | "dev"
m| scheduling | Scheduling details m| &#42;<<SchedulingConfiguration,SchedulingConfiguration>> | false | -
m| resources | Compute Resources required by the Hazelcast container. m| &#42;https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | -
m| persistence | Persistence configuration m| &#42;<<HazelcastPersistenceConfiguration,HazelcastPersistenceConfiguration>> | false | -
m| agent | B&R Agent configurations m| <<AgentConfiguration,AgentConfiguration>> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.23"}
m| agent | B&R Agent configurations m| <<AgentConfiguration,AgentConfiguration>> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.24"}
m| jet | Jet Engine configuration m| &#42;<<JetEngineConfiguration,JetEngineConfiguration>> | false | {enabled: true, resourceUploadEnabled: false}
m| userCodeDeployment | User Codes to Download into CLASSPATH m| &#42;<<UserCodeDeploymentConfig,UserCodeDeploymentConfig>> | false | -
m| executorServices | Java Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/executor-service m| []<<ExecutorServiceConfiguration,ExecutorServiceConfiguration>> | false | -
Expand Down Expand Up @@ -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| &#42;<<BucketConfiguration,BucketConfiguration>> | 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| &#42;<<RestoreFromLocalConfiguration,RestoreFromLocalConfiguration>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== RestoreFromLocalConfiguration



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| pvcNamePrefix | PVC name prefix used in existing PVCs m| <<PVCNamePrefix,PVCNamePrefix>> | 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 | -
|===

<<Table of Contents,Back to TOC>>
Expand Down Expand Up @@ -2453,6 +2477,19 @@ m| "STARTING" | &#160;

<<Table of Contents,Back to TOC>>

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

<<Table of Contents,Back to TOC>>

=== PersistenceStartupAction

PersistenceStartupAction represents the action triggered on the cluster startup to force the cluster startup.
Expand Down

0 comments on commit e51bbd2

Please sign in to comment.