From af8c245a5a228ea627487935dba360e0a018cd15 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Wed, 23 Oct 2024 13:45:26 -0700 Subject: [PATCH 1/7] feat: generic service chart and pr releases --- .github/workflows/pr-release.yaml | 67 +++++++++ charts/wandb-service/.helmignore | 23 +++ charts/wandb-service/Chart.yaml | 24 +++ charts/wandb-service/templates/NOTES.txt | 22 +++ charts/wandb-service/templates/_helpers.tpl | 62 ++++++++ .../wandb-service/templates/deployment.yaml | 74 +++++++++ charts/wandb-service/templates/hpa.yaml | 32 ++++ charts/wandb-service/templates/ingress.yaml | 43 ++++++ charts/wandb-service/templates/service.yaml | 16 ++ .../templates/serviceaccount.yaml | 13 ++ .../wandb-service/templates/statefulset.yaml | 70 +++++++++ .../templates/tests/test-connection.yaml | 15 ++ charts/wandb-service/templates/vpa.yaml | 20 +++ charts/wandb-service/values.yaml | 140 ++++++++++++++++++ 14 files changed, 621 insertions(+) create mode 100644 .github/workflows/pr-release.yaml create mode 100644 charts/wandb-service/.helmignore create mode 100644 charts/wandb-service/Chart.yaml create mode 100644 charts/wandb-service/templates/NOTES.txt create mode 100644 charts/wandb-service/templates/_helpers.tpl create mode 100644 charts/wandb-service/templates/deployment.yaml create mode 100644 charts/wandb-service/templates/hpa.yaml create mode 100644 charts/wandb-service/templates/ingress.yaml create mode 100644 charts/wandb-service/templates/service.yaml create mode 100644 charts/wandb-service/templates/serviceaccount.yaml create mode 100644 charts/wandb-service/templates/statefulset.yaml create mode 100644 charts/wandb-service/templates/tests/test-connection.yaml create mode 100644 charts/wandb-service/templates/vpa.yaml create mode 100644 charts/wandb-service/values.yaml diff --git a/.github/workflows/pr-release.yaml b/.github/workflows/pr-release.yaml new file mode 100644 index 00000000..7f180a32 --- /dev/null +++ b/.github/workflows/pr-release.yaml @@ -0,0 +1,67 @@ +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: | + for chart in $(ct list-changed --config ct.yaml); do + helm package --version=$(helm show chart ${chart} | yq .version)-PR${PR_NUMBER} -d .cr-release-packages ${chart} + done + shell: bash + + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.6.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..3938d501 --- /dev/null +++ b/charts/wandb-service/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: wandb-service +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.1.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "0.1.0" 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/_helpers.tpl b/charts/wandb-service/templates/_helpers.tpl new file mode 100644 index 00000000..e9788b69 --- /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 .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | 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..de94ce9d --- /dev/null +++ b/charts/wandb-service/templates/deployment.yaml @@ -0,0 +1,74 @@ +{{- 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 }} + containers: + - name: {{ .Chart.Name }} + {{ with .Values.env }} + env: + {{- toYaml . | nindent 12 }} + {{- end }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{ with .Values.service.ports }} + ports: + {{- toYaml . | nindent 12 }} + {{- end }} + 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/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..057f15de --- /dev/null +++ b/charts/wandb-service/templates/statefulset.yaml @@ -0,0 +1,70 @@ +{{- 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 }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + 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..8589915b --- /dev/null +++ b/charts/wandb-service/values.yaml @@ -0,0 +1,140 @@ +# Default values for wandb-service. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +kind: Deployment + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: nginx + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +env: [] + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# 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 + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +# 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 + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} From 0dab94273d263759261cf7c1dc9ca34cf45dd006 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Wed, 23 Oct 2024 14:01:38 -0700 Subject: [PATCH 2/7] chore: dont mark release as latest --- .github/workflows/pr-release.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pr-release.yaml b/.github/workflows/pr-release.yaml index 7f180a32..58c4b881 100644 --- a/.github/workflows/pr-release.yaml +++ b/.github/workflows/pr-release.yaml @@ -63,5 +63,6 @@ jobs: uses: helm/chart-releaser-action@v1.6.0 with: skip_packaging: true + mark_as_latest: false env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" From 788b25ca4ba2391ce431a8a92d17b10c05493d75 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Wed, 23 Oct 2024 14:05:24 -0700 Subject: [PATCH 3/7] chore: add maintainers --- charts/wandb-service/Chart.yaml | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/charts/wandb-service/Chart.yaml b/charts/wandb-service/Chart.yaml index 3938d501..b718f2b9 100644 --- a/charts/wandb-service/Chart.yaml +++ b/charts/wandb-service/Chart.yaml @@ -1,24 +1,11 @@ apiVersion: v2 name: wandb-service -description: A Helm chart for Kubernetes - -# A chart can be either an 'application' or a 'library' chart. -# -# Application charts are a collection of templates that can be packaged into versioned archives -# to be deployed. -# -# Library charts provide useful utilities or functions for the chart developer. They're included as -# a dependency of application charts to inject those utilities and functions into the rendering -# pipeline. Library charts do not define any templates and therefore cannot be deployed. +description: A generic helm chart for deploying services to kubernetes type: application - -# This is the chart version. This version number should be incremented each time you make changes -# to the chart and its templates, including the app version. -# Versions are expected to follow Semantic Versioning (https://semver.org/) version: 0.1.0 +icon: https://wandb.ai/logo.svg -# This is the version number of the application being deployed. This version number should be -# incremented each time you make changes to the application. Versions are not expected to -# follow Semantic Versioning. They should reflect the version the application is using. -# It is recommended to use it with quotes. -appVersion: "0.1.0" +maintainers: + - name: wandb + email: support@wandb.com + url: https://wandb.com \ No newline at end of file From 03ef106e75a5fe9f80756bdf5218bc5e7dbce6ac Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Wed, 23 Oct 2024 14:10:32 -0700 Subject: [PATCH 4/7] chore: yamllint --- charts/wandb-service/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/wandb-service/Chart.yaml b/charts/wandb-service/Chart.yaml index b718f2b9..acb21394 100644 --- a/charts/wandb-service/Chart.yaml +++ b/charts/wandb-service/Chart.yaml @@ -8,4 +8,4 @@ icon: https://wandb.ai/logo.svg maintainers: - name: wandb email: support@wandb.com - url: https://wandb.com \ No newline at end of file + url: https://wandb.com From 40b4d375ec3f8c6488e9389a260b2b3d3e33a459 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Wed, 23 Oct 2024 14:57:14 -0700 Subject: [PATCH 5/7] fix: dont use Chart appVersion in service chart --- .github/workflows/pr-release.yaml | 3 +-- charts/wandb-service/templates/_helpers.tpl | 4 ++-- charts/wandb-service/templates/deployment.yaml | 2 +- charts/wandb-service/templates/statefulset.yaml | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/workflows/pr-release.yaml b/.github/workflows/pr-release.yaml index 58c4b881..afbd9408 100644 --- a/.github/workflows/pr-release.yaml +++ b/.github/workflows/pr-release.yaml @@ -60,9 +60,8 @@ jobs: shell: bash - name: Run chart-releaser - uses: helm/chart-releaser-action@v1.6.0 + uses: helm/chart-releaser-action@v1.5.0 with: skip_packaging: true - mark_as_latest: false env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/charts/wandb-service/templates/_helpers.tpl b/charts/wandb-service/templates/_helpers.tpl index e9788b69..28ef9dce 100644 --- a/charts/wandb-service/templates/_helpers.tpl +++ b/charts/wandb-service/templates/_helpers.tpl @@ -36,8 +36,8 @@ Common labels {{- define "wandb-service.labels" -}} helm.sh/chart: {{ include "wandb-service.chart" . }} {{ include "wandb-service.selectorLabels" . }} -{{- if .Chart.AppVersion }} -app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- if .Values.image.tag }} +app.kubernetes.io/version: {{ .Values.image.tag | quote }} {{- end }} app.kubernetes.io/managed-by: {{ .Release.Service }} {{- end }} diff --git a/charts/wandb-service/templates/deployment.yaml b/charts/wandb-service/templates/deployment.yaml index de94ce9d..bf1c500e 100644 --- a/charts/wandb-service/templates/deployment.yaml +++ b/charts/wandb-service/templates/deployment.yaml @@ -39,7 +39,7 @@ spec: {{- end }} securityContext: {{- toYaml .Values.securityContext | nindent 12 }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" imagePullPolicy: {{ .Values.image.pullPolicy }} {{ with .Values.service.ports }} ports: diff --git a/charts/wandb-service/templates/statefulset.yaml b/charts/wandb-service/templates/statefulset.yaml index 057f15de..9b3fd99b 100644 --- a/charts/wandb-service/templates/statefulset.yaml +++ b/charts/wandb-service/templates/statefulset.yaml @@ -35,7 +35,7 @@ spec: - name: {{ .Chart.Name }} securityContext: {{- toYaml .Values.securityContext | nindent 12 }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" imagePullPolicy: {{ .Values.image.pullPolicy }} ports: - name: http From 12044e3016b052c65a03ac7e874b3672fcd8c245 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Thu, 24 Oct 2024 08:40:00 -0700 Subject: [PATCH 6/7] feat: add envFrom for deployment and statefulset, add githash to chart version --- .github/workflows/pr-release.yaml | 3 ++- charts/wandb-service/templates/deployment.yaml | 4 ++++ charts/wandb-service/templates/statefulset.yaml | 8 ++++++++ charts/wandb-service/values.yaml | 1 + 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pr-release.yaml b/.github/workflows/pr-release.yaml index afbd9408..69461dc1 100644 --- a/.github/workflows/pr-release.yaml +++ b/.github/workflows/pr-release.yaml @@ -54,8 +54,9 @@ jobs: 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} -d .cr-release-packages ${chart} + helm package --version=$(helm show chart ${chart} | yq .version)-PR${PR_NUMBER}-${git_hash} -d .cr-release-packages ${chart} done shell: bash diff --git a/charts/wandb-service/templates/deployment.yaml b/charts/wandb-service/templates/deployment.yaml index bf1c500e..2f8bdc9f 100644 --- a/charts/wandb-service/templates/deployment.yaml +++ b/charts/wandb-service/templates/deployment.yaml @@ -33,6 +33,10 @@ spec: {{- toYaml .Values.podSecurityContext | nindent 8 }} containers: - name: {{ .Chart.Name }} + {{ with .Values.envFrom }} + envFrom: + {{- toYaml . | nindent 12 }} + {{- end }} {{ with .Values.env }} env: {{- toYaml . | nindent 12 }} diff --git a/charts/wandb-service/templates/statefulset.yaml b/charts/wandb-service/templates/statefulset.yaml index 9b3fd99b..fe0b1759 100644 --- a/charts/wandb-service/templates/statefulset.yaml +++ b/charts/wandb-service/templates/statefulset.yaml @@ -33,6 +33,14 @@ spec: {{- 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 }}" diff --git a/charts/wandb-service/values.yaml b/charts/wandb-service/values.yaml index 8589915b..9cf810a5 100644 --- a/charts/wandb-service/values.yaml +++ b/charts/wandb-service/values.yaml @@ -22,6 +22,7 @@ nameOverride: "" fullnameOverride: "" env: [] +envFrom: [] # This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ serviceAccount: From 83900b19432dfa596ef292d64e4bf9b86d99ee00 Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Thu, 24 Oct 2024 14:51:07 -0700 Subject: [PATCH 7/7] feat: multi container and initcontainer support, default security settings --- .../wandb-service/templates/_containers.tpl | 64 ++++++++++++ .../wandb-service/templates/deployment.yaml | 32 +----- charts/wandb-service/values.yaml | 98 +++++++++---------- 3 files changed, 115 insertions(+), 79 deletions(-) create mode 100644 charts/wandb-service/templates/_containers.tpl diff --git a/charts/wandb-service/templates/_containers.tpl b/charts/wandb-service/templates/_containers.tpl new file mode 100644 index 00000000..55c14708 --- /dev/null +++ b/charts/wandb-service/templates/_containers.tpl @@ -0,0 +1,64 @@ +{{- 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 }} + 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/deployment.yaml b/charts/wandb-service/templates/deployment.yaml index 2f8bdc9f..6318a4f9 100644 --- a/charts/wandb-service/templates/deployment.yaml +++ b/charts/wandb-service/templates/deployment.yaml @@ -31,34 +31,12 @@ spec: serviceAccountName: {{ include "wandb-service.serviceAccountName" . }} securityContext: {{- toYaml .Values.podSecurityContext | nindent 8 }} + {{- if .Values.initContainers }} + initContainers: + {{- include "wandb-service.initContainers" . | nindent 8 }} + {{- end }} 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 }} - {{ with .Values.service.ports }} - ports: - {{- toYaml . | nindent 12 }} - {{- end }} - 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 }} + {{- include "wandb-service.containers" . | nindent 8 }} {{- with .Values.volumes }} volumes: {{- toYaml . | nindent 8 }} diff --git a/charts/wandb-service/values.yaml b/charts/wandb-service/values.yaml index 9cf810a5..49c3a632 100644 --- a/charts/wandb-service/values.yaml +++ b/charts/wandb-service/values.yaml @@ -4,10 +4,9 @@ kind: Deployment -# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ replicaCount: 1 -# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +# 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. @@ -15,44 +14,67 @@ image: # Overrides the image tag whose default is the chart appVersion. tag: "" -# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ imagePullSecrets: [] -# This is to override the chart name. nameOverride: "" fullnameOverride: "" env: [] envFrom: [] -# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ serviceAccount: - # Specifies whether a service account should be created create: true - # Automatically mount a ServiceAccount's API credentials? automount: true - # Annotations to add to the service account annotations: {} - # The name of the service account to use. - # If not set and create is true, a name is generated using the fullname template name: "" -# This is for setting Kubernetes Annotations to a Pod. -# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ podAnnotations: {} -# This is for setting Kubernetes Labels to a Pod. -# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ podLabels: {} -podSecurityContext: {} - # fsGroup: 2000 - -securityContext: {} - # capabilities: - # drop: - # - ALL - # readOnlyRootFilesystem: true - # runAsNonRoot: true - # runAsUser: 1000 +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 + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + 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: @@ -82,28 +104,6 @@ ingress: # hosts: # - chart-example.local -resources: {} - # We usually recommend not to specify default resources and to leave this as a conscious - # choice for the user. This also increases chances charts run on environments with little - # resources, such as Minikube. If you do want to specify resources, uncomment the following - # lines, adjust them as necessary, and remove the curly braces after 'resources:'. - # limits: - # cpu: 100m - # memory: 128Mi - # requests: - # cpu: 100m - # memory: 128Mi - -# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ -livenessProbe: - httpGet: - path: / - port: http -readinessProbe: - httpGet: - path: / - port: http - # This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ autoscaling: horizontal: @@ -128,12 +128,6 @@ volumes: [] # secretName: mysecret # optional: false -# Additional volumeMounts on the output Deployment definition. -volumeMounts: [] -# - name: foo -# mountPath: "/etc/foo" -# readOnly: true - nodeSelector: {} tolerations: []