Prepare template for registry-proxy service

aserto-dev · Dec 11, 2024 · 554d8fb · 554d8fb
1 parent 992b4ca
commit 554d8fb
Show file tree

Hide file tree

Showing 11 changed files with 511 additions and 0 deletions.
diff --git a/charts/registry-proxy/Chart.lock b/charts/registry-proxy/Chart.lock
@@ -0,0 +1,6 @@
+dependencies:
+- name: aserto-lib
+  repository: oci://ghcr.io/aserto-dev/helm
+  version: 0.1.5
+digest: sha256:42f1409ebeefeb632b83b947714d0be75603167a7b11cadeaf80d4cd437dcda8
+generated: "2024-12-10T16:19:27.984307+02:00"
diff --git a/charts/registry-proxy/Chart.yaml b/charts/registry-proxy/Chart.yaml
@@ -0,0 +1,35 @@
+---
+apiVersion: v2
+name: registry-proxy
+description: A Helm chart for the Aserto Registry Proxy service
+icon: https://www.aserto.com/images/aserto-logo.png
+
+maintainers:
+  - name: Aserto
+    url: https://github.com/aserto-dev
+
+# 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.6
+
+# 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.14.8"
+
+dependencies:
+  - name: aserto-lib
+    version: ~0.1.4
+    repository: oci://ghcr.io/aserto-dev/helm
diff --git a/charts/registry-proxy/templates/NOTES.txt b/charts/registry-proxy/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 }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "registry-proxy.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 "registry-proxy.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "registry-proxy.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 "registry-proxy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+    export HTTPS_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+    export GRPC_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[1].containerPort}")
+    echo "gRPC Service exposed on http://127.0.0.1:8282"
+    echo "REST Service exposed on http://127.0.0.1:8383"
+    kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8282:$GRPC_PORT 8383:$HTTPS_PORT
+{{- end }}
diff --git a/charts/registry-proxy/templates/_helpers.tpl b/charts/registry-proxy/templates/_helpers.tpl
@@ -0,0 +1,77 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "registry-proxy.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 "registry-proxy.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 "registry-proxy.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "registry-proxy.labels" -}}
+helm.sh/chart: {{ include "registry-proxy.chart" . }}
+{{ include "registry-proxy.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "registry-proxy.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "registry-proxy.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "registry-proxy.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "registry-proxy.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Local cluster address
+*/}}
+{{- define "registry-proxy.clusterAddress" -}}
+{{ include "registry-proxy.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local:{{ include "aserto-lib.grpcPort" . }}
+{{- end }}
+
+
+{{- define "registry-proxy.gatewayService" }}
+{{ include "aserto-lib.httpsService" .  }}
+{{- $cfg := include "aserto-lib.httpsConfig" . | fromYaml }}
+allowed_headers:
+{{- $cfg.allowed_headers | default (list "Aserto-Tenant-Id" "Authorization" "Content-Type" "Depth") | toYaml | nindent 2 }}
+{{- end }}
diff --git a/charts/registry-proxy/templates/config.yaml b/charts/registry-proxy/templates/config.yaml
@@ -0,0 +1,35 @@
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "registry-proxy.fullname" . }}-config
+  labels:
+    {{- include "registry-proxy.labels" . | nindent 4 }}
+stringData:
+  config.yaml: |
+    ---
+    version: 1
+    logging:
+      prod: true
+      log_level: {{ .Values.logLevel | default "info" }}
+    api:
+      health:
+        listen_address: "0.0.0.0:{{ include "aserto-lib.healthPort" . }}"
+      metrics:
+        {{- include "aserto-lib.metricsService" . | nindent 8 }}
+      service:
+        {{- include "registry-proxy.gatewayService" . | nindent 8 }}
+        
+    remote_registry:
+      endpoint: {{ .Values.remoteEndpointURL | required "registry endpoint URL is required" }}
+      scheme: {{.Values.remoteEndpointScheme }}
+      token: {{.Values.remoteEndpointToken}}
+        
+    nats_listener:
+      enabled: false #set to true to enable manifest pushed notifications
+    
+    cache_settings:
+      type: "freecache"
+      cache_config:
+        freecache_size: 5000000
+        ttl: 900000000000 # 15 minutes
diff --git a/charts/registry-proxy/templates/deployment.yaml b/charts/registry-proxy/templates/deployment.yaml
@@ -0,0 +1,120 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "registry-proxy.fullname" . }}
+  labels:
+    {{- include "registry-proxy.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "registry-proxy.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "registry-proxy.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- include "aserto-lib.imagePullSecrets" . | nindent 6 }}
+      serviceAccountName: {{ include "registry-proxy.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      volumes:
+        - name: config
+          secret:
+            secretName: {{ include "registry-proxy.fullname" . }}-config
+            items:
+              - key: config.yaml
+                path: config.yaml
+        - name: grpc-certs
+          {{- with include "aserto-lib.grpcConfig" . | fromYaml }}
+          {{- if .certSecret  }}
+          secret:
+            secretName: {{ .certSecret }}
+          {{- else }}
+          emptyDir: {}
+          {{- end }}
+          {{- end }}
+        - name: https-certs
+          {{- with (include "aserto-lib.httpsConfig" . | fromYaml) }}
+          {{- if .certSecret }}
+          secret:
+            secretName: {{ .certSecret }}
+          {{- else }}
+          emptyDir: {}
+          {{- end }}
+          {{- end }}
+
+        {{- with (include "aserto-lib.rootDirectoryCfg" . | fromYaml) }}
+        {{- if .grpcCertSecret }}
+        - name: root-ds-grpc-certs
+          secret:
+            secretName: {{ .grpcCertSecret }}
+            items:
+              - key: ca.crt
+                path: ca.crt
+        {{- end }}
+        {{- end }}
+
+        {{- with (include "aserto-lib.discoveryCfg" . | fromYaml) }}
+        {{- if .httpsCertSecret }}
+        - name: discovery-https-certs
+          secret:
+            secretName: {{ .httpsCertSecret }}
+            items:
+              - key: ca.crt
+                path: ca.crt
+        {{- end }}
+        {{- end }}
+
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          args: ["run", "--config-file", "/config/config.yaml"]
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            {{- with (include "aserto-lib.selfPorts" . | fromYaml )}}
+            - name: https
+              containerPort: {{ .https }}            
+            - name: metrics
+              containerPort: {{ .metrics }}
+            {{- end }}
+          volumeMounts:
+            - name: config
+              mountPath: /config
+              readOnly: true
+            - name: https-certs
+              mountPath: /https-certs
+            {{- if (include "aserto-lib.httpsConfig" . | fromYaml).certSecret  }}
+              readOnly: true
+            {{- end }}
+
+          {{- with (include "aserto-lib.selfPorts" . | fromYaml )}}
+          livenessProbe:
+            grpc:
+              port: {{ .health }}
+          readinessProbe:
+            grpc:
+              port: {{ .health }}
+          {{- end }}
+          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 }}
diff --git a/charts/registry-proxy/templates/hpa.yaml b/charts/registry-proxy/templates/hpa.yaml
@@ -0,0 +1,28 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2beta1
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "registry-proxy.fullname" . }}
+  labels:
+    {{- include "registry-proxy.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "registry-proxy.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+    {{- end }}
+    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    {{- end }}
+{{- end }}
diff --git a/charts/registry-proxy/templates/ingress.yaml b/charts/registry-proxy/templates/ingress.yaml
@@ -0,0 +1,58 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "registry-proxy.fullname" . -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else 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 "registry-proxy.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- 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:
+          - path: /
+            {{- if (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: Prefix
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  name: {{ .port }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ .port }}
+              {{- end }}
+    {{- end }}
+{{- end }}