updates

whylabs · Dec 3, 2024 · 999d9d8 · 999d9d8
1 parent adab9de
commit 999d9d8
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 18 deletions.
diff --git a/charts/guardrails/CHANGELOG.md b/charts/guardrails/CHANGELOG.md
@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning]
 (https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2024-12-02
+
+### Added
+
+- Add caching support, enabled with `cache.enable: true` (default is `true`)
+- HPA support for configuring scaling behavior
+
 ## [0.4.0] - 2024-11-26
 
 ### Changed

diff --git a/charts/guardrails/Chart.yaml b/charts/guardrails/Chart.yaml
@@ -2,6 +2,6 @@ apiVersion: v2
 name: guardrails
 description: A Helm chart for WhyLabs Guardrails
 type: application
-version: 0.4.6
+version: 0.5.0
 appVersion: "2.2.2"
 icon: "https://whylabs.ai/_next/static/images/whylabs-favicon-192c009321aebbb96c19921a170fc880.png"
diff --git a/charts/guardrails/README.md b/charts/guardrails/README.md
@@ -1,6 +1,6 @@
 # guardrails
 
-![Version: 0.4.6](https://img.shields.io/badge/Version-0.4.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.2](https://img.shields.io/badge/AppVersion-2.2.2-informational?style=flat-square)
+![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.2](https://img.shields.io/badge/AppVersion-2.2.2-informational?style=flat-square)
 
 A Helm chart for WhyLabs Guardrails
 
@@ -110,14 +110,14 @@ release_name=""
 # the working directory or --destination path
 helm pull \
   oci://ghcr.io/whylabs/guardrails \
-  --version 0.4.6
+  --version 0.5.0
 
 # Requires the helm-diff plugin to be installed:
 # helm plugin install https://github.com/databus23/helm-diff
 helm diff upgrade \
   --allow-unreleased \
   --namespace "${target_namespace}" \
-  "${release_name}" guardrails-0.4.6.tgz
+  "${release_name}" guardrails-0.5.0.tgz
 ```
 
 After you've installed the repo you can install the chart.
@@ -126,7 +126,7 @@ After you've installed the repo you can install the chart.
 helm upgrade --install \
   --create-namespace \
   --namespace "${target_namespace}" \
-  "${release_name}" guardrails-0.4.6.tgz
+  "${release_name}" guardrails-0.5.0.tgz
 ```
 
 ## Exposing Guardrails Outside Kubernetes
@@ -196,14 +196,22 @@ utilization.
 |-----|------|---------|-------------|
 | affinity | object | `{}` | Affinity settings for `Pod` [scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). If an explicit label selector is not provided for pod affinity or pod anti-affinity one will be created from the pod selector labels. |
 | autoscaling | object | `{"behavior":{"scaleDown":{"policies":[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":30}],"selectPolicy":"Max","stabilizationWindowSeconds":300},"scaleUp":{"policies":[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":50}],"selectPolicy":"Min","stabilizationWindowSeconds":180}},"enabled":false,"maxReplicas":100,"minReplicas":1,"targetCPUUtilizationPercentage":70}` | [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) configuration for the `guardrails` container. |
-| cache.annotations | object | `{}` |  |
-| cache.duration | string | `"1m"` |  |
-| cache.enable | bool | `false` |  |
-| cache.endpoint | string | `"api.whylabsapp.com"` |  |
-| cache.labels | object | `{}` |  |
-| cache.replicaCount | int | `1` |  |
+| autoscaling.behavior | object | `{"scaleDown":{"policies":[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":30}],"selectPolicy":"Max","stabilizationWindowSeconds":300},"scaleUp":{"policies":[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":50}],"selectPolicy":"Min","stabilizationWindowSeconds":180}}` | Configures the scaling behavior of the target in both Up and Downdirections |
+| autoscaling.behavior.scaleDown.policies | list | `[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":30}]` | Policies a list of potential scaling polices which can be used during scaling. At least one policy must be specified. |
+| autoscaling.behavior.scaleDown.selectPolicy | string | `"Max"` | selectPolicy can be `Min` or `Max` and refers to scaling policy to choose when there are multiple policies; `Max` will choose the policy perform the largest scaling adjustment, while `Min` will choose the policy that performs the smallest scaling adjustment. |
+| autoscaling.behavior.scaleDown.stabilizationWindowSeconds | int | `300` | StabilizationWindowSeconds is how many seconds the HPA looks back to determine if a policy is being met. |
+| autoscaling.behavior.scaleUp.policies | list | `[{"periodSeconds":180,"type":"Pods","value":"{{ .Values.replicaCount | int }}"},{"periodSeconds":180,"type":"Percent","value":50}]` | Policies a list of potential scaling polices which can be used during scaling. At least one policy must be specified. |
+| autoscaling.behavior.scaleUp.selectPolicy | string | `"Min"` | selectPolicy can be `Min` or `Max` and refers to scaling policy to choose when there are multiple policies; `Max` will choose the policy perform the largest scaling adjustment, while `Min` will choose the policy that performs the smallest scaling adjustment. |
+| autoscaling.behavior.scaleUp.stabilizationWindowSeconds | int | `180` | StabilizationWindowSeconds is how many seconds the HPA looks back to determine if a policy is being met. |
+| autoscaling.enabled | bool | `false` | Enable or disable HPA (Horizontal Pod Autoscaler). |
+| cache.annotations | object | `{}` | Annotations for the cache. |
+| cache.duration | string | `"1m"` | Duration for cache validity. |
+| cache.enable | bool | `true` | Enable or disable caching. |
+| cache.endpoint | string | `"api.whylabsapp.com"` | Endpoint for the cache service. |
+| cache.labels | object | `{}` | Labels for the cache. |
+| cache.replicaCount | int | `1` | Number of replicas for the cache. |
 | commonLabels | object | `{}` | Labels to add to all chart resources. |
-| env | object | `{}` | [Environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the `guardrails` container. |
+| env | object | `{"TENANCY_MODE":"{{ .Values.tenancyMode | default \"SINGLE\" }}"}` | [Environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the `guardrails` container. |
 | envFrom | list | `[{"secretRef":{"name":"whylabs-guardrails-api-key","optional":true}},{"secretRef":{"name":"whylabs-guardrails-api-secret","optional":true}}]` | Create environment variables from Kubernetes secrets or config maps. |
 | extraVolumeMounts | list | `[]` | Extra [volume mounts](https://kubernetes.io/docs/concepts/storage/volumes/) for the `guardrails` container. |
 | extraVolumes | list | `[]` | Extra [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) for the `Pod`. |
@@ -233,6 +241,7 @@ utilization.
 | serviceAccount.labels | object | `{}` | Labels to add to the service account. |
 | serviceAccount.name | string | `""` | If this is set and `serviceAccount.create` is `true` this will be used for the created `ServiceAccount` name, if set and `serviceAccount.create` is `false` then this will define an existing `ServiceAccount` to use. |
 | startupProbe | object | `{"failureThreshold":20,"httpGet":{"path":"/health","port":8000},"initialDelaySeconds":20,"periodSeconds":10}` | [Readiness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) configuration for the `guardrails` container. Liveness and readiness probes are suppressed until the startup probe succeeds. |
+| tenancyMode | string | `"MULTI"` | tenancyMode for the guardrails service. Must be `SINGLE` or `MULTI`. |
 | tolerations | list | `[]` | Node taints which will be tolerated for `Pod` [scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). |
 
 ----------------------------------------------

diff --git a/...guardrails/templates/configmap-cache.yaml → ...guardrails/templates/configmap-nginx.yaml b/...guardrails/templates/configmap-cache.yaml → ...guardrails/templates/configmap-nginx.yaml
diff --git a/...uardrails/templates/deployment-cache.yaml → ...uardrails/templates/deployment-nginx.yaml b/...uardrails/templates/deployment-cache.yaml → ...uardrails/templates/deployment-nginx.yaml
@@ -19,6 +19,8 @@ spec:
       labels:
         {{- include "guardrails.labels" . | nindent 8 }}
         app: {{ .Release.Name }}-nginx
+        app.kubernetes.io/name: {{ include "guardrails.name" . }}-nginx
+        app.kubernetes.io/instance: {{ .Release.Name }}-nginx
     spec:
       serviceAccountName: {{ include "guardrails.serviceAccountName" . }}
       securityContext:

diff --git a/charts/guardrails/templates/deployment.yaml b/charts/guardrails/templates/deployment.yaml
@@ -24,6 +24,8 @@ spec:
         {{- toYaml . | nindent 8 }}
         {{- end }}
         app: {{ .Release.Name }}
+        app.kubernetes.io/name: {{ include "guardrails.name" . }}
+        app.kubernetes.io/instance: {{ .Release.Name }}
     spec:
       {{- if gt (len .Values.imagePullSecrets) 0 }}
       imagePullSecrets:
@@ -48,7 +50,7 @@ spec:
           env:
             {{- range $key, $value := .Values.env }}
             - name: {{ $key }}
-              value: {{ $value | quote }}
+              value: {{ tpl $value $ }}
             {{- end }}
           {{- end }}
           {{- if .Values.envFrom }}

diff --git a/...s/guardrails/templates/service-cache.yaml → ...s/guardrails/templates/service-nginx.yaml b/...s/guardrails/templates/service-cache.yaml → ...s/guardrails/templates/service-nginx.yaml
diff --git a/charts/guardrails/values.yaml b/charts/guardrails/values.yaml
@@ -1,11 +1,21 @@
 cache:
-  enable: false
+  # -- Enable or disable caching.
+  enable: true
+  # -- Duration for cache validity.
   duration: 1m
+  # -- Number of replicas for the cache.
   replicaCount: 1
+  # -- Endpoint for the cache service.
   endpoint: "api.whylabsapp.com"
+  # -- Annotations for the cache.
   annotations: {}
+  # -- Labels for the cache.
   labels: {}
 
+# -- (string) tenancyMode for the guardrails service.
+# Must be `SINGLE` or `MULTI`.
+tenancyMode: MULTI
+
 # -- Number of replicas for the service.
 replicaCount: 4
 
@@ -35,8 +45,10 @@ fullnameOverride: ""
 commonLabels: {}
 
 # -- [Environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the `guardrails` container.
-env: {}
-  # MY_ENV_VAR: "my env var value"
+env:
+  # Uncomment WHYLABS_API_CACHE_ENDPOINT if .Values.cache.enable is true
+  # WHYLABS_API_CACHE_ENDPOINT: "{{ .Release.Name }}.{{ .Release.Namespace }}.svc.cluster.local"
+  TENANCY_MODE: "{{ .Values.tenancyMode | default \"SINGLE\" }}"
 
 # -- Create environment variables from Kubernetes secrets or config maps.
 envFrom:
@@ -144,25 +156,31 @@ readinessProbe:
 
 # -- [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) configuration for the `guardrails` container.
 autoscaling:
+  # -- Enable or disable HPA (Horizontal Pod Autoscaler).
   enabled: false
   minReplicas: 1
   maxReplicas: 100
+  # -- Configures the scaling behavior of the target in both Up and Downdirections
   behavior:
     scaleUp:
+      # -- Policies a list of potential scaling polices which can be used during scaling. At least one policy must be specified.
       policies:
         - type: Pods
           value: "{{ .Values.replicaCount | int }}"
           periodSeconds: 180
         - type: Percent
           value: 50
           periodSeconds: 180
-      # selectPolicy can be `Min` or `Max` and refers to scaling policy
+      # -- selectPolicy can be `Min` or `Max` and refers to scaling policy
       # to choose when there are multiple policies; `Max` will choose the
       # policy perform the largest scaling adjustment, while `Min` will
       # choose the policy that performs the smallest scaling adjustment.
       selectPolicy: Min
+      # -- StabilizationWindowSeconds is how many seconds the HPA looks back
+      # to determine if a policy is being met.
       stabilizationWindowSeconds: 180
     scaleDown:
+      # -- Policies a list of potential scaling polices which can be used during scaling. At least one policy must be specified.
       policies:
         - type: Pods
           value: "{{ .Values.replicaCount | int }}"
@@ -174,8 +192,12 @@ autoscaling:
           # periodSeconds is the rate at which a policy can be applied;
           # this policy may only be applied once per period.
           periodSeconds: 180
+      # -- selectPolicy can be `Min` or `Max` and refers to scaling policy
+      # to choose when there are multiple policies; `Max` will choose the
+      # policy perform the largest scaling adjustment, while `Min` will
+      # choose the policy that performs the smallest scaling adjustment.
       selectPolicy: Max
-      # stabilizationWindowSeconds is how many seconds the HPA looks back
+      # -- StabilizationWindowSeconds is how many seconds the HPA looks back
       # to determine if a policy is being met.
       stabilizationWindowSeconds: 300
   targetCPUUtilizationPercentage: 70