Add CP Subsystem documentation [CN-1149] (#170)

* add CP Subsystem documentation * Apply suggestions from the code review Co-authored-by: rebekah-lawrence <[email protected]> --------- Co-authored-by: rebekah-lawrence <[email protected]>
hazelcast · Mar 21, 2024 · 1d037e9 · 1d037e9
1 parent 906eb99
commit 1d037e9
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 0 deletions.
diff --git a/docs/modules/ROOT/examples/hazelcast-cp-subsystem-presistence.yaml b/docs/modules/ROOT/examples/hazelcast-cp-subsystem-presistence.yaml
@@ -0,0 +1,14 @@
+apiVersion: hazelcast.com/v1alpha1
+kind: Hazelcast
+metadata:
+  name: hazelcast
+spec:
+  clusterSize: 3
+  repository: 'docker.io/hazelcast/hazelcast-enterprise'
+  licenseKeySecretName: hazelcast-license-key
+  persistence:
+    pvc:
+      accessModes: ["ReadWriteOnce"]
+      requestStorage: 8Gi
+  cpSubsystem:
+    memberCount: 3
diff --git a/docs/modules/ROOT/examples/hazelcast-cp-subsystem.yaml b/docs/modules/ROOT/examples/hazelcast-cp-subsystem.yaml
@@ -0,0 +1,15 @@
+apiVersion: hazelcast.com/v1alpha1
+kind: Hazelcast
+metadata:
+  name: hazelcast
+spec:
+  clusterSize: 3
+  repository: 'docker.io/hazelcast/hazelcast-enterprise'
+  licenseKeySecretName: hazelcast-license-key
+  cpSubsystem:
+    memberCount: 3
+    groupSize: 3
+    sessionTTLSeconds: 30
+    pvc:
+      accessModes: ["ReadWriteOnce"]
+      requestStorage: 8Gi
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -6,6 +6,7 @@
 * xref:scheduling-configuration.adoc[Scheduling Hazelcast Pods]
 * xref:serialization-configuration.adoc[Serialization]
 * xref:scaling-upgrading.adoc[Scaling & Upgrading]
+* xref:cp-subsystem.adoc[Enabling CP Subsystem]
 * Configuring Data Structures
 ** xref:map-configuration.adoc[Map]
 ** xref:multimap-configuration.adoc[MultiMap]

diff --git a/docs/modules/ROOT/pages/cp-subsystem.adoc b/docs/modules/ROOT/pages/cp-subsystem.adoc
@@ -0,0 +1,25 @@
+= Enabling CP Subsystem
+:description: CP Subsystem is a component of a Hazelcast cluster that builds a strongly consistent layer for a set of distributed data structures. As well as network partitions, the CP Subsystem withstands server and client failures.
+
+{description}
+
+See xref:hazelcast:cp-subsystem:cp-subsystem.adoc[CP Subsystem] for more detailed information about the configuration and behavior of CP Subsystem component of Hazelcast.
+
+== Configuring CP Subsystem
+
+To enable CP Subsystem you must configure the `cpSubsystem` section in the Hazelcast custom resource.
+
+.Example of CP Subsystem
+[source,yaml,subs="attributes+"]
+----
+include::ROOT:example$/hazelcast-cp-subsystem.yaml[]
+----
+
+When CP subsystem is enabled, it always enables CP Subsystem Persistence. This means that a PVC must be configured before enabling CP Subsystem.
+When the `pvc` section is configured in `cpSubsystem`, a PVC is created and mounted for the CP Subsystem. If you want to use the same PVC for both xref:backup-restore.adoc[Persistence] and CP Subsytem, configure the Persistence but do not configure `pvc` for the CP Subsystem.
+
+.Example of CP Subsystem with Persistence
+[source,yaml,subs="attributes+"]
+----
+include::ROOT:example$/hazelcast-cp-subsystem-presistence.yaml[]
+----