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 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 |
  15 | The GUI consists of the **Editor, Dictionary, PDP, Push, Roles, Admin** and **Dashboard** Tabs; which provide 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
  44 Scope
  45 -----
  46
  47 A Scope must exist before a policy can be created.  The figure below shows how to add and manage Scopes.
  48
  49 .. image:: PolicyGUI_Editor_Scope.png
  50
  51 |
  52
  53 Policy Creation
  54 ---------------
  55
  56 The most important function of the GUI is to facilitate the creation of policies.
  57 The figure below specifies how a policy can be created.
  58
  59 .. image:: PolicyGUI_Editor_CreatePolicy.png
  60
  61 |
  62
  63 Managing a Policy
  64 -----------------
  65
  66 The GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to support maintaining
  67 the policy after it has been created.  The figure below specifies how to initiate an action.
  68
  69 .. image:: PolicyGUI_Editor_PolicyActions.png
  70
  71
  72 The next step of the selected action is shown below.
  73
  74 .. image:: PolicyGUI_Editor_PolicyActionsDetail.png
  75
  76 |
  77
  78 POLICY Dictionary
  79 ^^^^^^^^^^^^^^^^^
  80
  81 | The POLICY **Dictionary** tab is used to create and manage attributes in the dictionaries.
  82 | 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.
  83
  84 .. image:: PolicyGUI_Dictionary.png
  85
  86 |
  87
  88 POLICY PDP
  89 ^^^^^^^^^^
  90
  91 | The POLICY **PDP** tab is used to manage **PDP Groups**.
  92 | 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.
  93
  94 .. image:: PolicyGUI_PDP.png
  95
  96 |
  97
  98 POLICY Push
  99 ^^^^^^^^^^^
 100
 101 | The POLICY **Push** tab allows policies to be selectively pushed to the all PDPs.
 102 | 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.
 103
 104 .. image:: PolicyGUI_Push.png
 105
 106 |
 107
 108 POLICY Roles
 109 ^^^^^^^^^^^^
 110
 111 | The POLICY **Roles** tab allows system administrators to assign roles for system access.
 112 | The GUI options vary depending on the role.  The roles for POLICY are:
 113
 114 •     Policy Super Admin
 115 •     Policy Super Editor
 116 •     Policy Super Guest
 117 •     Policy Admin
 118 •     Policy Editor
 119 •     Policy Guest
 120
 121
 122 POLICY Admin
 123 ^^^^^^^^^^^^
 124
 125 | The POLICY **Admin** tab houses functionality that is performed by an administrator.
 126 | Only super users have access to the Admin Tab.  The Lockdown feature is accessed from this tab.
 127
 128 .. image:: PolicyGUI_Admin.png
 129
 130 |
 131
 132 POLICY Dashboard
 133 ^^^^^^^^^^^^^^^^
 134
 135 | 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.
 136
 137 .. image:: PolicyGUI_Dashboard.png
 138
 139 |
 140
 141
 142
 143 End of Document