blob: af981656a8771668bbc735fc90935219ca4292ad [file] [log] [blame]
Pamela Dragosh5ed4e852017-09-22 12:26:16 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
Saryu Shah34afade2017-10-22 03:44:56 +00004**********
Pamela Dragosh5ed4e852017-09-22 12:26:16 -04005Policy GUI
Saryu Shah34afade2017-10-22 03:44:56 +00006**********
Saryu Shah3313f392017-10-09 22:47:18 +00007
8.. contents::
Saryu Shah34afade2017-10-22 03:44:56 +00009 :depth: 3
Saryu Shah3313f392017-10-09 22:47:18 +000010
Saryu Shah4adad1f2017-10-23 18:20:49 +000011| The POLICY GUI is a graphical user interface, available via web-access, for **creating and managing** policies.
Saryu Shah34afade2017-10-22 03:44:56 +000012|
Saryu Shah4adad1f2017-10-23 18:20:49 +000013| The targetted 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|
Saryu Shah4b3b6582017-10-25 17:57:06 +000015| 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.
Saryu Shah3313f392017-10-09 22:47:18 +000016
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040017
Saryu Shah34afade2017-10-22 03:44:56 +000018Access to the POLICY GUI
19^^^^^^^^^^^^^^^^^^^^^^^^
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040020
Saryu Shahba1936f2017-10-10 22:20:01 +000021The POLICY GUI can be accessed via the ONAP Portal.
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040022
Saryu Shah34afade2017-10-22 03:44:56 +000023.. image:: PolicyGUI_Access.png
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040024
Saryu Shah34afade2017-10-22 03:44:56 +000025
26POLICY Editor
27^^^^^^^^^^^^^
28
Saryu Shah4adad1f2017-10-23 18:20:49 +000029The POLICY **Editor** tab supports the following **key** functionality:
Saryu Shah34afade2017-10-22 03:44:56 +000030
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
Saryu Shah9296f8d2017-10-24 19:25:56 +000040.. image:: PolicyGUI_Editor.png
41
Saryu Shah4adad1f2017-10-23 18:20:49 +000042
43Scope
Saryu Shah34afade2017-10-22 03:44:56 +000044-----
45
Saryu Shah9296f8d2017-10-24 19:25:56 +000046A Scope must exist before a policy can be created. The figure below shows how to add and manage Scopes.
Saryu Shah34afade2017-10-22 03:44:56 +000047
48.. image:: PolicyGUI_Editor_Scope.png
49
Saryu Shah34afade2017-10-22 03:44:56 +000050
Saryu Shah4adad1f2017-10-23 18:20:49 +000051Policy Creation
Saryu Shah34afade2017-10-22 03:44:56 +000052---------------
53
54The most important function of the GUI is to facilitate the creation of policies.
55The figure below specifies how a policy can be created.
56
57.. image:: PolicyGUI_Editor_CreatePolicy.png
58
Saryu Shah34afade2017-10-22 03:44:56 +000059
Saryu Shah4adad1f2017-10-23 18:20:49 +000060Managing a Policy
61-----------------
Saryu Shah34afade2017-10-22 03:44:56 +000062
Saryu Shah4adad1f2017-10-23 18:20:49 +000063The GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to support maintaining
Saryu Shah93d47412017-10-24 02:44:37 +000064the policy after it has been created. The figure below specifies how to initiate an action.
Saryu Shah34afade2017-10-22 03:44:56 +000065
66.. image:: PolicyGUI_Editor_PolicyActions.png
67
Saryu Shah93d47412017-10-24 02:44:37 +000068
69The next step of the selected action is shown below.
Saryu Shah34afade2017-10-22 03:44:56 +000070
71.. image:: PolicyGUI_Editor_PolicyActionsDetail.png
72
73|
74
75POLICY Dictionary
76^^^^^^^^^^^^^^^^^
77
Saryu Shah4adad1f2017-10-23 18:20:49 +000078| 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.
Saryu Shah34afade2017-10-22 03:44:56 +000080
81.. image:: PolicyGUI_Dictionary.png
82
83|
84
85POLICY PDP
86^^^^^^^^^^
87
Saryu Shah4adad1f2017-10-23 18:20:49 +000088| The POLICY **PDP** tab is used to manage **PDP Groups**.
Saryu Shah34afade2017-10-22 03:44:56 +000089| This tab provides the capability to create, edit and delete PDP groups. This tab also provides the ability to check status and view policies in a PDP groups.
90
Saryu Shah800be072017-10-23 01:25:14 +000091.. image:: PolicyGUI_PDP.png
92
93|
Saryu Shah34afade2017-10-22 03:44:56 +000094
95POLICY Push
96^^^^^^^^^^^
97
Saryu Shah4adad1f2017-10-23 18:20:49 +000098| The POLICY **Push** tab allows policies to be selectively pushed to the all PDPs.
Saryu Shah34afade2017-10-22 03:44:56 +000099| 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
Saryu Shah800be072017-10-23 01:25:14 +0000101.. image:: PolicyGUI_Push.png
102
103|
Saryu Shah34afade2017-10-22 03:44:56 +0000104
Saryu Shah3c628032017-10-24 21:25:11 +0000105POLICY 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
Saryu Shah34afade2017-10-22 03:44:56 +0000114POLICY Admin
115^^^^^^^^^^^^
116
Saryu Shah4adad1f2017-10-23 18:20:49 +0000117| The POLICY **Admin** tab houses functionality that is performed by an administrator.
Saryu Shah34afade2017-10-22 03:44:56 +0000118| 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
Saryu Shah4b3b6582017-10-25 17:57:06 +0000124POLICY 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|
Saryu Shah34afade2017-10-22 03:44:56 +0000133
134
135
136End of Document