feat: Helm charts created

README.md

@@ -145,6 +145,14 @@ docker build \
    .
 ```
 
+## Using Helm
+### To deploy the application on Kubernetes using Helm, follow this [installation guide](/helm/README.md) containing
+
+- Helm Chart structure
+- Quick Note
+- Helm Commands
+
+
 ## Roadmap
 
 The contents in this repository started out as a simple mediator built using Credo that can be used for development. Over time we've added some features, but there's still a lot we want to add to this repository over time. Some things on the roadmap:

helm/README.md

@@ -0,0 +1,39 @@
+# Installing DIDComm Mediator Credo on k8s with Helm
+
+### Three manifest files are used in Helm charts
+1. Deployment.yaml
+This file contains the replicaset, container image name, container port, and environment variables for the container. This will create a Deployment type object for the application.
+
+2. Service.yaml
+The service file is to create a service-type object to connect with the pods and to access the application by redirecting traffic through it without exposing the pod directly.
+
+3. Ingress.yaml
+Ingress is one layer on top of the service that will connect with the load balancer to redirect the traffic to the service. If multiple services are present, it can also redirect traffic to them by path-based routing. Similar to a service, it will redirect the traffic to the service without exposing it.
+
+## Helm Chart Note
+- The values.yaml file contains 4 sections: Common Values, Deployment Values, Service Values, and Ingress Values.
+- These values will be passed inside the manifest files in the templates folder.
+- Deployment env values should be replaced with your values in the values.yaml file's Deployment Values environment section.
+
+## Helm Commands to Install the Application.
+- Installing the application from the root directory with default values of the values.yaml file.
+```bash
+helm install YOUR_HELM_RELEASE_NAME ./helm/mediator/
+```
+
+- Changing the values as needed
+```bash
+helm install YOUR_HELM_RELEASE_NAME ./helm/mediator/ --set KEY=VALUE
+```
+- Changing multiple values
+```bash
+helm install YOUR_HELM_RELEASE_NAME ./helm/mediator/ --set KEY1=VALUE1,KEY2=VALUE2
+```
+
+- After installing, you can upgrade the values with the ```helm upgrade``` command.
+```bash
+helm upgrade YOUR_HELM_RELEASE_NAME ./helm/mediator/ --set KEY=VALUE
+```
+```bash
+helm upgrade YOUR_HELM_RELEASE_NAME ./helm/mediator/ --set KEY1=VALUE1,KEY2=VALUE2
+```

helm/mediator/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: helm
+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: "1.16.0"

helm/mediator/templates/deployment.yaml

@@ -0,0 +1,46 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ .Values.deployment_name }}
+  namespace: {{ .Values.namespace }}
+  labels:
+    app: {{ .Values.deployment_name }}
+spec:
+  replicas: {{ .Values.replicas }}
+  selector:
+    matchLabels:
+      app: {{ .Values.deployment_name }}
+  template:
+    metadata:
+      labels:
+        app: {{ .Values.deployment_name }}
+    spec:
+      containers:
+      - name: {{ .Values.container.name }}
+        image: " {{ .Values.image.name }}:{{ .Values.image.tag }} "
+        imagePullPolicy: Always
+        ports:
+        - containerPort: {{ .Values.container.port }}
+        env:
+        - name: AGENT_PORT
+          value: "{{ .Values.environment.AGENT_PORT }}"
+        - name: AGENT_NAME
+          value: "{{ .Values.environment.AGENT_NAME }}"
+        - name: WALLET_NAME
+          value: "{{ .Values.environment.WALLET_NAME }}"
+        - name: WALLET_KEY
+          value: "{{ .Values.environment.WALLET_KEY }}"
+        - name: POSTGRES_USER
+          value: "{{ .Values.environment.POSTGRES_USER }}"
+        - name: POSTGRES_PASSWORD
+          value: "{{ .Values.environment.POSTGRES_PASSWORD }}"
+        - name: POSTGRES_HOST
+          value: "{{ .Values.environment.POSTGRES_HOST }}"
+        - name: POSTGRES_ADMIN_USER
+          value: "{{ .Values.environment.POSTGRES_ADMIN_USER }}"
+        - name: POSTGRES_ADMIN_PASSWORD
+          value: "{{ .Values.environment.POSTGRES_ADMIN_PASSWORD }}"
+        - name: AGENT_ENDPOINTS
+          value: "{{ .Values.environment.AGENT_ENDPOINTS }}"
+        - name: LOG_LEVEL
+          value: "{{ .Values.environment.LOG_LEVEL }}"

helm/mediator/templates/ingress.yaml

@@ -0,0 +1,24 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  annotations:
+    cert-manager.io/cluster-issuer: {{ .Values.cluster_issuer_name }}
+    kubernetes.io/ingress.class: nginx
+  name: {{ .Values.ingress_name }}
+  namespace: {{ .Values.namespace }}
+spec:
+  rules:
+  - host: {{ .Values.host_name }}
+    http:
+      paths:
+      - backend:
+          service:
+            name: {{ .Values.service_name }}
+            port:
+              number: {{ .Values.container.port }}
+        path: /
+        pathType: Prefix
+  tls:
+  - hosts:
+    - {{ .Values.host_name }}
+    secretName: {{ .Values.certificate_secret_name }}

helm/mediator/templates/service.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.service_name }}
+  namespace: {{ .Values.namespace }}
+spec:
+  selector:
+    app: {{ .Values.deployment_name }}
+  ports:
+    - port: {{ .Values.container.port }}

helm/mediator/values.yaml

@@ -0,0 +1,39 @@
+## Common Values
+namespace: mediator
+
+
+## Deployment Values
+deployment_name: mediator
+replicas: 1
+
+image: 
+  name: ghcr.io/openwallet-foundation/didcomm-mediator-credo
+  tag: latest
+
+container:
+  name: mediator
+  port: 3000
+
+environment:
+  AGENT_PORT: 3000
+  AGENT_NAME: Mediator
+  WALLET_NAME: mediator
+  WALLET_KEY: ${WALLET_KEY}
+  POSTGRES_USER: ${POSTGRES_USER}
+  POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+  POSTGRES_HOST: ${POSTGRES_HOST}
+  POSTGRES_ADMIN_USER: ${POSTGRES_ADMIN_USER}
+  POSTGRES_ADMIN_PASSWORD: ${POSTGRES_ADMIN_PASSWORD}
+  AGENT_ENDPOINTS: "https://my-mediator.com,wss://my-mediator.com"
+  LOG_LEVEL: 2
+
+
+## Service Values
+service_name: mediator
+
+
+## Ingress Values
+ingress_name: mediator_ingress
+cluster_issuer_name: CLUSTER_ISSUER-NAME
+host_name: HOST_NAME
+certificate_secret_name: CERTIFICATE_SECRET_NAME