245 integration environment for didcomm mediator server deployment e6

.dockerignore

@@ -0,0 +1,2 @@
+target/
+**/target/

.env

@@ -0,0 +1,5 @@
+SERVER_PUBLIC_DOMAIN="http://didcomm-mediator.com"
+SERVER_LOCAL_PORT="8080"
+STORAGE_DIRPATH="crates/generic-server/target/storage"
+MONGO_DBN="mediator-coordination"
+MONGO_URI="mongodb://localhost:27017/"

.github/workflows/package.yml

@@ -0,0 +1,58 @@
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  pull_request:
+
+env:
+  IMAGE_NAME: ghcr.io/adorsys/didcomm-mediator-rs
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install Docker Compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+
+      - name: Log in to GitHub Container Registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Build Docker image
+        run: |
+          echo "Checking for .env file..."
+          if [ -f .env ]; then
+            echo ".env file exists."
+          else
+            echo ".env file does not exist."
+            exit 1
+          fi
+
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          [[ "${{ github.ref }}" == "refs/heads/main" ]] && VERSION=latest
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          echo "Building image with version: $VERSION"
+          docker-compose build
+          docker tag ${IMAGE_NAME}:latest ${IMAGE_NAME}:${VERSION}
+
+      - name: Push Docker image
+        run: |
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          [[ "${{ github.ref }}" == "refs/heads/main" ]] && VERSION=latest
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          echo "Pushing image ${IMAGE_NAME}:${VERSION}"
+          docker push ${IMAGE_NAME}:${VERSION}

.gitignore

@@ -27,7 +27,7 @@ Cargo.lock
 
 # Environment variables files 
 .env.example
-.env
+
 
 # Reference crate
 mediator-server

Dockerfile

@@ -0,0 +1,30 @@
+FROM rust:latest as builder
+
+WORKDIR /app
+
+COPY . .
+
+# Build the server
+RUN cargo build --release
+
+# Use a minimal image for running the server
+FROM ubuntu
+
+RUN apt update && apt install -y libpq5 && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Set the storage directory path
+ENV STORAGE_DIRPATH="crates/generic-server/target/storage"
+
+# Copy the built binary
+COPY --from=builder /app/target/release/didcomm-mediator /usr/local/bin/didcomm-mediator
+
+# Copy the default .env file
+COPY .env /app/.env
+
+# Expose the necessary port
+EXPOSE 8080
+
+# Set an entrypoint script to handle the environment file
+ENTRYPOINT ["/bin/sh", "-c", "env $(cat ${ENV_FILE:-/app/.env} | xargs) didcomm-mediator"]

docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3.8"
+services:
+  mediator:
+    build:
+      context: .
+    container_name: didcomm-mediator
+    image: ghcr.io/adorsys/didcomm-mediator-rs:latest
+    ports:
+      - 3000:8080
+    env_file:
+      - .env
+    depends_on:
+      - mongodb
+  mongodb:
+    image: mongo:latest
+    container_name: mongodb
+    env_file:
+      - .env
+    volumes:
+      - mongo-data:/data/db
+volumes:
+  mongo-data: null

docs/environment-setup.md

