Update of developer info for using so monitoring

Issue-ID: SO-3103

Signed-off-by: Sithara Nambiar <sitharav.aredath@huawei.com>
Change-Id: I620d7221a805751c675d984b2a5bf02b1970f14d

diff --git a/docs/developer_info/Working_with_so_monitoring.rst b/docs/developer_info/Working_with_so_monitoring.rst
new file mode 100644 (file)
index 0000000..18b6d94
--- /dev/null
+++ b/docs/developer_info/Working_with_so_monitoring.rst
@@ -0,0 +1,70 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+Working with SO Monitoring
+==========================
+
+After the SO code is fully deployed, certain changes needs to be made in order to access the so-monitoring ui.
+
+1. Change the service type to NodePort
+---------------------------------------
+
+By default, the type of the so monitoring service is ClusterIP, which makes the Service only reachable from within the cluster.
+This is changed to NodePort, which is used to expose the service at a static port . Hence we will be able to contact the NodePort Service, from outside the cluster, by requesting <NodeIP>:<NodePort>.
+
+Command used to get the service configuration of so monitoring is:
+
+**sudo kubectl edit svc so-monitoring -n onap**
+
+.. image:: ../images/nodeport.png
+
+2. Add the credentials to login
+--------------------------------
+
+The override.yaml needs to be added with the login credentials, that is the username and the password in encrypted form.
+
+.. code-block:: bash
+
+ spring:
+   main:
+     allow-bean-definition-overriding: true
+   security:
+     usercredentials:
+     -                                         
+       username: gui
+       password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke'
+       role: GUI-Client
+
+This override.yaml can be directly edited in case of local setup using docker.
+
+When deploying in any environment  using OOM, then after deployment the configmap needs to be edited. As configmap is the one reading the override.yaml.
+
+**Note** : Before deployment , if we add these changes in override.yaml ,then it may give parsing error in configmap while deployment. And after deployment the permissions on override.yaml don't allow us to edit it. So the best option is to edit the configmap using the below command and restart the pod. 
+
+**kubectl -n onap edit configmap dev-so-monitoring-app-configmap**
+
+.. image:: ../images/configmap.png
+
+Special care needs to be given to the indentation. spring needs to be inline with the mso already present and others added accordingly.
+
+3. Login to SO Monitoring
+-------------------------
+
+We need to first identify the external port which its mapped to using the following command : 
+
+**sudo kubectl -n onap get svc | grep so-monitoring**
+
+.. image:: ../images/nodemap.png
+
+Then access the UI of so monitoring , for example by  http://<IP>:30224/ 
+
+username : gui,
+password: password1$
+
+
+.. image:: ../images/ui.png
+
+
+
+

diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index 10ea836..63338de 100644 (file)
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -11,6 +11,7 @@ SO Developer Information
 
    Building_SO.rst
    Working_with_SO_Docker.rst
+   Working_with_so_monitoring.rst
    Camunda_Cockpit_Community_Edition.rst
    Camunda_Cockpit_Enterprise_Edition.rst
    Camunda_Modeler.rst

diff --git a/docs/images/configmap.png b/docs/images/configmap.png
new file mode 100644 (file)
index 0000000..3683de3
Binary files /dev/null and b/docs/images/configmap.png differ

diff --git a/docs/images/nodemap.png b/docs/images/nodemap.png
new file mode 100644 (file)
index 0000000..8dfda6c
Binary files /dev/null and b/docs/images/nodemap.png differ

diff --git a/docs/images/nodeport.png b/docs/images/nodeport.png
new file mode 100644 (file)
index 0000000..53bc02f
Binary files /dev/null and b/docs/images/nodeport.png differ

diff --git a/docs/images/ui.png b/docs/images/ui.png
new file mode 100644 (file)
index 0000000..1c075ba
Binary files /dev/null and b/docs/images/ui.png differ