Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 4 | ********** |
Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 5 | Policy GUI |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 6 | ********** |
Saryu Shah | 3313f39 | 2017-10-09 22:47:18 +0000 | [diff] [blame] | 7 | |
| 8 | .. contents:: |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 9 | :depth: 3 |
Saryu Shah | 3313f39 | 2017-10-09 22:47:18 +0000 | [diff] [blame] | 10 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 11 | | The POLICY GUI is a graphical user interface, available via web-access, for **creating and managing** policies. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 12 | | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 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 | | |
Saryu Shah | 93d4741 | 2017-10-24 02:44:37 +0000 | [diff] [blame] | 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. |
Saryu Shah | 3313f39 | 2017-10-09 22:47:18 +0000 | [diff] [blame] | 16 | |
Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 17 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 18 | Access to the POLICY GUI |
| 19 | ^^^^^^^^^^^^^^^^^^^^^^^^ |
Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 20 | |
Saryu Shah | ba1936f | 2017-10-10 22:20:01 +0000 | [diff] [blame] | 21 | The POLICY GUI can be accessed via the ONAP Portal. |
Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 22 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 23 | .. image:: PolicyGUI_Access.png |
Pamela Dragosh | 5ed4e85 | 2017-09-22 12:26:16 -0400 | [diff] [blame] | 24 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 25 | |
| 26 | POLICY Editor |
| 27 | ^^^^^^^^^^^^^ |
| 28 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 29 | The POLICY **Editor** tab supports the following **key** functionality: |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 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 | |
Saryu Shah | 9296f8d | 2017-10-24 19:25:56 +0000 | [diff] [blame] | 40 | .. image:: PolicyGUI_Editor.png |
| 41 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 42 | |
| 43 | Scope |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 44 | ----- |
| 45 | |
Saryu Shah | 9296f8d | 2017-10-24 19:25:56 +0000 | [diff] [blame] | 46 | A Scope must exist before a policy can be created. The figure below shows how to add and manage Scopes. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 47 | |
| 48 | .. image:: PolicyGUI_Editor_Scope.png |
| 49 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 50 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 51 | Policy Creation |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 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 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 59 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 60 | Managing a Policy |
| 61 | ----------------- |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 62 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 63 | The GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to support maintaining |
Saryu Shah | 93d4741 | 2017-10-24 02:44:37 +0000 | [diff] [blame] | 64 | the policy after it has been created. The figure below specifies how to initiate an action. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 65 | |
| 66 | .. image:: PolicyGUI_Editor_PolicyActions.png |
| 67 | |
Saryu Shah | 93d4741 | 2017-10-24 02:44:37 +0000 | [diff] [blame] | 68 | |
| 69 | The next step of the selected action is shown below. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 70 | |
| 71 | .. image:: PolicyGUI_Editor_PolicyActionsDetail.png |
| 72 | |
| 73 | | |
| 74 | |
| 75 | POLICY Dictionary |
| 76 | ^^^^^^^^^^^^^^^^^ |
| 77 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 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. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 80 | |
| 81 | .. image:: PolicyGUI_Dictionary.png |
| 82 | |
| 83 | | |
| 84 | |
| 85 | POLICY PDP |
| 86 | ^^^^^^^^^^ |
| 87 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 88 | | The POLICY **PDP** tab is used to manage **PDP Groups**. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 89 | | 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 Shah | 800be07 | 2017-10-23 01:25:14 +0000 | [diff] [blame] | 91 | .. image:: PolicyGUI_PDP.png |
| 92 | |
| 93 | | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 94 | |
| 95 | POLICY Push |
| 96 | ^^^^^^^^^^^ |
| 97 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 98 | | The POLICY **Push** tab allows policies to be selectively pushed to the all PDPs. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 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 | |
Saryu Shah | 800be07 | 2017-10-23 01:25:14 +0000 | [diff] [blame] | 101 | .. image:: PolicyGUI_Push.png |
| 102 | |
| 103 | | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 104 | |
Saryu Shah | 3c62803 | 2017-10-24 21:25:11 +0000 | [diff] [blame^] | 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 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 114 | POLICY Roles |
| 115 | ^^^^^^^^^^^^ |
| 116 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 117 | | The POLICY **Roles** tab allows system administrators to assign roles for system access. |
Saryu Shah | 3c62803 | 2017-10-24 21:25:11 +0000 | [diff] [blame^] | 118 | | The GUI options vary depending on the role. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 119 | |
Saryu Shah | 3c62803 | 2017-10-24 21:25:11 +0000 | [diff] [blame^] | 120 | .. image:: PolicyGUI_Roles.png |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 121 | |
Saryu Shah | 3c62803 | 2017-10-24 21:25:11 +0000 | [diff] [blame^] | 122 | | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 123 | |
| 124 | POLICY Admin |
| 125 | ^^^^^^^^^^^^ |
| 126 | |
Saryu Shah | 4adad1f | 2017-10-23 18:20:49 +0000 | [diff] [blame] | 127 | | The POLICY **Admin** tab houses functionality that is performed by an administrator. |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 128 | | Only super users have access to the Admin Tab. The Lockdown feature is accessed from this tab. |
| 129 | |
| 130 | .. image:: PolicyGUI_Admin.png |
| 131 | |
| 132 | | |
| 133 | |
Saryu Shah | 34afade | 2017-10-22 03:44:56 +0000 | [diff] [blame] | 134 | |
| 135 | |
| 136 | |
| 137 | End of Document |