feat(keto): add Keto Helm chart (ory#209)

helm/charts/keto/.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/

helm/charts/keto/Chart.yaml

@@ -0,0 +1,29 @@
+apiVersion: v2
+name: keto
+description: Access Control Policies as a Server
+type: application
+home: https://www.ory.sh/keto/
+keywords:
+- rbac
+- hrbac
+- acl
+- iam
+- api-security
+- security
+sources:
+- https://github.com/ory/keto
+- https://github.com/ory/k8s
+maintainers:
+- name: ORY Team
+  email: [email protected]
+  url: https://www.ory.sh/
+
+# 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.
+appVersion: v0.5.7

helm/charts/keto/README.md

@@ -0,0 +1,79 @@
+# ORY Keto Helm Chart
+
+The ORY Keto Helm Chart helps you deploy ORY Keto on Kubernetes using Helm.
+
+## Installation
+
+To install ORY Keto, the following values must be set
+([documentation](https://www.ory.sh/keto/docs/reference/configuration)):
+
+* `keto.config.dsn`
+
+If you wish to install ORY Keto with an in-memory database run:
+
+```bash
+$ helm install \
+    --set 'keto.config.dsn=memory' \
+    ory/keto
+```
+
+### With SQL Database
+
+To run ORY Keto against a SQL database, set the connection string. For example:
+
+```bash
+$ helm install \
+    ...
+    --set 'dsn=postgres://foo:bar@baz:1234/db' \
+    ory/keto
+```
+
+This chart does not require MySQL, PostgreSQL, or CockroachDB as dependencies because we strongly encourage
+you not to run a database in Kubernetes but instead recommend to rely on a managed SQL database such as Google
+Cloud SQL or AWS Aurora.
+
+### With Google Cloud SQL
+
+To connect to Google Cloud SQL, you could use
+the [`gcloud-sqlproxy`](https://github.com/rimusz/charts/tree/master/stable/gcloud-sqlproxy) chart:
+
+```bash
+$ helm upgrade pg-sqlproxy rimusz/gcloud-sqlproxy --namespace sqlproxy \
+    --set 'serviceAccountKey="$(cat service-account.json | base64 | tr -d '\n')"' \
+    ...
+```
+
+When bringing up ORY Keto, set the host to `pg-sqlproxy-gcloud-sqlproxy` as documented
+[here](https://github.com/rimusz/charts/tree/master/stable/gcloud-sqlproxy#installing-the-chart):
+
+```bash
+$ helm install \
+    ...
+    --set 'dsn=postgres://foo:bar@pg-sqlproxy-gcloud-sqlproxy:5432/db' \
+    ory/keto
+```
+
+## Configuration
+
+You can pass your [ORY Keto configuration file](https://www.ory.sh/keto/docs/reference/configuration)
+by creating a yaml file with key `keto.config`
+
+```yaml
+# keto-config.yaml
+keto:
+  config:
+    # e.g.:
+    serve:
+      port: 8080
+   # ...
+```
+
+and passing that as a value override to helm:
+
+```bash
+$ helm install -f ./path/to/keto-config.yaml ory/keto
+```
+
+Additionally, the following extra settings are available:
+
+- `autoMigrate` (bool): If enabled, an `initContainer` running `keto migrate sql` will be created.

helm/charts/keto/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 "keto.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 "keto.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "keto.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 "keto.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 }}

helm/charts/keto/templates/_helpers.tpl

@@ -0,0 +1,90 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "keto.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 "keto.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 a secret name which can be overridden.
+*/}}
+{{- define "keto.secretname" -}}
+{{- if .Values.secret.nameOverride -}}
+{{- .Values.secret.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{ include "keto.fullname" . }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "keto.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+
+
+{{/*
+Generate the dsn value
+*/}}
+{{- define "keto.dsn" -}}
+{{- .Values.keto.config.dsn }}
+{{- end -}}
+
+{{/*
+Generate the configmap data, redacting secrets
+*/}}
+{{- define "keto.configmap" -}}
+{{- $config := unset .Values.keto.config "dsn" -}}
+{{- toYaml $config -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "keto.labels" -}}
+helm.sh/chart: {{ include "keto.chart" . }}
+{{ include "keto.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "keto.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "keto.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "keto.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "keto.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

helm/charts/keto/templates/configmap.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "keto.fullname" . }}-config
+  namespace: {{ .Release.Namespace }}
+  labels:
+{{ include "keto.labels" . | indent 4 }}
+data:
+  ".keto.yaml": |
+    {{- include "keto.configmap" . | nindent 4 }}

helm/charts/keto/templates/deployment.yaml

@@ -0,0 +1,117 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "keto.fullname" . }}
+  labels:
+    {{- include "keto.labels" . | nindent 4 }}
+spec:
+{{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+{{- end }}
+  selector:
+    matchLabels:
+      {{- include "keto.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+    {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      labels:
+        {{- include "keto.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- if .Values.keto.autoMigrate }}
+      initContainers:
+        - name: {{ .Chart.Name }}-automigrate
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          command: [ "keto" ]
+          args: [ "migrate", "sql", "-e", "--config", "/etc/config/.keto.yaml" ]
+          volumeMounts:
+            - name: {{ include "keto.name" . }}-config-volume
+              mountPath: /etc/config
+              readOnly: true
+          env:
+            - name: DSN
+              valueFrom:
+                secretKeyRef:
+                  name: {{ include "keto.secretname" . }}
+                  key: dsn
+      {{- end }}
+      serviceAccountName: {{ include "keto.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 }}
+          command: [ "keto" ]
+          args:
+            - serve
+            - --config
+            - /etc/config/.keto.yaml
+          ports:
+            - name: http
+              containerPort: {{ .Values.keto.config.serve.port }}
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /health/alive
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /health/ready
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          env:
+            {{- if .Values.tracing.datadog.enabled }}
+            - name: TRACING_PROVIDER
+              value: datadog
+            - name: DD_ENV
+              value: {{ .Values.tracing.datadog.env | default "none" | quote }}
+            - name: DD_VERSION
+              value: {{ .Values.tracing.datadog.version | default .Chart.AppVersion | quote }}
+            - name: DD_SERVICE
+              value: {{ .Values.tracing.datadog.service | default "ory/keto" | quote }}
+            {{- if .Values.tracing.datadog.useHostIP }}
+            - name: DD_AGENT_HOST
+              valueFrom:
+                fieldRef:
+                  fieldPath: status.hostIP
+            {{- end }}
+            {{- end }}
+            - name: DSN
+              valueFrom:
+                secretKeyRef:
+                  name: {{ include "keto.secretname" . }}
+                  key: dsn
+            {{- with .Values.extraEnv }}
+              {{- toYaml . | nindent 12 }}
+            {{- end }}
+          volumeMounts:
+            - name: {{ include "keto.name" . }}-config-volume
+              mountPath: /etc/config
+              readOnly: true
+      volumes:
+        - name: {{ include "keto.name" . }}-config-volume
+          configMap:
+            name: {{ include "keto.fullname" . }}-config
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}