From b9a6e209d7d4d8e1448767ce6869c5f7fcc7e2ac Mon Sep 17 00:00:00 2001
From: subhash kumar singh <subh.singh@samsung.com>
Date: Wed, 17 May 2023 12:54:28 +0000
Subject: [PATCH] Documentation for RICDMS deployment manifest

Deployment manifest of RICDMS to run in kubernetes environment.

Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
Change-Id: I0ad08310cc1c1cb56c322a80f7c168f88b171a00
---
 README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 54 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f1347f4..fd717cf 100644
--- a/README.md
+++ b/README.md
@@ -25,4 +25,57 @@ $./ricdms
 
 It will start the RICDMS on port `:8000`
 
-### 
\ No newline at end of file
+### Kubernetes
+
+Build the image
+```
+$ make image
+```
+
+Add the changes to `deployment/dms-config.yaml` as per your environment (refer your `.kubeconfig` file).
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: kube-env
+data:
+  config: |
+    apiVersion: v1
+    clusters:
+    - cluster:
+        certificate-authority-data: <certificate>
+        server: https://<kube-ip>:<kube-port>
+      name: <name>
+    contexts:
+    - context:
+        cluster:<cluster-name>
+        user: <user>
+      name: <name>
+    current-context: <context>
+    kind: Config
+    preferences: {}
+    users:
+    - name: <name>
+      user:
+        client-certificate-data: <cliet-cert> 
+        client-key-data: <client-key-data>
+```
+
+Apply the deployment yaml :
+```
+$ kubectl apply -f deployment
+```
+
+Make sure that following pod, svc and configmap is created :
+```sh
+$ kubectl get po,svc,config
+NAME                                          READY   STATUS    RESTARTS   AGE
+pod/dms-server-r2k64                          1/1     Running   0          15s
+
+NAME                             TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
+service/ric-dms-service          NodePort    <cluster-IP>    <none>        8000:32625/TCP   15s
+
+NAME                         DATA   AGE
+configmap/kube-env           1      90s
+```
+
-- 
2.16.6