diff --git a/.github/workflows/pr-release.yaml b/.github/workflows/pr-release.yaml new file mode 100644 index 00000000..69461dc1 --- /dev/null +++ b/.github/workflows/pr-release.yaml @@ -0,0 +1,68 @@ +name: Pre-Release Charts + +on: + pull_request: + branches: + - main + +jobs: + release: + runs-on: ubuntu-latest + + permissions: + contents: write + + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Install Helm + uses: azure/setup-helm@v1 + with: + version: v3.8.1 + + - name: Set up chart-testing + uses: helm/chart-testing-action@v2.6.1 + with: + version: v3.11.0 + + - name: yq - portable yaml processor + uses: mikefarah/yq@v4.44.3 + with: + cmd: '' + + - name: Install Helm Deps + run: | + helm repo add bitnami https://charts.bitnami.com/bitnami + helm repo add prometheus-community https://prometheus-community.github.io/helm-charts + helm repo update + + - name: Build deps install script + run: | + chmod +x ./helm-dep-build.sh + ./helm-dep-build.sh + shell: bash + + - name: Package charts + env: + PR_NUMBER: ${{ github.event.number }} + run: | + git_hash=$(git rev-parse --short "$GITHUB_SHA") + for chart in $(ct list-changed --config ct.yaml); do + helm package --version=$(helm show chart ${chart} | yq .version)-PR${PR_NUMBER}-${git_hash} -d .cr-release-packages ${chart} + done + shell: bash + + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.5.0 + with: + skip_packaging: true + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/charts/wandb-service/.helmignore b/charts/wandb-service/.helmignore new file mode 100644 index 00000000..0e8a0eb3 --- /dev/null +++ b/charts/wandb-service/.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/ diff --git a/charts/wandb-service/Chart.yaml b/charts/wandb-service/Chart.yaml new file mode 100644 index 00000000..acb21394 --- /dev/null +++ b/charts/wandb-service/Chart.yaml @@ -0,0 +1,11 @@ +apiVersion: v2 +name: wandb-service +description: A generic helm chart for deploying services to kubernetes +type: application +version: 0.1.0 +icon: https://wandb.ai/logo.svg + +maintainers: + - name: wandb + email: support@wandb.com + url: https://wandb.com diff --git a/charts/wandb-service/templates/NOTES.txt b/charts/wandb-service/templates/NOTES.txt new file mode 100644 index 00000000..2293ef26 --- /dev/null +++ b/charts/wandb-service/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 "wandb-service.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 its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "wandb-service.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "wandb-service.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 "wandb-service.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 }} diff --git a/charts/wandb-service/templates/_containers.tpl b/charts/wandb-service/templates/_containers.tpl new file mode 100644 index 00000000..fef42aac --- /dev/null +++ b/charts/wandb-service/templates/_containers.tpl @@ -0,0 +1,72 @@ +{{- define "wandb-service.containers" }} +{{- range .Values.containers}} +{{- $container := dict }} +{{- $_ := deepCopy . | merge $container }} +{{- $_ = set $container "securityContext" (coalesce $container.securityContext $.Values.securityContext) }} +{{- $_ = set $container "image" (coalesce $container.image $.Values.image) }} +{{- $_ = set $container "envFrom" (concat $container.envFrom $.Values.envFrom) }} +{{- $_ = set $container "env" (concat $container.env $.Values.env) }} +{{- $_ = set $container "root" $ }} +{{- include "wandb-service.container" $container }} +{{- end }} +{{- end }} + +{{- define "wandb-service.initContainers" }} +{{- range .Values.initContainers}} +{{- $container := merge . }} +{{- $_ := set $container "securityContext" (coalesce $container.securityContext $.Values.securityContext) }} +{{- $_ = set $container "image" (coalesce $container.image $.Values.image) }} +{{- $_ = set $container "envFrom" (concat $container.envFrom $.Values.envFrom) }} +{{- $_ = set $container "env" (concat $container.env $.Values.env) }} +{{- $_ = set $container "root" $ }} +{{- include "wandb-service.container" $container }} +{{- end }} +{{- end }} + +{{- define "wandb-service.container" }} +- name: {{ .name }} + {{- if .command }} + command: + {{- toYaml .command | nindent 4 }} + {{- end }} + {{- if .args }} + args: + {{- toYaml .args | nindent 4 }} + {{- end }} + envFrom: + {{- with .envFrom }} + {{- tpl (toYaml . | nindent 4) $.root }} + {{- end }} + env: + {{- with .env }} + {{- tpl (toYaml . | nindent 4) $.root }} + {{- end }} + {{- if .securityContext }} + securityContext: + {{- toYaml .securityContext | nindent 4 }} + {{- end }} + image: "{{ .image.repository }}:{{ .image.tag }}" + imagePullPolicy: {{ .image.pullPolicy }} + {{- with .ports }} + ports: + {{- toYaml . | nindent 4 }} + {{- end }} + livenessProbe: + {{- toYaml .livenessProbe | nindent 4 }} + readinessProbe: + {{- toYaml .readinessProbe | nindent 4 }} + {{ if .startupProbe }} + startupProbe: + {{- toYaml .startupProbe | nindent 4 }} + {{ end }} + {{ if .lifecycle }} + lifecycle: + {{- toYaml .lifecycle | nindent 4 }} + {{ end }} + resources: + {{- toYaml .resources | nindent 4 }} + {{- with .volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} \ No newline at end of file diff --git a/charts/wandb-service/templates/_helpers.tpl b/charts/wandb-service/templates/_helpers.tpl new file mode 100644 index 00000000..28ef9dce --- /dev/null +++ b/charts/wandb-service/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "wandb-service.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 "wandb-service.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 "wandb-service.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "wandb-service.labels" -}} +helm.sh/chart: {{ include "wandb-service.chart" . }} +{{ include "wandb-service.selectorLabels" . }} +{{- if .Values.image.tag }} +app.kubernetes.io/version: {{ .Values.image.tag | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "wandb-service.selectorLabels" -}} +app.kubernetes.io/name: {{ include "wandb-service.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "wandb-service.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "wandb-service.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/wandb-service/templates/deployment.yaml b/charts/wandb-service/templates/deployment.yaml new file mode 100644 index 00000000..6318a4f9 --- /dev/null +++ b/charts/wandb-service/templates/deployment.yaml @@ -0,0 +1,56 @@ +{{- if eq .Values.kind "Deployment" }} +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "wandb-service.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "wandb-service.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "wandb-service.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + {{- if .Values.initContainers }} + initContainers: + {{- include "wandb-service.initContainers" . | nindent 8 }} + {{- end }} + containers: + {{- include "wandb-service.containers" . | nindent 8 }} + {{- 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 }} + {{- end }} \ No newline at end of file diff --git a/charts/wandb-service/templates/hpa.yaml b/charts/wandb-service/templates/hpa.yaml new file mode 100644 index 00000000..34be1e8e --- /dev/null +++ b/charts/wandb-service/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.horizontal.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: {{ .Values.kind }} + name: {{ include "wandb-service.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 }} diff --git a/charts/wandb-service/templates/ingress.yaml b/charts/wandb-service/templates/ingress.yaml new file mode 100644 index 00000000..954ecb0b --- /dev/null +++ b/charts/wandb-service/templates/ingress.yaml @@ -0,0 +1,43 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "wandb-service.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/wandb-service/templates/service.yaml b/charts/wandb-service/templates/service.yaml new file mode 100644 index 00000000..ee4df846 --- /dev/null +++ b/charts/wandb-service/templates/service.yaml @@ -0,0 +1,16 @@ +{{- if .Values.service.enabled }} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + {{- with .Values.service.ports }} + {{- toYaml . | nindent 4 }} + {{- end }} + selector: + {{- include "wandb-service.selectorLabels" . | nindent 4 }} + {{ end }} \ No newline at end of file diff --git a/charts/wandb-service/templates/serviceaccount.yaml b/charts/wandb-service/templates/serviceaccount.yaml new file mode 100644 index 00000000..d12454a0 --- /dev/null +++ b/charts/wandb-service/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "wandb-service.serviceAccountName" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/wandb-service/templates/statefulset.yaml b/charts/wandb-service/templates/statefulset.yaml new file mode 100644 index 00000000..fe0b1759 --- /dev/null +++ b/charts/wandb-service/templates/statefulset.yaml @@ -0,0 +1,78 @@ +{{- if eq .Values.kind "Statefulset" }} +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "wandb-service.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "wandb-service.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "wandb-service.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + {{ with .Values.envFrom }} + envFrom: + {{- toYaml . | nindent 12 }} + {{- end }} + {{ with .Values.env }} + env: + {{- toYaml . | nindent 12 }} + {{- end }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + 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 }} +{{- end }} \ No newline at end of file diff --git a/charts/wandb-service/templates/tests/test-connection.yaml b/charts/wandb-service/templates/tests/test-connection.yaml new file mode 100644 index 00000000..1e69420b --- /dev/null +++ b/charts/wandb-service/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "wandb-service.fullname" . }}-test-connection" + labels: + {{- include "wandb-service.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "wandb-service.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/wandb-service/templates/vpa.yaml b/charts/wandb-service/templates/vpa.yaml new file mode 100644 index 00000000..9d571f8f --- /dev/null +++ b/charts/wandb-service/templates/vpa.yaml @@ -0,0 +1,20 @@ +{{- if .Values.autoscaling.vertical.enabled }} +apiVersion: autoscaling.k8s.io/v1 +kind: VerticalPodAutoscaler +metadata: + name: {{ include "wandb-service.fullname" . }} + labels: + {{- include "wandb-service.labels" . | nindent 4 }} +spec: + targetRef: + apiVersion: apps/v1 + kind: {{ .Values.kind }} + name: {{ include "wandb-service.fullname" . }} + updatePolicy: + updateMode: {{ .Values.autoscaling.vertical.updateMode }} + resourcePolicy: + containerPolicies: + {{- with .Values.autoscaling.vertical.containerPolicies }} + {{- toYaml . | nindent 6 }} + {{- end }} +{{- end }} diff --git a/charts/wandb-service/values.yaml b/charts/wandb-service/values.yaml new file mode 100644 index 00000000..678c9a00 --- /dev/null +++ b/charts/wandb-service/values.yaml @@ -0,0 +1,141 @@ +# Default values for wandb-service. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +kind: Deployment + +replicaCount: 1 + +# The default image to be used for containers in the deployment, can be overridden per container +image: + repository: nginx + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +env: [] +envFrom: [] + +serviceAccount: + create: true + automount: true + annotations: {} + name: "" + +podAnnotations: {} +podLabels: {} + +podSecurityContext: + runAsNonRoot: true + runAsUser: 999 + runAsGroup: 0 + fsGroup: 0 + fsGroupChangePolicy: "OnRootMismatch" + seccompProfile: + type: "" + +securityContext: + capabilities: + add: [] + drop: [] + allowPrivilegeEscalation: false + readOnlyRootFilesystem: false + privileged: false + +initContainers: [] + +containers: + - name: nginx + command: [] + args: [] + env: [] + envFrom: [] + securityContext: {} + image: {} + ports: + - containerPort: 80 + name: http + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + startupProbe: + httpGet: + path: / + port: http + lifecycle: {} + resources: + limits: + cpu: 100m + memory: 128Mi + requests: + cpu: 100m + memory: 128Mi + volumeMounts: [] + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + enabled: true + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + ports: + - port: 80 + targetPort: http + protocol: TCP + name: http + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + horizontal: + enabled: false + minReplicas: 1 + maxReplicas: 5 + targetCPUUtilizationPercentage: 80 + targetMemoryUtilizationPercentage: 80 + vertical: + enabled: false + updateMode: "Auto" + containerPolicies: + - containerName: "*" + controlledResources: + - memory + - cpu + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +nodeSelector: {} + +tolerations: [] + +affinity: {}