diff --git a/.gitignore b/.gitignore index 536c6b47d..6ceb03659 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,6 @@ charts/**/*.lock PRIVATEKEY PUBLICKEY .cursorindexingignore -.specstory/ \ No newline at end of file +.specstory/ + +.claude \ No newline at end of file diff --git a/charts/sn-platform-slim/values.yaml b/charts/sn-platform-slim/values.yaml index 8ffd58964..cff7e6cb7 100644 --- a/charts/sn-platform-slim/values.yaml +++ b/charts/sn-platform-slim/values.yaml @@ -955,7 +955,9 @@ bookkeeper: # parameters: # key1: "value1" # key2: "value2" - # metadata to add onto PVCs for journal storage + # Add custom annotations and labels to PVCs. + # Currently only BookKeeper PVCs support this feature. + # See docs/pulsar/pvc-metadata.md for more details. # metadata: # annotations: # example.com/annotation-key: "annotation-value" @@ -990,7 +992,9 @@ bookkeeper: # parameters: # key1: "value1" # key2: "value2" - # metadata to add onto PVCs for ledgers storage + # Add custom annotations and labels to PVCs. + # Currently only BookKeeper PVCs support this feature. + # See docs/pulsar/pvc-metadata.md for more details. # metadata: # annotations: # example.com/annotation-key: "annotation-value" diff --git a/charts/sn-platform/values.yaml b/charts/sn-platform/values.yaml index dec55a308..fe8cf09bf 100644 --- a/charts/sn-platform/values.yaml +++ b/charts/sn-platform/values.yaml @@ -1030,7 +1030,9 @@ bookkeeper: # parameters: # key1: "value1" # key2: "value2" - # metadata to add onto PVCs for journal storage + # Add custom annotations and labels to PVCs. + # Currently only BookKeeper PVCs support this feature. + # See docs/pulsar/pvc-metadata.md for more details. # metadata: # annotations: # example.com/annotation-key: "annotation-value" @@ -1065,7 +1067,9 @@ bookkeeper: # parameters: # key1: "value1" # key2: "value2" - # metadata to add onto PVCs for ledgers storage + # Add custom annotations and labels to PVCs. + # Currently only BookKeeper PVCs support this feature. + # See docs/pulsar/pvc-metadata.md for more details. # metadata: # annotations: # example.com/annotation-key: "annotation-value" diff --git a/docs/pulsar/pvc-metadata.md b/docs/pulsar/pvc-metadata.md new file mode 100644 index 000000000..48fe6d76b --- /dev/null +++ b/docs/pulsar/pvc-metadata.md @@ -0,0 +1,48 @@ +# PVC Metadata Configuration + +You can add custom annotations and labels to PersistentVolumeClaim (PVC) resources. Currently, only BookKeeper PVCs support this feature. + +## BookKeeper PVC Metadata + +BookKeeper uses two types of PVCs: `journal` and `ledgers`. You can configure metadata for each separately. + +Example: + +```yaml +bookkeeper: + volumes: + journal: + metadata: + annotations: + example.com/annotation-key: "annotation-value" + labels: + example.com/label-key: "label-value" + ledgers: + metadata: + annotations: + example.com/annotation-key: "annotation-value" + labels: + example.com/label-key: "label-value" +``` + + +The configured annotations and labels will be added to the PVC resources created by the BookKeeperCluster CR. + +Example: + +```yaml +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: journal-0 + annotations: + example.com/annotation-key: "annotation-value" + labels: + example.com/label-key: "label-value" +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 10Gi +```