example: added kubernetes example with Helm

Signed-off-by: Sam Alba <sam.alba@gmail.com>
2021-03-22 12:08:42 -07:00 · 2021-03-22 12:08:42 -07:00 · 2daff0ee74
commit 2daff0ee74
parent cbb4f325bf
12 changed files with 377 additions and 33 deletions
--- a/examples/kubernetes/main.cue
+++ b/examples/kubernetes/main.cue
@ -1,25 +1,25 @@
 package main

 import (
-    "encoding/yaml"
-    "dagger.io/aws"
-    "dagger.io/aws/eks"
-    "dagger.io/kubernetes"
+	"encoding/yaml"
+	"dagger.io/dagger"
+	"dagger.io/aws"
+	"dagger.io/aws/eks"
+	"dagger.io/kubernetes"
+	"dagger.io/kubernetes/helm"
 )

 kubeSrc: {
-    apiVersion: "v1"
-    kind:       "Pod"
-    metadata: {
-        name: "kube-test"
-    }
-    spec: {
-        restartPolicy: "Never"
-        containers: [{
-            name:  "test"
-            image: "hello-world"
-        }]
-    }
+	apiVersion: "v1"
+	kind:       "Pod"
+	metadata: name: "kube-test"
+	spec: {
+		restartPolicy: "Never"
+		containers: [{
+			name:  "test"
+			image: "hello-world"
+		}]
+	}
 }

 // Fill using:
@ -29,13 +29,25 @@ awsConfig: aws.#Config & {
 	region: *"us-east-2" | string
 }

+// Take the kubeconfig from the EKS cluster
 cluster: eks.#KubeConfig & {
 	config:      awsConfig
 	clusterName: *"dagger-example-eks-cluster" | string
 }

-apply: kubernetes.#Apply & {
-    source: yaml.Marshal(kubeSrc)
-    namespace: "test"
-    kubeconfig: cluster.kubeconfig
+// Example of a simple `kubectl apply` using a simple config
+kubeApply: kubernetes.#Apply & {
+	source:     yaml.Marshal(kubeSrc)
+	namespace:  "test"
+	kubeconfig: cluster.kubeconfig
+}
+
+// Example of a `helm install` using a local chart
+// Fill using:
+//          --input-dir helmChart.chart=./testdata/mychart
+helmChart: helm.#Chart & {
+    name: "test-helm"
+    namespace: "test"
+	kubeconfig: cluster.kubeconfig
+    chart: dagger.#Artifact
 }
