diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 5224689c..952e6e50 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -80,6 +80,7 @@ ** xref:hazelcast-parameters.adoc[System properties] ** xref:custom-config.adoc[Custom configuration] ** xref:jvm-parameters.adoc[JVM parameters] +** xref:mount-pvc.adoc[Mount PVC on a cluster] * Management Center ** xref:management-center-clusters.adoc[Hazelcast clusters] diff --git a/docs/modules/ROOT/pages/mount-pvc.adoc b/docs/modules/ROOT/pages/mount-pvc.adoc new file mode 100644 index 00000000..1700e087 --- /dev/null +++ b/docs/modules/ROOT/pages/mount-pvc.adoc @@ -0,0 +1,41 @@ += Mount Persistent Volume Claims for Hazelcast clusters + +You can mount one or more Persistent Volume Claims (PVCs) directly to your Hazelcast cluster. Each PVC defined in the `persistenceVolumeClaims` section will be mounted under the path `/data/`. This approach allows you to use PVCs for any Hazelcast feature that requires persistent storage, simply by referencing the PVC by its name. + +== How it works + +- Define one or more PVCs in the `persistenceVolumeClaims` section of your Hazelcast custom resource (CR). +- Each PVC will be mounted at `/data/`, where `` is the value of the name field in your PVC configuration. +- Features that require persistent storage (such as diagnostics, persistence, or the CP Subsystem) can reference the PVC by specifying its name, using the appropriate field (e.g., `pvcName`). + +This mechanism decouples the PVC definition from feature configuration, making it easier to manage and reuse storage across different Hazelcast features. + +For more information, see the xref:api-ref.adoc#[API]. For a tutorial on enabling persistence, see link:https://docs.hazelcast.com/hazelcast/latest/getting-started/persistence[Persist Map Entries on Disk] + +== Example: Configure diagnostics with a named PVC + +Below is an example configuration that shows how to define a PVC and use it for diagnostics logging by specifying the `pvcName` field. The diagnostics logs will be stored in the PVC mounted at `/data/diagnostics-pvc-volume`. + +[source,yaml] +---- +apiVersion: hazelcast.com/v1alpha1 +kind: Hazelcast +metadata: + name: hazelcast +spec: + clusterSize: 3 + repository: 'docker.io/hazelcast/hazelcast-enterprise' + version: 5.6.0-SNAPSHOT + licenseKeySecretName: hazelcast-license-key + diagnostics: + outputType: STDOUT + maxRolledFileCount: 10 + maxRolledFileSize: '50M' + pvcName: diagnostics-pvc-volume + persistenceVolumeClaims: + - accessModes: [ "ReadWriteOnce" ] + requestStorage: 1Gi + storageClassName: "standard" + name: diagnostics-pvc-volume +---- +