cdk8s-plus-31 2.5.13 → 2.6.1

package/docs/plus/volume.md

@@ -36,3 +36,49 @@ const redis = pod.addContainer({
 // mount to the redis container.
 redis.mount('/var/lib/redis', data);
 ```
+
+## Using PersistentVolumeClaim Templates with StatefulSets
+
+When working with StatefulSets, you can use PersistentVolumeClaim templates to create stable storage for each pod in the StatefulSet. This allows each pod to have its own storage that persists even if the pod is rescheduled to a different node.
+
+```typescript
+import * as kplus from 'cdk8s-plus-32';
+import { Size } from 'cdk8s';
+
+const dataVolume = Volume.fromName(chart, "pvc-template-data", "data-volume")
+
+// Create a StatefulSet with a PVC template
+const statefulSet = new kplus.StatefulSet(this, 'StatefulSet', {
+  containers: [{
+    image: 'nginx',
+    volumeMounts: [{
+      volume: dataVolume,
+      path: '/data',
+    }, {
+      volume: Volume.fromName(chart, "pvc-template-temp", "temp-volume"),
+      path: '/data',
+    }],
+  }],
+  // Define PVC templates during initialization
+  volumeClaimTemplates: [{
+    name: dataVolume.name,
+    storage: Size.gibibytes(10),
+    accessModes: [kplus.PersistentVolumeAccessMode.READ_WRITE_ONCE],
+    storageClassName: 'standard',  // Optional: Specify the storage class
+  }, {
+    name: 'temp-volume',  // Must match a volume mount name in a container
+    storage: Size.gibibytes(10),
+    accessModes: [kplus.PersistentVolumeAccessMode.READ_WRITE_ONCE],
+    storageClassName: 'standard',  // Optional: Specify the storage class
+  }],
+});
+
+// Or add PVC templates after creation
+statefulSet.addVolumeClaimTemplate({
+  name: 'logs-volume',
+  storage: Size.gibibytes(5),
+  accessModes: [kplus.PersistentVolumeAccessMode.READ_WRITE_ONCE],
+});
+```
+
+Each pod in the StatefulSet will get its own PVC instance based on these templates, with names like `data-volume-my-statefulset-0`, `data-volume-my-statefulset-1`, etc.