feat: Modify caraml components to accept annotations

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
   - repo: https://github.com/norwoodj/helm-docs
     rev: v1.11.0
     hooks:
-      - id: helm-docs
+      - id: helm-docs-built
   - repo: https://github.com/gruntwork-io/pre-commit
     rev: v0.1.22
     hooks:

charts/merlin/Chart.yaml

@@ -33,4 +33,4 @@ maintainers:
 - email: [email protected]
   name: caraml-dev
 name: merlin
-version: 0.13.5
+version: 0.13.6

charts/merlin/README.md

@@ -1,7 +1,7 @@
 # merlin
 
 ---
-![Version: 0.13.5](https://img.shields.io/badge/Version-0.13.5-informational?style=flat-square)
+![Version: 0.13.6](https://img.shields.io/badge/Version-0.13.6-informational?style=flat-square)
 ![AppVersion: v0.36.0](https://img.shields.io/badge/AppVersion-v0.36.0-informational?style=flat-square)
 
 Kubernetes-friendly ML model management, deployment, and serving.
@@ -162,6 +162,7 @@ The following table lists the configurable parameters of the Merlin chart and th
 | config.StandardTransformerConfig.ModelServerConnCount | int | `10` |  |
 | config.StandardTransformerConfig.SimulationFeast.FeastBigtableURL | string | `"online-serving-bt.feast.dev"` |  |
 | config.StandardTransformerConfig.SimulationFeast.FeastRedisURL | string | `"online-serving-redis.feast.dev"` |  |
+| deployment.annotations | object | `{}` |  |
 | deployment.extraArgs | list | `[]` | List of string containing additional Merlin API server arguments. For example, multiple "-config" can be specified to use multiple config files |
 | deployment.extraContainers | list | `[]` | List of sidecar containers to attach to the Pod. For example, you can attach sidecar container that forward logs or dynamically update some configuration files. |
 | deployment.extraEnvs | list | `[]` | List of extra environment variables to add to Merlin API server container |

charts/merlin/templates/merlin-deployment.yaml

@@ -14,6 +14,10 @@ metadata:
     {{- if .Values.deployment.labels }}
       {{- toYaml .Values.deployment.labels | nindent 4 }}
     {{- end }}
+  {{- if .Values.deployment.annotations }}
+  annotations:
+  {{ toYaml .Values.deployment.annotations | indent 2 }}
+  {{- end }}
 spec:
   replicas: {{ .Values.deployment.replicaCount }}
   selector:

charts/merlin/values.yaml

@@ -20,6 +20,9 @@ deployment:
   replicaCount: "2"
   # Additional labels to apply to the deployment
   labels: {}
+
+  # Additional annotations to apply
+  annotations: {}
   # Additional labels to apply to the merlin pods
   podLabels: {}
   resources:

charts/mlp/Chart.yaml

@@ -17,4 +17,4 @@ maintainers:
 - email: [email protected]
   name: caraml-dev
 name: mlp
-version: 0.6.3
+version: 0.6.4

charts/mlp/README.md

@@ -1,6 +1,6 @@
 # mlp
 
-![Version: 0.6.3](https://img.shields.io/badge/Version-0.6.3-informational?style=flat-square) ![AppVersion: v1.10.0](https://img.shields.io/badge/AppVersion-v1.10.0-informational?style=flat-square)
+![Version: 0.6.4](https://img.shields.io/badge/Version-0.6.4-informational?style=flat-square) ![AppVersion: v1.10.0](https://img.shields.io/badge/AppVersion-v1.10.0-informational?style=flat-square)
 
 MLP API
 
@@ -40,6 +40,7 @@ MLP API
 | config.streams | object | `{}` | Streams list |
 | config.ui.clockworkUIHomepage | string | `"http://clockwork.dev"` |  |
 | config.ui.kubeflowUIHomepage | string | `"http://kubeflow.org"` |  |
+| deployment.annotations | object | `{}` | Annotations |
 | deployment.extraLabels | object | `{}` | Additional labels to apply on the deployment |
 | deployment.image | object | `{"pullPolicy":"IfNotPresent","registry":"ghcr.io","repository":"caraml-dev/mlp","tag":"v1.10.1"}` | mlp image related configs |
 | deployment.livenessProbe.path | string | `"/v1/internal/live"` |  |

charts/mlp/templates/deployment.yaml

@@ -8,6 +8,10 @@ metadata:
     {{- with .Values.deployment.extraLabels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
+  {{- if .Values.deployment.annotations }}
+  annotations:
+  {{ toYaml .Values.deployment.annotations | indent 2 }}
+  {{- end }}
 spec:
   replicas: {{ .Values.deployment.replicaCount }}
   selector:

charts/mlp/values.yaml

@@ -36,6 +36,9 @@ deployment:
   # -- Additional labels to apply on the deployment
   extraLabels: {}
 
+  # -- Annotations
+  annotations: {}
+
 service:
   externalPort: 8080
   internalPort: 8080

charts/turing/Chart.yaml

@@ -22,4 +22,4 @@ maintainers:
 - email: [email protected]
   name: caraml-dev
 name: turing
-version: 0.3.6
+version: 0.3.7

charts/turing/README.md

@@ -1,7 +1,7 @@
 # turing
 
 ---
-![Version: 0.3.6](https://img.shields.io/badge/Version-0.3.6-informational?style=flat-square)
+![Version: 0.3.7](https://img.shields.io/badge/Version-0.3.7-informational?style=flat-square)
 ![AppVersion: v1.16.0](https://img.shields.io/badge/AppVersion-v1.16.0-informational?style=flat-square)
 
 Kubernetes-friendly multi-model orchestration and experimentation system.
@@ -70,6 +70,7 @@ The following table lists the configurable parameters of the Turing chart and th
 | clusterConfig.environmentConfigPath | string | `"environments.yaml"` | environmentConfigPath is a path to a file that contains environmentConfigs. See api/environments-dev.yaml for example contents |
 | clusterConfig.useInClusterConfig | bool | `false` | Configuration to tell Turing API how it should authenticate with deployment k8s cluster By default, Turing API expects to use a remote k8s cluster for deployment and to do so, it requires cluster access configurations to be configured as part of values.yaml |
 | config | object | computed value | Turing API server configuration. Please refer to https://github.com/caraml-dev/turing/blob/main/api/turing/config/example.yaml for the detailed explanation on Turing API config options |
+| deployment.annotations | object | `{}` |  |
 | deployment.extraArgs | list | `[]` | List of string containing additional Turing API server arguments. For example, multiple "-config" can be specified to use multiple config files |
 | deployment.extraContainers | list | `[]` | List of sidecar containers to attach to the Pod. For example, you can attach sidecar container that forward logs or dynamically update some configuration files. |
 | deployment.extraEnvs | list | `[]` | List of extra environment variables to add to Turing API server container |

charts/turing/templates/turing-deployment.yaml

@@ -5,6 +5,10 @@ metadata:
   namespace: {{ .Release.Namespace }}
   labels:
     {{- include "turing.labels" . | nindent 4 }}
+  {{- if .Values.deployment.annotations }}
+  annotations:
+  {{ toYaml .Values.deployment.annotations | indent 2 }}
+  {{- end }}
 spec:
   replicas: {{ .Values.deployment.replicaCount }}
   selector:

charts/turing/values.yaml

@@ -17,6 +17,7 @@ deployment:
     # -- Docker image tag for Turing image
     tag: ""
   labels: {}
+  annotations: {}
   # -- Resources requests and limits for Turing API. This should be set
   # according to your cluster capacity and service level objectives.
   # Reference: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

charts/xp-management/Chart.yaml

@@ -18,4 +18,4 @@ maintainers:
 - email: [email protected]
   name: caraml-dev
 name: xp-management
-version: 0.2.9
+version: 0.2.10

charts/xp-management/README.md

@@ -1,7 +1,7 @@
 # xp-management
 
 ---
-![Version: 0.2.9](https://img.shields.io/badge/Version-0.2.9-informational?style=flat-square)
+![Version: 0.2.10](https://img.shields.io/badge/Version-0.2.10-informational?style=flat-square)
 ![AppVersion: 0.12.1](https://img.shields.io/badge/AppVersion-0.12.1-informational?style=flat-square)
 
 Management service - A part of XP system that is used to configure experiments

charts/xp-management/templates/deployment.yaml

@@ -7,6 +7,10 @@ metadata:
     {{- with .Values.deployment.labels }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
+  {{- if .Values.deployment.annotations }}
+  annotations:
+  {{ toYaml .Values.deployment.annotations | indent 2 }}
+  {{- end }}
 spec:
   replicas: {{ .Values.deployment.replicaCount }}
   selector:

charts/xp-treatment/Chart.yaml

@@ -15,4 +15,4 @@ maintainers:
 - email: [email protected]
   name: caraml-dev
 name: xp-treatment
-version: 0.1.25
+version: 0.1.26

charts/xp-treatment/README.md

@@ -1,7 +1,7 @@
 # xp-treatment
 
 ---
-![Version: 0.1.25](https://img.shields.io/badge/Version-0.1.25-informational?style=flat-square)
+![Version: 0.1.26](https://img.shields.io/badge/Version-0.1.26-informational?style=flat-square)
 ![AppVersion: 0.12.1](https://img.shields.io/badge/AppVersion-0.12.1-informational?style=flat-square)
 
 Treatment service - A part of XP system that is used to obtain the treatment configuration from active experiments

charts/xp-treatment/templates/deployment.yaml

@@ -4,6 +4,10 @@ metadata:
   name: {{ include "treatment-svc.fullname" . }}
   labels:
     {{- include "treatment-svc.labels" . | nindent 4 }}
+  {{- if .Values.deployment.annotations }}
+  annotations:
+  {{ toYaml .Values.deployment.annotations | indent 2 }}
+  {{- end }}
 spec:
   {{- if not .Values.deployment.autoscaling.enabled }}
   replicas: {{ .Values.deployment.replicaCount }}