256 integrate health checks and monitoring for the server e5 #297
+759
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…into 245-integration-environment-for-didcomm-mediator-server-deployment-e6
…into 245-integration-environment-for-didcomm-mediator-server-deployment-e6
…se and renamed files.
…6-integrate-health-checks-and-monitoring-for-the-server-e5
…cks-and-monitoring-for-the-server-e5
…ured promethus diasboard
Tekum-Emmanuella
requested review from
Christiantyemele,
Hermann-Core,
Blindspot22 and
ndefokou
Christiantyemele
requested changes
Jan 23, 2025
Comment on lines
+1
to
+3
| target/ | ||
| **/target/ | ||
| .idea/ |
There was a problem hiding this comment.
do not push this file
Comment on lines
+1
to
+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://mongodb:27017" |
There was a problem hiding this comment.
do not push this too
Comment on lines
27
to
33
|
|
||
| # Environment variables files | ||
| .env.example | ||
| .env | ||
|
|
||
|
|
||
| # Reference crate | ||
| mediator-server |
There was a problem hiding this comment.
also remove this file
| env_file: | ||
| - .env | ||
| environment: | ||
| - MONGODB_URI=mongodb://mongodb:27019/your_database_name |
There was a problem hiding this comment.
why not read the MONGO_URI from the env file
Comment on lines
+1
to
+35
| name: Publish Image | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - '*' | ||
| tags: | ||
| - 'v*' | ||
|
|
||
| env: | ||
| IMAGE_NAME: didcomm-mediator-rs | ||
|
|
||
| jobs: | ||
| push: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| packages: write | ||
| contents: read | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Build image | ||
| run: docker build . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}" | ||
|
|
||
| - name: Log in to registry | ||
| run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin | ||
|
|
||
| - name: Push image | ||
| run: | | ||
| IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME | ||
|
|
||
| # Ensure all uppercase characters are converted to lowercase | ||
| IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]') | ||
| # Strip the git ref prefix from the version |
There was a problem hiding this comment.
remove this file
Comment on lines
+1
to
+80
|
|
||
| # **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. |
There was a problem hiding this comment.
This changes are not related to the isssue
Comment on lines
+1
to
+19
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: {{ .Release.Name }}-mongodb-deployment | ||
| namespace: {{ .Values.namespace }} | ||
| spec: | ||
| replicas: 1 | ||
| selector: | ||
| matchLabels: | ||
| app: {{ .Release.Name }}-mongodb | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app: {{ .Release.Name }}-mongodb | ||
| spec: | ||
| containers: | ||
| - name: mongodb | ||
| image: mongo:latest | ||
| ports: |
There was a problem hiding this comment.
remove all the charts folder
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.