summaryrefslogtreecommitdiffstats
path: root/docs/platform/installation/user-guide/uui-guide.rst
blob: ef52da9f8eeab9471d95a21de1c4ab85fb096273 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.. contents::
   :depth: 3
..


**1. Confirm Usecase-UI MicroService**
======================================

Confirm that the Usecase-UI microservice has been successfully registered in MSB with OOM.

**2. Register Usecase-UI MicroService**
=======================================

If Usecase-UI microservice does not exist in MSB, please register them manually.
::
            
    curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-server", "version": "v1", "url": "/api/usecaseui-server/v1","protocol": "REST", "nodes": [{"ip": "${UUI_SERVER_IP}","port": "8082"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"
    curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-ui", "version": "v1", "url": "/usecase-ui","path": "/iui/usecaseui","protocol": "UI", "nodes": [{"ip": "${UUI_IP}","port": "8080"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"

**3. Open Usecase-UI Home**
===========================

Please open Usecase-UI dashboard page through your browser.

::

  http://${MSB_IP}:30280/iui/usecaseui/
  
**4. Specific Pages Function**
==============================

Usecase-UI project consists of 5 modules which are *Home*, *Cusomer*, *Monitor*, *Services* and *Network Topology*. 

*4.1. Home Module*

|homepage|

.. |homepage| image:: ../../images/usecaseui-architecture-homepage.png
   :width: 5.97047in
   :height: 3.63208in

*Home* module is the entrance of the whole project. In this module, users can have a glimpse of the general infomation of specific modules. e.g. the **SERVICES** block shows the general statistic data of *Lifecycle management* module and the **PACKAGE** block shows the total numbers of NS, VNF and PNF which are shown in *Package Management* module. Also, the **ALARM** and **VM PERFORMANCE** block show the infomation of system alarm. If users need more, the ``View Details`` button will help.

*4.2. Cusomer Module*

|customer|

.. |customer| image:: ../../images/usecaseui-architecture-customer.png
   :width: 7.97047in
   :height: 3.63208in

*4.3. Services Module*

This module consists of two parts. One is Lifecycle Management, the other is 5G Slicing Management.

* Lifecycle Management

|lifecycle|

.. |lifecycle| image:: ../../images/lifecycle-manage.png
   :width: 7.97047in
   :height: 3.63208in

In Frankfurt Release, MDONS instance has been added to the orginal service type. Click the following link to see more detal:
https://wiki.onap.org/display/DW/UUI

* 5G Slicing Management

This module consists of two parts. 
The first part is CSMF component which provides the functions of creating network slicing and displaying the created slicing. Also, customers can use this page to activate, deactivate and terminate the slcing.

|CSMF Management Page|

.. |CSMF Management Page| image:: ../../images/csmf-management.png
   :width: 7.97047in
   :height: 3.63208in

|Create CSMF Slicing|

.. |Create CSMF Slicing| image:: ../../images/csmf-create-slicing.png
   :width: 7.97047in
   :height: 3.63208in

The second part is NSMF component which includes two different modules. The first one is the slicing task management which is responsible for presenting the tasks created in CSMF portal and processing those tasks. The second one is slicing resource management which is responsible for listing all the NS, NSI and NSSI resource and showing the relation between them.

|Slicing Task Management|

.. |Slicing Task Management| image:: ../../images/slicing-task.png
   :width: 7.97047in
   :height: 3.63208in

|Slicing Resource Management|

.. |Slicing Resource Management| image:: ../../images/slicing-res.png
   :width: 7.97047in
   :height: 3.63208in

*4.4. Package Management*

|package|

.. |package| image:: ../../images/package-manage.png
   :width: 7.97047in
   :height: 3.63208in

*4.5. Network Topology Module*

*4.6. Monitor Module*

This module is responsible for presenting all kinds of monitoring information. In Frankfurt Release, 5G Slicing monitoring data can be present.   

|Slicing Monitor|

.. |Slicing Monitor| image:: ../../images/slicing-monitor.png
   :width: 7.97047in
   :height: 3.63208in