feat(): polish deployment environment

docs/deployment-environment-doc.md

@@ -0,0 +1,81 @@
+
+# **Application Deployment Documentation**
+
+## **1. Prerequisites**
+- **Tools and Software Required**:
+  - Helm version (e.g., `Helm 3.x`)
+  - Kubernetes version (e.g., `1.25+`)
+  - Minikube/Cluster setup
+  - Other dependencies (e.g., Docker, kubectl, etc.)
+- **Environment Setup**:
+  - Access to the Kubernetes cluster
+  - Required configurations or credentials
+
+
+## **3. Helm Chart Structure**
+- **Chart Overview**:  
+  - Structure of the Helm chart (values.yaml, templates, etc.).
+  - Purpose of critical templates (e.g., Deployment, Service, ConfigMap).  
+  - Default vs. custom configurations.  
+- **Customization**:  
+  - How to override values.yaml using custom configurations.  
+    Example:
+    ```bash
+    helm install mediator ./mediator-charts --values custom-values.yaml
+    ```
+  - mandatory values are;
+
+  **MONGO_DBN**,
+  **MONGO_URI**, 
+  **SERVER_LOCAL_PORT** and 
+  **SERVER_PUBLIC_DOMAIN**
+
+
+## **4. Deployment Guide**
+- **Steps to Deploy**:
+  1. Clone the repository:
+     ```bash
+     git clone https://github.com/adorsys/didcomm-mediator-rs.git
+     ```
+  2. Install dependencies:
+     ```bash
+     helm dependency update mediator-charts
+     ```
+  3. Deploy using Helm:
+     ```bash
+     helm install mediator mediator-charts --namespace didcomm-mediator
+     ```
+  4. Verify deployment status:
+     ```bash
+     kubectl get pods -n didcomm-mediator
+     kubectl get services -n didcomm-mediator
+     ```
+- **Notes on Namespaces**:
+  - Importance of creating and using the correct namespace.
+- **Rollback Instructions**:
+  - How to roll back to a previous release:
+    ```bash
+    helm rollback my-app <revision>
+    ```
+
+---
+
+## **5. Accessing the Application**
+- **Port Forwarding**:
+  - Steps to forward the service ports locally for testing:
+    ```bash
+    kubectl port-forward service/<service-name> 8080:<target-port>
+    ```
+- **Ingress/LoadBalancer Details**:
+  - Steps to access the application if exposed via Ingress or LoadBalancer.
+
+## **7. Monitoring and Debugging**
+- **Logs**:
+  - How to fetch logs for debugging:
+    ```bash
+    kubectl logs <pod-name> -n didcomm-mediator
+    ```
+- **Monitoring Tools**:
+  - Mention tools used (e.g., Prometheus, Grafana, ELK Stack).
+  - Steps to configure and access monitoring dashboards.
+

mediator-charts/templates/env-configmap.yaml

@@ -1,12 +1,13 @@
 apiVersion: v1
 data:
-  MONGO_DBN: mediator-coordination
-  MONGO_URI: mongodb://mongodb:27017
-  SERVER_LOCAL_PORT: "3000"
-  SERVER_PUBLIC_DOMAIN: http://alice-mediator.com
-  STORAGE_DIRPATH: crates/generic-server/target/storage
+  MONGO_DBN: {{ .Values.envConfig.MONGO_DBN }}
+  MONGO_URI: {{ .Values.envConfig.MONGO_URI }}
+  SERVER_LOCAL_PORT: {{ .Values.envConfig.SERVER_LOCAL_PORT }}
+  SERVER_PUBLIC_DOMAIN: {{ .Values.envConfig.SERVER_PUBLIC_DOMAIN }}
+
 kind: ConfigMap
 metadata:
+  namespace: {{ .Values.namespace }}
   creationTimestamp: null
   labels:
     io.kompose.service: mediator-env

mediator-charts/templates/ingress.yaml

@@ -2,7 +2,7 @@ apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
   name: didcomm-mediator-ingress
-  namespace: default
+  namespace: {{ .Values.namespace }}
   annotations:
     nginx.ingress.kubernetes.io/rewrite-target: "/" # Rewrite paths if necessary
 spec:

mediator-charts/templates/mediator-deployment.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ .Release.Name }}-mediator-deployment
+  namespace: {{ .Values.namespace }}
 spec:
   replicas: {{ .Values.replicaCount }}
   selector:
@@ -27,7 +28,7 @@ spec:
             - name: MONGO_PASSWORD
               valueFrom:
                 secretKeyRef:
-                  name: {{ .Release.Name }}-mongo-password
+                  name: {{ .Release.Name }}-secret
                   key: password
             - name: MONGO_HOST
               value: {{ .Release.Name }}-mongodb-service

mediator-charts/templates/mediator-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: {{ .Release.Name }}-mediator-service
+  namespace: {{ .Values.namespace }}
 spec:
   selector:
     app: {{ .Release.Name }}-mediator

mediator-charts/templates/mongodb-deployment.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ .Release.Name }}-mongodb-deployment
+  namespace: {{ .Values.namespace }}
 spec:
   replicas: 1
   selector:
@@ -27,7 +28,7 @@ spec:
             - name: MONGO_PASSWORD
               valueFrom:
                 secretKeyRef:
-                  name: {{ .Release.Name }}-mongo-password
+                  name: {{ .Release.Name }}-secret
                   key: password
           volumeMounts:
             - name: {{ .Release.Name }}-mongo-persistent-storage

mediator-charts/templates/mongodb-pv.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: PersistentVolume
 metadata:
   name: {{ .Release.Name }}-mongo-pv
+  namespace: {{ .Values.namespace }}
 spec:
   capacity:
     storage: {{ .Values.mongoVolume.persistentVolume.storageSize }}

mediator-charts/templates/mongodb-pvc.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: {{ .Release.Name }}-mongo-pvc
+  namespace: {{ .Values.namespace }}
 spec:
   accessModes:
     - ReadWriteOnce

mediator-charts/templates/mongodb-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: {{ .Release.Name }}-mongodb-service
+  namespace: {{ .Values.namespace }}
 spec:
   selector:
     app: {{ .Release.Name }}-mongodb

mediator-charts/templates/secrets.yaml

@@ -1,15 +1,8 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ .Release.Name }}-mongo-username
+  name: {{ .Release.Name }}-secret
+  namespace: {{ .Values.namespace }}
 type: Opaque
 stringData:
-  username: root
-
-apiVersion: v1
-kind: Secret
-metadata:
-  name: {{ .Release.Name }}-mongo-password
-type: Opaque
-stringData:
-  password: root
+  password: root

mediator-charts/values.yaml

@@ -1,4 +1,5 @@
 replicaCount: 1
+namespace: didcomm-mediator
 
 mongodb:
   databaseName: mongodb
@@ -18,4 +19,10 @@ mongoVolume:
     pathOnHost: /var/lib/mongodb 
 
 
-  mountPath: /var/lib/mongodb
+  mountPath: /var/lib/mongodb
+
+envConfig: 
+  MONGO_DBN: mediator-coordination
+  MONGO_URI: mongodb://mongodb:27017
+  SERVER_LOCAL_PORT: "3000"
+  SERVER_PUBLIC_DOMAIN: http://alice-mediator.com