@@ -0,0 +1,47 @@
+# DIDComm Mediator Integration Environment Setup
+
+This guide provides step-by-step instructions to set up the integration environment for deploying, testing, and interacting with the Rust-based DIDComm mediator server.
+
+## Prerequisites
+Before you begin, ensure the following are installed on your system:
+- Docker: version 20+([install docker](https://docs.docker.com/engine/install/debian/))
+- Rust: latest stable version ([install rust](https://www.rust-lang.org/tools/install))
+- MongoDB: latest stable version ([install mongodb](https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/))
+
+This documentation assumes you have clone the [mediator](https://github.com/adorsys/didcomm-mediator-rs) and are in the root of the project
+
+## step 1: Setup the environment variables
+Modify the ```.env``` file with the right values for the variables
+
+## Step 2: Start The Environment
+
+```sh
+ docker-compose up -d
+```
+Verify that all containers are running by executing
+```sh
+docker-compose ps
+``` 
+## Step 3: Test Connectivity
+Use a tool like Postman or curl to verify that the server is running and responding.
+```sh 
+curl -X GET http://0.0.0.0:8080/ \
+-H "Content-Type: application/json" \
+```
+Expected Response: A JSON object indicating the mediator is operational 
+
+## Step 4: Logging And Monitoring
+For real time monitoring of the logs run the command
+```sh 
+docker logs -f didcomm-mediator
+```
+Or save them in a file using the command
+```sh
+docker logs didcommm-mediator > mediator.log
+```
+
+## Step 5: Cleanup
+To Stop and remove the environment
+```sh
+docker-compose down
+```

k8s/elasticsearch-statefulset.yaml

@@ -0,0 +1,38 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: elasticsearch
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: elasticsearch
+  serviceName: es-headless
+  template:
+    metadata:
+      labels:
+        app: elasticsearch
+    spec:
+      containers:
+        - name: elasticsearch
+          image: docker.elastic.co/elasticsearch/elasticsearch:7.10.2
+          ports:
+            - containerPort: 9200
+          volumeMounts:
+            - name: es-data
+              mountPath: /usr/share/elasticsearch/data
+          resources:
+            requests:
+              memory: "2Gi"  # Minimum memory for the container
+              cpu: "1"       # Minimum CPU for the container
+            limits:
+              memory: "4Gi"  # Maximum memory for the container
+              cpu: "2"       # Maximum CPU for the container
+  volumeClaimTemplates:
+    - metadata:
+        name: es-data
+      spec:
+        accessModes: ["ReadWriteOnce"]
+        resources:
+          requests:
+            storage: 10Gi

k8s/env-configmap.yaml

@@ -0,0 +1,13 @@
+apiVersion: v1
+data:
+  MONGO_DBN: mediator-coordination
+  MONGO_URI: mongodb://localhost:27017/
+  SERVER_LOCAL_PORT: "8080"
+  SERVER_PUBLIC_DOMAIN: http://alice-mediator.com
+  STORAGE_DIRPATH: crates/generic-server/target/storage
+kind: ConfigMap
+metadata:
+  creationTimestamp: null
+  labels:
+    io.kompose.service: mediator-env
+  name: env

k8s/es-pvc.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: es-data
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi

k8s/fluentd-configmap.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: fluentd-config
+data:
+  fluent.conf: |
+    <match **>
+      @type elasticsearch
+      host elasticsearch.default.svc.cluster.local
+      port 9200
+      logstash_format true
+    </match>

k8s/fluentd-daemonset.yaml

@@ -0,0 +1,23 @@
+apiVersion: apps/v1
+kind: DaemonSet
+metadata:
+  name: fluentd
+spec:
+  selector:
+    matchLabels:
+      app: fluentd
+  template:
+    metadata:
+      labels:
+        app: fluentd
+    spec:
+      containers:
+        - name: fluentd
+          image: fluent/fluentd:v1.12
+          volumeMounts:
+            - name: config
+              mountPath: /fluentd/etc
+      volumes:
+        - name: config
+          configMap:
+            name: fluentd-config

k8s/ingress.yaml

@@ -0,0 +1,24 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: didcomm-mediator-ingress
+  namespace: default
+  annotations:
+    nginx.ingress.kubernetes.io/rewrite-target: "/" # Rewrite paths if necessary
+spec:
+  ingressClassName: nginx # Specifies the NGINX Ingress Controller
+  rules:
+  - host: didcomm-mediator.com
+    http:
+      paths:
+      - path: /
+        pathType: Prefix
+        backend:
+          service:
+            name: mediator
+            port:
+              number: 8080
+  tls:
+  - hosts:
+    - mediator.example.com # Same as the host in rules
+    secretName: mediator-tls # Replace with your TLS secret name for HTTPS

k8s/kibana-deployment.yaml

@@ -0,0 +1,19 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: kibana
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: kibana
+  template:
+    metadata:
+      labels:
+        app: kibana
+    spec:
+      containers:
+        - name: kibana
+          image: docker.elastic.co/kibana/kibana:7.10.2
+          ports:
+            - containerPort: 5601

k8s/kibana-service.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: kibana
+spec:
+  selector:
+    app: kibana
+  ports:
+    - protocol: TCP
+      port: 5601
+      targetPort: 5601
+  type: NodePort

k8s/mediator-deployment.yaml

@@ -0,0 +1,59 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  annotations:
+    kompose.cmd: kompose convert -f ../docker-compose.yml
+    kompose.version: 1.27.0 (b0ed6a2c9)
+  creationTimestamp: null
+  labels:
+    io.kompose.service: mediator
+  name: mediator
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      io.kompose.service: mediator
+  strategy: {}
+  template:
+    metadata:
+      annotations:
+        kompose.cmd: kompose convert -f ../docker-compose.yml
+        kompose.version: 1.27.0 (b0ed6a2c9)
+      creationTimestamp: null
+      labels:
+        io.kompose.service: mediator
+    spec:
+      containers:
+        - env:
+            - name: MONGO_DBN
+              valueFrom:
+                configMapKeyRef:
+                  key: MONGO_DBN
+                  name: env
+            - name: MONGO_URI
+              valueFrom:
+                configMapKeyRef:
+                  key: MONGO_URI
+                  name: env
+            - name: SERVER_LOCAL_PORT
+              valueFrom:
+                configMapKeyRef:
+                  key: SERVER_LOCAL_PORT
+                  name: env
+            - name: SERVER_PUBLIC_DOMAIN
+              valueFrom:
+                configMapKeyRef:
+                  key: SERVER_PUBLIC_DOMAIN
+                  name: env
+            - name: STORAGE_DIRPATH
+              valueFrom:
+                configMapKeyRef:
+                  key: STORAGE_DIRPATH
+                  name: env
+          image: ghcr.io/adorsys/didcomm-mediator-rs:merge
+          name: didcomm-mediator
+          ports:
+            - containerPort: 8080
+          resources: {}
+      restartPolicy: Always
+status: {}