Separate readreplica chart

Makefile.d/helm.mk

@@ -70,6 +70,16 @@ charts/vald-helm-operator/README.md: \
 	charts/vald-helm-operator/values.yaml
 	helm-docs
 
+.PHONY: helm/docs/vald-readreplica
+helm/docs/vald-readreplica: charts/vald-readreplica/README.md
+
+# force to rebuild
+.PHONY: charts/vald-readreplica/README.md
+charts/vald-readreplica/README.md: \
+	charts/vald-readreplica/README.md.gotmpl \
+	charts/vald-readreplica/values.yaml
+	helm-docs
+
 .PHONY: helm/schema/vald
 ## generate json schema for Vald Helm Chart
 helm/schema/vald: charts/vald/values.schema.json

charts/vald-helm-operator/templates/clusterrole.yaml

@@ -187,5 +187,25 @@ rules:
       - patch
       - update
       - watch
-
+  - apiGroups:
+      - snapshot.storage.k8s.io
+    resources:
+      - volumesnapshots
+    verbs:
+      - get
+      - list
+      - watch
+      - create
+      - delete
+      - patch
+  - apiGroups:
+      - ""
+    resources:
+      - persistentvolumeclaims
+    verbs:
+      - get
+      - list
+      - watch
+      - create
+      - delete
 {{- end }}

charts/vald-readreplica/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/vald-readreplica/Chart.yaml

@@ -0,0 +1,46 @@
+#
+# Copyright (C) 2019-2024 vdaas.org vald team <[email protected]>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# You may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+apiVersion: v2
+name: vald-readreplica
+version: v1.7.10
+description: A helm chart for readreplica add-on
+type: application
+keywords:
+  - Vald
+  - NGT
+  - vector
+  - search
+  - approximate-nearest-neighbor-search
+  - nearest-neighbor-search
+  - vector-search-engine
+  - similarity-search
+  - image-search
+  - Kubernetes
+  - k8s
+  - AI
+  - artificial-intelligence
+home: https://vald.vdaas.org
+icon: https://raw.githubusercontent.com/vdaas/vald/main/assets/image/svg/symbol.svg
+sources:
+  - https://github.com/vdaas/vald
+maintainers:
+  - name: kpango
+    email: [email protected]
+  - name: ykadowak
+    email: [email protected]
+  - name: kmrmt
+    email: [email protected]

charts/vald-readreplica/README.md