--- a/examples/kubernetes/testdata/mychart/.helmignore
+++ b/examples/kubernetes/testdata/mychart/.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/
--- a/examples/kubernetes/testdata/mychart/Chart.yaml
+++ b/examples/kubernetes/testdata/mychart/Chart.yaml
@ -0,0 +1,21 @@
+apiVersion: v2
+name: mychart
+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.
+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.
+appVersion: 1.16.0
--- a/examples/kubernetes/testdata/mychart/templates/NOTES.txt
+++ b/examples/kubernetes/testdata/mychart/templates/NOTES.txt
@ -0,0 +1,21 @@
+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 }}{{ . }}
+  {{- 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 "mychart.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 "mychart.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "mychart.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 "mychart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
+{{- end }}
--- a/examples/kubernetes/testdata/mychart/templates/_helpers.tpl
+++ b/examples/kubernetes/testdata/mychart/templates/_helpers.tpl
@ -0,0 +1,63 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "mychart.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 "mychart.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 "mychart.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "mychart.labels" -}}
+helm.sh/chart: {{ include "mychart.chart" . }}
+{{ include "mychart.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}
+
+{{/*
+Selector labels
+*/}}
+{{- define "mychart.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "mychart.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "mychart.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+    {{ default (include "mychart.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+    {{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}
--- a/examples/kubernetes/testdata/mychart/templates/deployment.yaml
+++ b/examples/kubernetes/testdata/mychart/templates/deployment.yaml
@ -0,0 +1,55 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "mychart.fullname" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "mychart.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      labels:
+        {{- include "mychart.selectorLabels" . | nindent 8 }}
+    spec:
+    {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      serviceAccountName: {{ include "mychart.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
--- a/examples/kubernetes/testdata/mychart/templates/ingress.yaml
+++ b/examples/kubernetes/testdata/mychart/templates/ingress.yaml
@ -0,0 +1,41 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "mychart.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+{{- 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: {{ . }}
+            backend:
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+        {{- end }}
+  {{- end }}
+{{- end }}
--- a/examples/kubernetes/testdata/mychart/templates/service.yaml
+++ b/examples/kubernetes/testdata/mychart/templates/service.yaml
@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "mychart.fullname" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "mychart.selectorLabels" . | nindent 4 }}
--- a/examples/kubernetes/testdata/mychart/templates/serviceaccount.yaml
+++ b/examples/kubernetes/testdata/mychart/templates/serviceaccount.yaml
@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "mychart.serviceAccountName" . }}
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end -}}
--- a/examples/kubernetes/testdata/mychart/templates/tests/test-connection.yaml
+++ b/examples/kubernetes/testdata/mychart/templates/tests/test-connection.yaml
@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "{{ include "mychart.fullname" . }}-test-connection"
+  labels:
+    {{- include "mychart.labels" . | nindent 4 }}
+  annotations:
+    "helm.sh/hook": test-success
+spec:
+  containers:
+    - name: wget
+      image: busybox
+      command: ['wget']
+      args: ['{{ include "mychart.fullname" . }}:{{ .Values.service.port }}']
+  restartPolicy: Never
--- a/examples/kubernetes/testdata/mychart/values.yaml
+++ b/examples/kubernetes/testdata/mychart/values.yaml
@ -0,0 +1,68 @@
+# Default values for mychart.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: nginx
+  pullPolicy: IfNotPresent
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: 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:
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+
+ingress:
+  enabled: false
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths: []
+  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
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
--- a/stdlib/kubernetes/kubernetes.cue
+++ b/stdlib/kubernetes/kubernetes.cue
@ -20,9 +20,9 @@ import (
 	#compute: [
 		llb.#Load & {
 			from: alpine.#Image & {
-				package: bash:      "=5.1.0-r0"
-				package: jq:        "=1.6-r1"
-				package: curl:      "=7.74.0-r1"
+				package: bash: "=5.1.0-r0"
+				package: jq:   "=1.6-r1"
+				package: curl: "=7.74.0-r1"
 			}
 		},
 		llb.#WriteFile & {
@ -38,10 +38,8 @@ import (
 				"pipefail",
 				"/entrypoint.sh",
 			]
-			env: {
-				KUBECTL_VERSION: version
-			}
-		}
+			env: KUBECTL_VERSION: version
+		},
 	]
 }

@ -66,7 +64,7 @@ import (

 	#compute: [
 		llb.#Load & {
-			from: #Kubectl & { "version": version }
+			from: #Kubectl & {"version": version}
 		},
 		llb.#WriteFile & {
 			dest:    "/entrypoint.sh"
@ -79,10 +77,10 @@ import (
 		},
 		if (source & string) != _|_ {
 			llb.#WriteFile & {
-				dest: "/source"
+				dest:    "/source"
 				content: source
 			}
-		}
+		},
 		llb.#Exec & {
 			always: true
 			args: [
@ -94,12 +92,12 @@ import (
 				"/entrypoint.sh",
 			]
 			env: {
-				KUBECONFIG: "/kubeconfig"
+				KUBECONFIG:     "/kubeconfig"
 				KUBE_NAMESPACE: namespace
 			}
 			if (source & dagger.#Artifact) != _|_ {
-				mount: "/source": source
+				mount: "/source": from: source
 			}
-		}
+		},
 	]
 }