Merge "Added validation on matching required fields"
[policy/engine.git] / docs / platform / policygui.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 **********
5 Policy GUI
6 **********
7
8 .. contents::
9     :depth: 3
10
11 | The POLICY GUI is a graphical user interface, available via web-access, for **creating and managing** policies.   
12 |
13 | The targeted users are those responsible for creating and managing policies that control network operations, including policy based network configuration and auto-corrective actions.  This typically includes network and service designers, operations engineers and security experts. 
14 |
15 | The GUI consists of the **Editor, Dictionary, PDP, Push, Roles, Admin** and **Dashboard** Tabs; which provide for an intuitive manner for policy rules to be created, changed, and managed.  
16
17
18 Access to the POLICY GUI
19 ^^^^^^^^^^^^^^^^^^^^^^^^
20
21 The POLICY GUI can be accessed via the ONAP Portal.
22
23 .. image:: PolicyGUI_Access.png
24
25
26 POLICY Editor
27 ^^^^^^^^^^^^^
28
29 The POLICY **Editor** tab supports the following **key** functionality:  
30
31 •     Create Policies and Scopes
32 •     Edit, View and Describe Policies
33 •     Rename, Move and Clone Policies
34 •     Switch Versions of Policies
35 •     Delete Policies and Scopes
36 •     List Policies and Scopes 
37 •     Export and Import Policies
38 •     Search for Policies 
39
40 .. image:: PolicyGUI_Editor.png
41
42
43 Scope Management
44 ----------------
45
46 A Scope must exist before a policy can be created.  The figure below shows how to add and manage Scopes.
47
48 .. image:: PolicyGUI_Editor_Scope.png
49
50
51 Policy Creation
52 ---------------
53
54 The most important function of the GUI is to facilitate the creation of policies.  
55 The figure below specifies how a policy can be created. 
56
57 .. image:: PolicyGUI_Editor_CreatePolicy.png
58
59
60 Managing a Policy 
61 -----------------
62
63 The GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to support maintaining 
64 the policy after it has been created.  The figure below specifies how to initiate an action.
65
66 .. image:: PolicyGUI_Editor_PolicyActions.png
67
68
69 The next step of the selected action is shown below.
70
71 .. image:: PolicyGUI_Editor_PolicyActionsDetail.png
72
73 |
74
75 POLICY Dictionary
76 ^^^^^^^^^^^^^^^^^
77
78 | The POLICY **Dictionary** tab is used to create and manage attributes in the dictionaries.  
79 | Each policy type has one or more dictionaries associated with it.  Policy writers have the ability to easily define and add attributes into the dictionary as shown below.  
80
81 .. image:: PolicyGUI_Dictionary.png
82
83 |
84
85 POLICY PDP
86 ^^^^^^^^^^
87
88 | The POLICY **PDP** tab is used to manage **PDP Groups** and **PDPs in the group**.  
89 | This tab provides the capability to create, edit and delete PDP groups and associated PDPs.  This tab also provides the ability to check status and view policies in a PDP groups.
90
91 .. image:: PolicyGUI_PDP.png
92
93 |
94
95 POLICY Push
96 ^^^^^^^^^^^
97
98 | The POLICY **Push** tab allows policies to be selectively pushed to the all PDPs.
99 | Once pushed, the policies can be seen on the PDP tab.  A Status of the PDPs indicate “UP-TO-DATE” if the policy has been pushed correctly.  A Status of “LAST-UPDATE-FAILED” indicates an error occurred in pushing the policies.
100
101 .. image:: PolicyGUI_Push.png
102
103 |
104
105 POLICY Dashboard 
106 ^^^^^^^^^^^^^^^^
107
108 | The POLICY **Dashboard** shows the **status** and **health** of the system through metrics logs and status update messages.  The dashboard consists of two tabs, a **Logging** tab and a **Health** tab. 
109
110 .. image:: PolicyGUI_Dashboard.png
111
112 |
113
114 POLICY Admin
115 ^^^^^^^^^^^^
116
117 | The POLICY **Admin** tab houses functionality that is performed by an administrator.  
118 | Only super users have access to the Admin Tab.  The Lockdown feature is accessed from this tab.
119
120 .. image:: PolicyGUI_Admin.png
121
122 |
123
124 POLICY Roles
125 ^^^^^^^^^^^^
126
127 | The POLICY **Roles** tab allows system administrators to assign roles for system access.  
128 | The GUI options vary depending on the role.  
129
130 .. image:: PolicyGUI_Roles.png
131
132 |
133
134
135
136 End of Document