Merge pull request #23 from whylabs/dev/aberg/whylogs-chart-#86b020jvv

dev/aberg/whylogs chart #86b020jvv

.github/workflows/main.yaml

@@ -24,30 +24,16 @@ jobs:
         with:
           version: v3.14.0
 
-      # - name: Output Template
-      #   if: github.event_name == 'pull_request'
-      #   run: |
-      #     changed_files=($(git diff --name-only mainline...${{ github.head_ref }} | grep '^charts/' | cut -d'/' -f1,2 | uniq))
-
-      #     for chart in "${changed_files[@]}"
-      #     do
-      #       if [ -d "${chart}" ]; then
-      #         (
-      #           cd "${chart}"
-      #           echo "Generating template for ${chart}"
-
-      #           helm template \
-      #             --namespace "${chart}" \
-      #             "${chart}" .
-      #         )
-      #       fi
-      #     done
-
-      - name: Package Helm Chart
+      - name: Package All Helm Charts
         if: github.event_name == 'push'
-        working-directory: ${{ github.workspace }}
+        working-directory: ${{ github.workspace }}/charts
         run: |
-          helm package charts/langkit
+          for dir in */ ; do
+            if [ -f "$dir/Chart.yaml" ]; then
+              helm package "$dir"
+            fi
+          done
+        shell: bash
 
       - name: Login to GHCR
         if: github.event_name == 'push'
@@ -56,10 +42,15 @@ jobs:
             -u ${{ github.repository_owner }} \
             --password-stdin < <(echo "${{ secrets.GITHUB_TOKEN }}")
 
-      - name: Publish Helm Chart to GHCR
+      - name: Publish Helm Charts to GHCR
         if: github.event_name == 'push'
+        working-directory: ${{ github.workspace }}/charts
         run: |
-          chart_version=$(grep 'version:' ./charts/langkit/Chart.yaml | tail -n1 | awk '{ print $2}')
-          ghcr_chart="ghcr.io/${{ github.repository_owner }}/${{ github.repository }}:${chart_version}"
-          helm push "langkit-${chart_version}".tgz oci://ghcr.io/${{ github.repository_owner }}      
+          for chart in *.tgz ; do
+            chart_name=$(basename "$chart" .tgz)
+            chart_version=$(echo "$chart_name" | sed 's/.*-//')
+            ghcr_chart="ghcr.io/${{ github.repository_owner }}/${{ github.repository }}/${chart_name}:${chart_version}"
+            helm push "$chart" oci://ghcr.io/${{ github.repository_owner }}      
+          done
+        shell: bash   
 

charts/whylogs/.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/whylogs/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: whylogs
+description: A Helm chart for WhyLab's WhyLogs
+type: application
+version: 0.1.0
+appVersion: "1.0.14"

charts/whylogs/README.md

@@ -0,0 +1,59 @@
+# WhyLogs Helm Chart
+
+See [WhyLogs Documentation](https://docs.whylabs.ai/docs/integrations-whylogs-container/)
+for more information
+
+> :warning: Review the [documentation on using WhyLab's Helm charts](../../README.md#how-to-use-whylabs-helm-repository)
+
+## Prerequisites
+
+### Secrets
+
+The following configured secrets must exist in the cluster prior to deploying
+the WhyLogs Helm chart.
+
+Create a [WhyLabs API Key](https://docs.whylabs.ai/docs/whylabs-capabilities/#access-token-management)
+which must be stored in a `whylabs-api-key` Kubernetes secret, described below.
+
+
+```shell
+whylabs_api_key=""
+whylogs_password=""
+namespace="default"
+
+kubectl create secret generic whylabs-api-key \
+  --namespace "${namespace}" \
+  --from-literal=api-key="${whylabs_api_key}"
+
+kubectl create secret generic whylogs-container-password \
+  --namespace "${namespace}" \
+  --from-literal=passwordy="${whylogs_password}"
+```
+
+## Deployment
+
+### Diff
+View the difference between the current state and desired state.
+
+```shell
+# Requires the helm-diff plugin to be installed:
+# helm plugin install https://github.com/databus23/helm-diff
+helm diff upgrade \
+  --allow-unreleased \
+  whylogs "whylogs-${chart_version}.tgz"
+```
+
+### Install/Update
+```shell
+helm upgrade --install \
+  --create-namespace \
+  --namespace "${namespace}" \
+  whylogs "whylogs-${chart_version}.tgz"
+```
+
+### Uninstall
+```shell
+helm uninstall \
+  --namespace "${namespace}" \
+  whylogs "whylogs-${chart_version}.tgz"
+```

charts/whylogs/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "whylogs.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "whylogs.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "whylogs.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "whylogs.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

charts/whylogs/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "whylogs.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "whylogs.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "whylogs.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "whylogs.labels" -}}
+helm.sh/chart: {{ include "whylogs.chart" . }}
+{{ include "whylogs.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "whylogs.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "whylogs.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "whylogs.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "whylogs.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

charts/whylogs/templates/deployment.yaml

@@ -0,0 +1,79 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "whylogs.fullname" . }}
+  labels:
+    {{- include "whylogs.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "whylogs.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "whylogs.labels" . | nindent 8 }}
+        {{- with .Values.podLabels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "whylogs.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          {{- if .Values.env }}
+          env:
+            {{ range $key, $value := .Values.env }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end }}
+          {{- end }}
+          {{- if .Values.envFromSecrets }}
+          envFrom:
+            {{- toYaml .Values.envFromSecrets | nindent 12 }}
+          {{- end }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.service.port }}
+              protocol: TCP
+          livenessProbe:
+            {{- toYaml .Values.livenessProbe | nindent 12 }}
+          readinessProbe:
+            {{- toYaml .Values.readinessProbe | nindent 12 }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          {{- with .Values.volumeMounts }}
+          volumeMounts:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+      {{- with .Values.volumes }}
+      volumes:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

charts/whylogs/templates/hpa.yaml

@@ -0,0 +1,32 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "whylogs.fullname" . }}
+  labels:
+    {{- include "whylogs.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "whylogs.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        target:
+          type: Utilization
+          averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+    {{- end }}
+    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        target:
+          type: Utilization
+          averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    {{- end }}
+{{- end }}