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 GUI consists of the **Editor, Dictionary, PDP, PUSH, Roles, Admin and Dashboard** tabs.
  14 |
  15 | The typical targetted users are those who have the responsibility and authority to create and manage policies that control network operations including policy based network configuration and auto-corrective actions.  This includes network and service designers, operations engineers and security experts. The POLICY GUI provides Users to effortlessly create, change, and manage policy rules.
  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 houses **key functionality** for the POLICY application.
  30 | The following functionality is supported:
  31
  32 •     Create Policies and Scopes
  33 •     Edit, View and Describe Policies
  34 •     Rename, Move and Clone Policies
  35 •     Switch Versions of Policies
  36 •     Delete Policies and Scopes
  37 •     List Policies and Scopes
  38 •     Export and Import Policies
  39 •     Search for Policies
  40
  41 Scope
  42 -----
  43
  44 The diagram below shows the POLICY Editor landing page. This page lists the existing Scopes and associated Policies.
  45 A scope must exist before a policy can be added.  The diagram outlines how to add a new scope.
  46
  47 .. image:: PolicyGUI_Editor_Scope.png
  48
  49 |
  50
  51 Create a Policy
  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
  61 Policy Actions (Edit, View ...)
  62 -------------------------------
  63
  64 The POLICY GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to facilitate maintaining
  65 the policy after it has been created.  The figure below identifies how to intiated an action via the GUI.
  66
  67 .. image:: PolicyGUI_Editor_PolicyActions.png
  68
  69 |
  70 |
  71
  72 .. image:: PolicyGUI_Editor_PolicyActionsDetail.png
  73
  74 |
  75
  76 POLICY Dictionary
  77 ^^^^^^^^^^^^^^^^^
  78
  79 | The POLICY DICTIONARY tab is used to create and manage attributes in the dictionaries.
  80 | Each policy type has one or more dictionaries associated with it.  The dictionaries should contain all attributes that may be referenced by the policies.  Policy writers have the ability to easily define attributes and add them into the dictionary via the POLICY GUI as shown below.
  81
  82 .. image:: PolicyGUI_Dictionary.png
  83
  84 |
  85
  86 POLICY PDP
  87 ^^^^^^^^^^
  88
  89 | The POLICY PDP tab is used to managing **PDP Groups**.
  90 | 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.
  91
  92 .. image:: PolicyGUI_PDP.png
  93
  94 |
  95
  96 POLICY Push
  97 ^^^^^^^^^^^
  98
  99 | The POLICY PUSH tab allows policies to be selectively pushed to the all PDPs.
 100 | 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.
 101
 102 .. image:: PolicyGUI_Push.png
 103
 104 |
 105
 106 POLICY Roles
 107 ^^^^^^^^^^^^
 108
 109 | The POLICY ROLES tab allows system administrators to assign roles for system access.
 110 | The GUI options vary depending on the role.  The roles for POLICY are:
 111
 112 •     Policy Super Admin
 113 •     Policy Super Editor
 114 •     Policy Super Guest
 115 •     Policy Admin
 116 •     Policy Editor
 117 •     Policy Guest
 118
 119
 120 POLICY Admin
 121 ^^^^^^^^^^^^
 122
 123 | The POLICY ADMIN tab houses functionality that is performed by an administrator.
 124 | Only super users have access to the Admin Tab.  The Lockdown feature is accessed from this tab.
 125
 126 .. image:: PolicyGUI_Admin.png
 127
 128 |
 129
 130 POLICY Dashboard
 131 ^^^^^^^^^^^^^^^^
 132
 133 | 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.
 134 |
 135 | The **Logging Tab** displays log entries from the Log database.  This tab also supports filtering and exporting of data.
 136 |
 137 | The **Health Tab** includes:
 138 |     • PDP Status :  The PDP table shows list of PDP's and the details of them.
 139 |     • PAP Status :  The PAP table  shows list of Systems and there status and count of Policies.
 140 |     • Policy Activity : The Policy Activity Shows the list of Policies in PDP's.
 141 |     • System Alerts : The System Alerts table shows the logs on filtering logtype with Error.
 142
 143 .. image:: PolicyGUI_Dashboard.png
 144
 145 |
 146
 147
 148
 149 End of Document