1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
11 | The POLICY GUI is a graphical user interface, available via web-access, for **creating and managing** policies.
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.
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.
18 Access to the POLICY GUI
19 ^^^^^^^^^^^^^^^^^^^^^^^^
21 The POLICY GUI can be accessed via the ONAP Portal.
23 .. image:: PolicyGUI_Access.png
29 The POLICY **Editor** tab supports the following **key** functionality:
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
44 This is the POLICY Editor landing page. Existing Scopes and their associated policies are displayed. The diagram below show the functionality available on the screen and also how to add and manage Scopes.
46 .. image:: PolicyGUI_Editor_Scope.png
53 The most important function of the GUI is to facilitate the creation of policies.
54 The figure below specifies how a policy can be created.
56 .. image:: PolicyGUI_Editor_CreatePolicy.png
63 The GUI provides actions (Edit, Clone, Move, Rename, Describe, View etc) to support maintaining
64 the policy after it has been created. The figures below specify how to initiate an action.
66 .. image:: PolicyGUI_Editor_PolicyActions.png
71 .. image:: PolicyGUI_Editor_PolicyActionsDetail.png
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.
81 .. image:: PolicyGUI_Dictionary.png
88 | The POLICY **PDP** tab is used to manage **PDP Groups**.
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.
91 .. image:: PolicyGUI_PDP.png
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.
101 .. image:: PolicyGUI_Push.png
108 | The POLICY **Roles** tab allows system administrators to assign roles for system access.
109 | The GUI options vary depending on the role. The roles for POLICY are:
112 • Policy Super Editor
122 | The POLICY **Admin** tab houses functionality that is performed by an administrator.
123 | Only super users have access to the Admin Tab. The Lockdown feature is accessed from this tab.
125 .. image:: PolicyGUI_Admin.png
132 | 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 .. image:: PolicyGUI_Dashboard.png