feat(helm): add pgadmin4 as dependency to the chart PR eclipse-tractu…

…sx#208

feat(helm): add pgadmin4 as dependency to the chart

.github/workflows/chart-verification.yml

@@ -87,7 +87,7 @@ jobs:
         with:
           image: jnorwood/helm-docs:v1.11.3
           options: -v ${{ github.workspace }}/charts:/helm-docs
-          run: helm-docs
+          run: helm-docs -i managed-identity-wallet/.helmdocsignore
 
       - name: Verify that no changes are required
         run: |
@@ -133,7 +133,7 @@ jobs:
 
       - name: Install Helm unittest plugin
         run: |
-          helm plugin install https://github.com/helm-unittest/helm-unittest.git
+          helm plugin install https://github.com/helm-unittest/helm-unittest.git --version 0.3.5
 
       - name: Run Helm unittests
         run: task helm:unittest

charts/managed-identity-wallet/.helmdocsignore

@@ -0,0 +1 @@
+charts/

charts/managed-identity-wallet/.helmignore

@@ -24,5 +24,6 @@
 tests/
 values-*.yaml
 README.md.gotmpl
+.helmdocsignore
 ci/
-argocd/
+charts/pgadmin4

charts/managed-identity-wallet/charts/pgadmin4/Chart.yaml

@@ -0,0 +1,17 @@
+apiVersion: v1
+description: pgAdmin4 is a web based administration tool for PostgreSQL database
+name: pgadmin4
+version: 1.19.0
+appVersion: "7.8"
+keywords:
+  - pgadmin
+  - postgres
+  - database
+  - sql
+home: https://www.pgadmin.org/
+icon: https://wiki.postgresql.org/images/3/30/PostgreSQL_logo.3colors.120x120.png
+sources:
+  - https://github.com/rowanruseler/helm-charts
+maintainers:
+  - name: rowanruseler
+    email: [email protected]

charts/managed-identity-wallet/charts/pgadmin4/README.md

