From 05d86bf5b7ad11672ed2d31c7b3da09b4748dd69 Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 2 Sep 2025 13:22:59 +0100 Subject: [PATCH 1/3] DOC-573: add mount PVC topic --- docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/mount-pvc.adoc | 39 ++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docs/modules/ROOT/pages/mount-pvc.adoc 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..f52b5b67 --- /dev/null +++ b/docs/modules/ROOT/pages/mount-pvc.adoc @@ -0,0 +1,39 @@ += 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. + +== 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 +---- + From 7dbe18f02662947f4e64579868cf99e0e64c1f75 Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 2 Sep 2025 14:33:36 +0100 Subject: [PATCH 2/3] DOC-573: added xref --- docs/modules/ROOT/pages/mount-pvc.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/ROOT/pages/mount-pvc.adoc b/docs/modules/ROOT/pages/mount-pvc.adoc index f52b5b67..acf2971a 100644 --- a/docs/modules/ROOT/pages/mount-pvc.adoc +++ b/docs/modules/ROOT/pages/mount-pvc.adoc @@ -10,6 +10,8 @@ You can mount one or more Persistent Volume Claims (PVCs) directly to your Hazel 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]. + == 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`. From 04a71bcda091e2c323d8ae2027be65e1c779d4fe Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Wed, 3 Sep 2025 14:39:36 +0100 Subject: [PATCH 3/3] DOC-573: edits from feedback --- docs/modules/ROOT/pages/mount-pvc.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/mount-pvc.adoc b/docs/modules/ROOT/pages/mount-pvc.adoc index acf2971a..1700e087 100644 --- a/docs/modules/ROOT/pages/mount-pvc.adoc +++ b/docs/modules/ROOT/pages/mount-pvc.adoc @@ -4,17 +4,17 @@ You can mount one or more Persistent Volume Claims (PVCs) directly to your Hazel == How it works -- Define one or more PVCs in the persistenceVolumeClaims section of your Hazelcast custom resource (CR). +- 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 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`. +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] ----