@@ -0,0 +1,33 @@
+# Vald Read Replica
+
+**THIS CHART IS A WORK IN PROGRESS AND IS NOT YET FUNCTIONAL**
+
+This is a Helm chart to install Vald readreplica components.
+
+Current chart version is `v1.7.10`
+
+## Install
+
+Add Vald Helm repository
+
+    $ helm repo add vald https://vald.vdaas.org/charts
+
+Install Vald cluster first.
+
+    $ helm install vald vald/vald
+
+Run the following command to install the chart,
+
+    $ helm install vald-readreplica vald/vald-readreplica
+
+## Configuration
+
+### Overview
+
+[`values.yaml`](https://github.com/vdaas/vald/blob/main/charts/vald-readreplica/values.yaml)
+of this chart is a symbolic link to the [`values.yaml`](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) of the main vald chart
+because all the configurations must be synced with the main vald cluster.
+So please look at the document of the main vald chart for configurations.
+
+When you deploy this chart with custom `values.yaml` on install, you should deploy the vald
+cluster with the same `values.yaml` as well.

charts/vald-readreplica/README.md.gotmpl

@@ -0,0 +1,34 @@
+# Vald Read Replica
+
+**THIS CHART IS A WORK IN PROGRESS AND IS NOT YET FUNCTIONAL**
+
+This is a Helm chart to install Vald readreplica components.
+
+Current chart version is `{{ template "chart.version" . }}`
+
+## Install
+
+Add Vald Helm repository
+
+    $ helm repo add vald https://vald.vdaas.org/charts
+
+Install Vald cluster first.
+
+    $ helm install vald vald/vald
+
+Run the following command to install the chart,
+
+    $ helm install vald-readreplica vald/vald-readreplica
+
+
+## Configuration
+
+### Overview
+
+[`values.yaml`](https://github.com/vdaas/vald/blob/main/charts/vald-readreplica/values.yaml)
+of this chart is a symbolic link to the [`values.yaml`](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) of the main vald chart
+because all the configurations must be synced with the main vald cluster.
+So please look at the document of the main vald chart for configurations.
+
+When you deploy this chart with custom `values.yaml` on install, you should deploy the vald
+cluster with the same `values.yaml` as well.

charts/vald-readreplica/templates/NOTES.txt

@@ -0,0 +1,4 @@
+Release {{ .Release.Name }} is created.
+
+Readreplica feature is intended to be used with the main vald chart.
+Please look at the document of the main chart for more details.

charts/vald-readreplica/templates/_helpers.tpl

@@ -0,0 +1 @@
+../../vald/templates/_helpers.tpl

charts/vald/templates/agent/readreplica/deployment.yaml → charts/vald-readreplica/templates/deployment.yaml

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+{{- $values := .Values -}}
 {{- $agent := .Values.agent -}}
 {{- $readreplica := .Values.agent.readreplica -}}
 {{- $defaults := .Values.defaults -}}
@@ -63,7 +64,7 @@ spec:
       {{- if $agent.initContainers }}
       initContainers:
         {{- if $agent.initContainers }}
-        {{- $initContainers := dict "initContainers" $agent.initContainers "Values" .Values "namespace" .Release.Namespace -}}
+        {{- $initContainers := dict "initContainers" $agent.initContainers "Values" $values "namespace" $release.Namespace -}}
         {{- include "vald.initContainers" $initContainers | trim | nindent 8 }}
         {{- end }}
       {{- end }}
@@ -135,6 +136,9 @@ spec:
         - name: {{ $readreplica.volume_name }}
           persistentVolumeClaim:
             claimName: {{ $readreplica.name }}-pvc-{{ $id }}
+        {{- if $agent.volumes }}
+        {{- toYaml $agent.volumes | nindent 8 }}
+        {{- end }}
       {{- if $agent.nodeName }}
       nodeName: {{ $agent.nodeName }}
       {{- end }}

charts/vald/templates/agent/readreplica/pvc.yaml → charts/vald-readreplica/templates/pvc.yaml

@@ -30,10 +30,11 @@ spec:
     - ReadOnlyMany
   resources:
     requests:
-      storage: 1Gi
+      storage: {{ $agent.persistentVolume.size }}
   dataSource:
     name: {{ $readreplica.name }}-snapshot-{{ $id }}
     kind: VolumeSnapshot
     apiGroup: snapshot.storage.k8s.io
+  storageClassName: {{ $agent.persistentVolume.storageClass }}
 {{- end }}
 {{- end }}

charts/vald/templates/agent/readreplica/snapshot.yaml → charts/vald-readreplica/templates/snapshot.yaml

@@ -25,7 +25,7 @@ metadata:
     {{ $readreplica.label_key }}: "{{ $id }}"
   name: {{ $readreplica.name }}-snapshot-{{ $id }}
 spec:
-  volumeSnapshotClassName: csi-hostpath-snapclass
+  volumeSnapshotClassName: {{ $readreplica.snapshot_classname }}
   source:
     # Specify the PVCs for which you want to take snapshots
     persistentVolumeClaimName: {{ $agent.name }}-pvc-{{ $agent.name }}-{{ $id }}

charts/vald/templates/agent/readreplica/svc.yaml → charts/vald-readreplica/templates/svc.yaml

@@ -50,6 +50,7 @@ spec:
     app: {{ $readreplica.name }}-{{ $id }}
     app.kubernetes.io/name: {{ $valdname }}
   type: ClusterIP
+  clusterIP: None
   {{- if $agent.externalTrafficPolicy }}
   externalTrafficPolicy: {{ $agent.externalTrafficPolicy }}
   {{- end }}

charts/vald-readreplica/values.schema.json

@@ -0,0 +1 @@
+../vald/values.schema.json