@@ -0,0 +1,137 @@
+###### based on [dpage/pgadmin4]
+
+# pgAdmin 4
+
+[pgAdmin4](https://www.pgadmin.org/) is the leading Open Source management tool for Postgres, the world’s most advanced Open Source database. pgAdmin4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects.
+
+## TL;DR;
+
+```console
+helm repo add runix https://helm.runix.net
+helm install runix/pgadmin4
+```
+
+## Introduction
+
+This chart bootstraps a [pgAdmin4](https://www.pgadmin.org/) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+
+## Install the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ # Helm 2
+helm install --name my-release runix/pgadmin4
+$ # Helm 3
+helm install my-release runix/pgadmin4
+```
+
+The command deploys pgAdmin4 on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
+
+> **Tip**: List all releases using `helm list`
+
+## Uninstall the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```console
+helm delete --purge my-release
+```
+
+The command removes nearly all the Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+
+| Parameter | Description | Default |
+| --------- | ----------- | ------- |
+| `replicaCount` | Number of pgadmin4 replicas | `1` |
+| `image.registry` | Docker image registry | `docker.io` |
+| `image.repository` | Docker image | `dpage/pgadmin4` |
+| `image.tag` | Docker image tag | `""` |
+| `image.pullPolicy` | Docker image pull policy | `IfNotPresent` |
+| `annotations` | Deployment Annotations | `{}` |
+| `priorityClassName` | Deployment priorityClassName | `""` |
+| `command` | Deployment command override | `""` |
+| `service.type` | Service type (ClusterIP, NodePort or LoadBalancer) | `ClusterIP` |
+| `service.clusterIP` | Service type Cluster IP | `""` |
+| `service.loadBalancerIP` | Service Load Balancer IP | `""` |
+| `service.annotations` | Service Annotations | `{}` |
+| `service.port` | Service port | `80` |
+| `service.portName` | Name of the port on the service | `http` |
+| `service.targetPort` | Internal service port | `http` |
+| `service.nodePort` | Kubernetes service nodePort | `` |
+| `serviceAccount.create` | Creates a ServiceAccount for the pod. | `false` |
+| `serviceAccount.annotations` | Annotations to add to the service account. | `{}` |
+| `serviceAccount.name` | The name of the service account. Otherwise uses the fullname. | `` |
+| `serviceAccount.automountServiceAccountToken` | Opt out of API credential automounting. | `false` |
+| `strategy` | Specifies the strategy used to replace old Pods by new ones | `{}` |
+| `ingress.enabled` | Enables Ingress | `false` |
+| `ingress.annotations` | Ingress annotations | `{}` |
+| `ingress.ingressClassName` | Ingress class name | `""` |
+| `ingress.hosts.host` | Ingress accepted hostname | `nil` |
+| `ingress.hosts.paths` | Ingress paths list | `[]` |
+| `ingress.tls` | Ingress TLS configuration | `[]` |
+| `extraConfigmapMounts` | Additional configMap volume mounts for pgadmin4 pod | `[]` |
+| `extraSecretMounts` | Additional secret volume mounts for pgadmin4 pod | `[]` |
+| `extraContainers` | Sidecar containers to add to the pgadmin4 pod  | `"[]"` |
+| `existingSecret` | The name of an existing secret containing the pgadmin4 default password. | `""` |
+| `secretKeys.pgadminPasswordKey` | Name of key in existing secret to use for default pgadmin credentials. Only used when `existingSecret` is set. | `"password"` |
+| `extraInitContainers` | Sidecar init containers to add to the pgadmin4 pod  | `"[]"` |
+| `env.email` | pgAdmin4 default email. Needed chart reinstall for apply changes | `[email protected]` |
+| `env.password` | pgAdmin4 default password. Needed chart reinstall for apply changes | `SuperSecret` |
+| `env.pgpassfile` | Path to pgpasssfile (optional). Needed chart reinstall for apply changes | `` |
+| `env.enhanced_cookie_protection` | Allows pgAdmin4 to create session cookies based on IP address | `"False"` |
+| `env.contextPath` | Context path for accessing pgadmin (optional) | `` |
+| `envVarsFromConfigMaps` | Array of ConfigMap names to load as environment variables | `[]` |
+| `envVarsFromSecrets` | Array of Secret names to load as environment variables | `[]` |
+| `persistentVolume.enabled` | If true, pgAdmin4 will create a Persistent Volume Claim | `true` |
+| `persistentVolume.accessMode` | Persistent Volume access Mode | `ReadWriteOnce` |
+| `persistentVolume.size` | Persistent Volume size | `10Gi` |
+| `persistentVolume.storageClass` | Persistent Volume Storage Class | `unset` |
+| `persistentVolume.existingClaim` | Persistent Volume existing claim name | | `unset` |
+| `persistentVolume.subPath` | Subdirectory of the volume to mount at | `unset` |
+| `securityContext` | Custom [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) for pgAdmin4 pod | `` |
+| `containerSecurityContext` | Custom [security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) for pgAdmin4 container | `` |
+| `livenessProbe` | [liveness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) initial delay and timeout | `` |
+| `startupProbe` | [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) initial delay and timeout | `` |
+| `readinessProbe` | [readiness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) initial delay and timeout | `` |
+| `VolumePermissions.enabled` | Enables init container that changes volume permissions in the data directory  | `false` |
+| `extraInitContainers` | Init containers to launch alongside the app | `[]` |
+| `containerPorts.http` | Sets http port inside pgadmin container | `80` |
+| `resources` | CPU/memory resource requests/limits | `{}` |
+| `nodeSelector` | Node labels for pod assignment | `{}` |
+| `tolerations` | Node tolerations for pod assignment | `[]` |
+| `affinity` | Node affinity for pod assignment | `{}` |
+| `podAnnotations` | Annotations for pod | `{}` |
+| `podLabels` | Labels for pod | `{}` |
+| `namespace` | Namespace where to deploy resources | `null` |
+| `init.resources` | Init container CPU/memory resource requests/limits | `{}` |
+
+> The values for "extraConfigmapMounts.[].configMap" and "extraSecretMounts.[].secret" can be either a simple string
+> or a template string.
+> Then it will be resolved for you.
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example:
+
+```console
+$ # Helm 2
+helm install runix/pgadmin4 --name my-release \
+  --set env.password=SuperSecret
+$ # Helm 3
+helm install my-release runix/pgadmin4 \
+  --set env.password=SuperSecret
+```
+
+Alternatively, a YAML file that specifies the values for the parameters can be
+provided while installing the chart. For example:
+
+```console
+$ # Helm 2
+helm install runix/pgadmin4 --name my-release -f values.yaml
+$ # Helm 3
+helm install my-release runix/pgadmin4 -f values.yaml
+```
+
+> **Tip**: You can use the default [values.yaml](https://github.com/rowanruseler/helm-charts/blob/main/charts/pgadmin4/values.yaml) and look on [examples](https://github.com/rowanruseler/helm-charts/blob/main/charts/pgadmin4/examples/).
+
+[dpage/pgadmin4]: https://hub.docker.com/r/dpage/pgadmin4

charts/managed-identity-wallet/charts/pgadmin4/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 }}{{ .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 "pgadmin.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 "pgadmin.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "pgadmin.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  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 "pgadmin.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 port-forward $POD_NAME 8080:80
+{{- end }}

charts/managed-identity-wallet/charts/pgadmin4/templates/_helpers.tpl

@@ -0,0 +1,108 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "pgadmin.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 "pgadmin.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 "pgadmin.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "pgadmin.labels" -}}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+app.kubernetes.io/name: {{ include "pgadmin.name" . }}
+app.kubernetes.io/version: {{ .Values.image.tag | default .Chart.AppVersion | quote }}
+helm.sh/chart: {{ include "pgadmin.chart" . }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "pgadmin.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "pgadmin.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Generate chart secret name
+*/}}
+{{- define "pgadmin.secretName" -}}
+{{ default (include "pgadmin.fullname" .) .Values.existingSecret }}
+{{- end -}}
+
+{{/*
+Defines a JSON file containing server definitions. This allows connection information to be pre-loaded into the instance of pgAdmin in the container. Note that server definitions are only loaded on first launch, i.e. when the configuration database is created, and not on subsequent launches using the same configuration database.
+*/}}
+{{- define "pgadmin.serverDefinitions" -}}
+{
+  "Servers": {{ .Values.serverDefinitions.servers | toJson }}
+}
+{{- end -}}
+
+{{/*
+Return the appropriate apiVersion for deployment.
+*/}}
+{{- define "deployment.apiVersion" -}}
+{{- if semverCompare "<1.9.0-0" .Capabilities.KubeVersion.GitVersion -}}
+{{- print "apps/v1beta2" -}}
+{{- else -}}
+{{- print "apps/v1" -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Return the appropriate apiVersion for network policy.
+*/}}
+{{- define "networkPolicy.apiVersion" -}}
+{{- if semverCompare "<1.8.0-0" .Capabilities.KubeVersion.GitVersion -}}
+{{- print "extensions/v1beta1" -}}
+{{- else -}}
+{{- print "networking.k8s.io/v1" -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Renders a value that contains template.
+Usage:
+{{ include "common.tplvalues.render" ( dict "value" .Values.path.to.the.Value "context" $) }}
+*/}}
+{{- define "common.tplvalues.render" -}}
+    {{- if typeIs "string" .value }}
+        {{- tpl .value .context }}
+    {{- else }}
+        {{- tpl (.value | toYaml) .context }}
+    {{- end }}
+{{- end -}}
+
+{{/*
+Create the name of the namespace
+*/}}
+{{- define "pgadmin.namespaceName" -}}
+{{- default .Release.Namespace .Values.namespace }}
+{{- end }}

charts/managed-identity-wallet/charts/pgadmin4/templates/auth-secret.yaml

@@ -0,0 +1,13 @@
+{{- if not .Values.existingSecret }}
+{{- $fullName := include "pgadmin.fullname" . -}}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ $fullName }}
+  namespace: {{ include "pgadmin.namespaceName" . }}
+  labels:
+    {{- include "pgadmin.labels" . | nindent 4 }}
+type: Opaque
+data:
+  password: {{ default "SuperSecret" .Values.env.password | b64enc | quote }}
+{{- end }}