1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright ONAP Community
5 |image2017-10-27_15-56-53.png|
7 ONAP Portal for Administrators
8 ==============================
13 The ONAP Portal platform integrates different ONAP applications into a
14 central core. The Portal platform provides common management services
15 and connectivity, while the applications run separately.
17 From the Portal, users access applications. Administrators onboard and
18 manage applications and widgets, and manage user access.
20 The Portal SDK for application developers includes bundled tools,
21 technologies, and built-in capabilities such as services, APIs, and UI
22 controls. Existing applications can migrate to the Portal with the
23 provided APIs and libraries. See `ONAP Portal SDK
24 :ref:`Documentation<onap-portal:master_index>`.
29 Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac)
30 at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`.
32 Access the ONAP portal via the 8989 LoadBalancer documented
33 :ref:` here<onap-oom:onap-on-kubernetes-with-rancher>`
35 From the Portal, users access applications directly or by function using
40 - `Applications in the Portal`
42 - `Application Catalog`
47 The Portal displays different menus for the following functions:
59 Each application also defines a distinct set of user roles. See *Users* .
65 From the ONAP Portal, administrators:
67 - access the same functionality accessible to users
68 (see :ref:`ONAP Portal for users<onap_portal_users>`)
70 - manage users and application admins
72 - onboard applications and widgets
74 - edit the functional menu
76 Administrators see the following menu when accessing the ONAP Portal:
78 |image2017-10-27_14-14-37.png|
80 Left menu descriptions:
85 Use the Admins section to:
87 |image2017-10-27_14-17-0.png|
89 View or search for application admins
90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 #. From the ONAP Portal Home, click Admins in the left menu.
94 #. View or search for admins:
96 - The Admins table shows all admins in alphabetical order by first
97 name. Select an application from the dropdown list to view admins for
100 - Search for an admin by entering a full or partial search term in the
101 search box. Search by first name, last name, or user ID. Searches are
104 - Filter further using a combination of the applications dropdown and
107 Add an application admin
108 ~~~~~~~~~~~~~~~~~~~~~~~~
110 #. From the ONAP Portal Home, click Admins in the left menu.
112 #. Click Add Admin.The New Admin window displays.
114 #. Enter any combination of the user's first name, last name in the
115 search field and click Search.Note: A minimum of three characters is
118 #. Select the user from the results and click Next.
120 |image2017-10-27_14-23-38.png|
122 #. Select an application from the dropdown list.
124 |image2017-10-27_14-26-38.png|
128 The user can administer and manage users for the applications listed in
131 Modify application admin privileges
132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 #. From the ONAP Portal Home, click Admins in the left menu.
136 #. Search for an admin and then select one by clicking the row in the
137 Admins table (see `View or search for application admins`.
139 #. Modify the admin's application privileges:
141 - Add an application to the Administrates list by selecting it from the
144 - Delete an application from the Administrates list by clicking the
147 |image2017-10-27_14-30-33.png| .
151 Delete an application admin
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
154 To delete an application admin completely, first remove access for each
157 #. From the ONAP Portal Home, click Admins in the left menu.
159 #. Search for a name and then select one by clicking the row in the
160 Admins table (see `View or search for application admins`.
162 #. Click the trash icon
164 |image2017-10-27_14-30-51.png| and click OK to confirm for each
165 application in the Administrates list.
169 The application Admin is removed from the table. The Admin is only
170 removed from the Admins table when they have no application access.
176 Use the Users section to:
178 |image2017-10-27_14-35-46.png|
180 View or search for users
181 ~~~~~~~~~~~~~~~~~~~~~~~~
183 #. From ONAP Portal Home, click Users in the left menu.
185 #. Select an application from the dropdown list.
187 #. Enter a full or partial first name, last, name, user ID, or role in
188 the search box; or click the column header to sort that column in
189 alphabetical or reverse alphabetical order.
194 Portal admins can add or manage users for any application. Application
195 admins can only add and manage users for their specific applications.
197 #. From ONAP Portal Home, click Users in the left menu.
201 #. The New User window displays.
203 #. Search for or add a new user:
205 - To search for a user, enter the user's complete first name, last
206 name, or user ID and click search.
208 - To add a new user, click New User, fill in the user details, and
209 click Add New User. The new user appears in the results list.
211 #. Select the user from the results and click Next.
213 |image2017-10-27_14-41-13.png|
215 #. Select a role from the dropdown lists for each application required
220 The user can access the applications with the roles listed in the Users
223 Modify users and roles
224 ~~~~~~~~~~~~~~~~~~~~~~
226 #. From ONAP Portal Home, click Users in the left menu.
228 #. Select an application from the dropdown, search for a user, and
229 select one by clicking the row in the Users table. The user's access
232 |image2017-10-27_15-21-13.png|
234 #. Modify the user's role for each application:
236 - Add or change a user role by selecting or clearing the role from the
239 - Remove all the user's roles for an application by clicking the trash
242 |ep_trash_icon.png| .
249 To delete a user completely, remove access for each application.
251 #. From the ONAP Portal Home, click Users in the left menu.
253 #. Select an application from the dropdown, search for a user, then
254 click the row in the Users table to select (see `View or search for
256 The user's access and roles display.
258 #. Click the trash icon
260 |ep_trash_icon.png| beside an application and click OK to confirm.
264 The User is removed from the applications. The User is only removed from
265 the Users table when they have no application access.
270 Use the Portal Admins section to:
272 |image2017-10-27_15-24-5.png|
274 View or search for Portal Admins
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277 #. From ONAP Portal Home, click Portal Admins in the left menu.
279 #. Enter a full or partial first name, last, name, or ATTUID in the
280 search box, or click the sorting arrows in any column to sort that
281 column in alphabetical or reverse alphabetical order.
286 Only Portal Admins can add or delete other Portal Admins.
288 #. From the ONAP Portal Home, click Portal Admins in the left menu.
290 #. Click Add Portal Admin. The Add New Portal Admin window displays.
292 #. Search for or add a new user:
294 - To search for a user, enter the user's complete first name, last
295 name, or user ID and click search.
297 - To add a new user, click New User, fill in the user details, and
298 click Add New User. The new user appears in the results list.
300 #. Select the user from the results and click Save.
302 The user is listed in the Portal Admins table and can manage users and
305 Delete a Portal Admin
306 ~~~~~~~~~~~~~~~~~~~~~
308 Only Portal Admins can add or delete other Portal Admins.
310 #. From ONAP Portal Home, click Portal Admins in the left menu.
312 #. Search for or scroll to a name in the Portal Admins table and click
313 the trash icon in the Delete column.
315 #. Click OK to confirm.
317 The Portal Admin is removed from the table.
319 Application Onboarding
320 ----------------------
322 Use the Application Onboarding section to:
324 |image2017-10-27_15-27-1.png|
326 Add an application to the Portal
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
329 #. From the ONAP Portal Home, click Application Onboarding in the left
334 #. The Application Details window displays.
336 |image2017-10-27_15-28-31.png|
338 4. Fill out the fields as described in the table:
340 +---------------------------+------------------------------------------+
341 | **Hyperlink only | Select to add an application with a URL |
342 | application** | only. |
343 +===========================+==========================================+
344 | **Application name** | Application name to display in the |
346 +---------------------------+------------------------------------------+
347 | **URL** | Application landing page for |
348 | | hyperlink-only applications. |
349 +---------------------------+------------------------------------------+
350 | **REST API URL** | [Optional] The endpoint for RESTful API |
352 +---------------------------+------------------------------------------+
353 | **Username** | The username for the RESTful API calls. |
354 | | Default = Default |
355 +---------------------------+------------------------------------------+
356 | **Password** | Password for the RESTful API call. |
357 | | Default = AppPassword!1 |
358 +---------------------------+------------------------------------------+
359 | **Name Space** | Namespace value when Application |
360 | | registered in AAF. |
361 +---------------------------+------------------------------------------+
362 | **Communication Inbox** | Do not fill out. Populated by the |
364 +---------------------------+------------------------------------------+
365 | **Communication Key** | Do not fill out. Populated by the |
367 +---------------------------+------------------------------------------+
368 | **Communication Secret** | Do not fill out. Populated by the |
370 +---------------------------+------------------------------------------+
371 | **Upload image** | Click Browse to select the application |
372 | | image to display in the ONAP Portal. |
373 +---------------------------+------------------------------------------+
374 | **Allow guest access** | Select to allow access for users not |
375 | | listed as Users or Admins. |
376 +---------------------------+------------------------------------------+
377 | **Active** | Select to make the application active. |
378 +---------------------------+------------------------------------------+
379 | **Centralized** | Indicate this application is using AAF |
380 | | for centralized role management. |
381 +---------------------------+------------------------------------------+
385 The application appears in the Applications section and in the
386 Application Onboarding table. The Portal Admin receives an email with
387 Communications details.
389 6. Add the application URL to the appropriate Manage menu items:
391 #. Click Edit Functional Menu in the left menu.
393 #. Expand the Manage menu to find the correct items.
395 #. Right-click an item and select Edit.
397 |ep_editmenu_edit.png|
399 #. In the URL field, enter the server URL of the new application and
402 Collect and forward application communication details
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
405 The Portal administrator forwards communications details and a list of
406 servers to the application developer. The application developer adds the
407 details to the portal-properties file located in \\<app web
408 directory>/WEB-INF/classes.
410 **Prerequisites:** *Add an application to the Portal*
412 #. Collect the following details and send them to the application
415 +----------------------------------------+-----------------------------+
416 | Key-value pair | Obtain from |
417 +========================================+=============================+
418 | redirect_url = ** /** | The redirect URL defined |
419 | /process_csp | as ** /** /process_csp. |
420 +----------------------------------------+-----------------------------+
422 #. Request that the application developer:
424 #. Add the key-value pairs above to the portal.properties file located
425 in ** /WEB-INF/classes.
427 #. Add the key-value pair shared_context_rest_url = ** to the
428 system.properties file located in the ** /WEB-INF/conf directory.
430 #. Restart the application
432 Delete an application from the Portal
433 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
435 #. From the ONAP Portal Home, click Widget Onboarding in the left menu.
437 #. Search for or scroll to an application in the table and click the
440 |ep_trash_icon.png| in the Delete column.
442 #. Click OK to confirm.
444 The application is removed from the Portal.
449 Use the Widget Onboarding section to:
451 |image2017-10-27_15-51-18.png|
453 Add an application widget to the Portal
454 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
456 #. From ONAP Portal Home, click Widget Onboarding in the left menu.
460 The Widget Details window displays.
462 |image2017-10-27_15-52-28.png|
464 3. Fill out the fields as described in the following table.
466 +------------------+---------------------------------------------------+
467 | **Application | Select from a dropdown list of onboarded |
468 | Name** | applications. |
469 +==================+===================================================+
470 | **Widget Name** | The name for the widget that appears in the |
471 | | Widgets section of the Portal. |
472 +------------------+---------------------------------------------------+
473 | **Width, | Automatically populated fields. |
475 +------------------+---------------------------------------------------+
476 | **URL** | Widget landing page. |
477 +------------------+---------------------------------------------------+
481 The widget appears in the Widgets section of the Portal. Users with
482 permissions to the widget's application can access the widget.
484 Remove a widget from the Portal
485 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
487 #. From ONAP Portal Home, click Widget Onboarding in the left menu.
489 #. Search for or scroll to a widget in the table and click the trash
492 |ep_trash_icon.png| in the Delete column.
494 #. Click OK to confirm.
496 The widget is removed from the Portal.
501 Edit or rearrange the ONAP Portal functional menus in the Edit
502 Functional Menu section.
504 |image2017-10-31_11-12-22.png|
506 ONAP Portal menus have 4 levels. The menu levels correspond to how and
507 where the menu items appear in the Portal UI.
509 |image2017-10-31_10-49-27.png|
511 Use the Edit Functional Menu section to:
516 #. From ONAP Portal Home, click Edit Functional Menu in the left menu.
518 #. Use the arrows to expand the menu, then right-click on the intended
519 parent menu item and select Add.
521 |image2017-10-31_11-16-14.png|
523 #. Enter a title for the menu item, then enter a URL or select the
524 application to link to from the App dropdown list.
528 #. Click Regenerate Menu to finalize the changes and update the menu.
533 #. From the ONAP Portal Home, click Edit Functional Menu in the left
536 #. Use the arrows to expand the menu, then right-click on the menu item
539 #. Make changes to the title, URL, or application and click Continue.
541 #. Click Regenerate Menu to finalize the changes and update the menu.
543 |image2017-10-31_11-21-2.png|
548 #. From ONAP Portal Home, click Edit Functional Menu in the left menu.
550 #. Use the arrows to expand the menu.
552 #. Click and drag a menu item to move it.A blue line appears to indicate
553 where the menu item will move. A blue box indicates the moved item
554 will be a child of that item.
556 |image2017-10-31_11-23-15.png|
558 #. Click Regenerate Menu to finalize the changes and update the menu.
563 A menu item with children cannot be deleted. Delete all child menu items
566 #. From ONAP Portal Home, click Edit Functional Menu in the left menu.
568 #. Use the arrows to expand the menu, then right-click on the menu item
573 #. Click Regenerate Menu to finalize the changes and update the menu.
575 Portal Microservices Onboarding
576 -------------------------------
578 From left menu Microservice Onboarding section:
580 |image2017-10-31_11-29-12.png|
582 Add a microservice widget to the Portal
583 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
585 #. From ONAP Portal Home, click Microservice Onboarding in the left
588 #. Click Add Microservice.
590 The Microservice Details window displays.
592 |image2017-10-31_11-34-8.png|
594 3. Fill out the fields as described in the following table.
596 +---------------------------------+------------------------------------+
597 | **Field** | Explanation |
598 +=================================+====================================+
599 | **Microservice Name** | The name for the microservice that |
600 | | appears in the Microservice |
601 | | section of the Portal. |
602 +---------------------------------+------------------------------------+
603 | **Microservice Description** | Describe what the microservice |
605 +---------------------------------+------------------------------------+
606 | **Application Name** | Select from a dropdown list of |
607 | | onboarded applications. |
608 +---------------------------------+------------------------------------+
609 | **Microservice End Point URL** | Enter Microservice URL |
610 +---------------------------------+------------------------------------+
611 | **Security Type** | Select from dropdown for |
612 | | Authentication Method |
613 +---------------------------------+------------------------------------+
614 | **Add User Parameter** | Enter parameter key and value if |
615 | | applicable to microservice end |
617 +---------------------------------+------------------------------------+
618 | **Active** | Active check/uncheck to show/hide |
619 | | the microservice |
620 +---------------------------------+------------------------------------+
624 The microservice appears in the Microservices section of the Portal.
625 Users with permissions to the Microservice application can access the
628 Remove a microservice from the Portal
629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
631 #. From ONAP Portal Home, click Microservice Onboarding in the left
634 #. Search for or scroll to a microservice in the table and click the
637 |ep_trash_icon.png| in the Delete column.
639 #. Click OK to confirm.
641 The mocroservice is removed from the Portal.
643 .. |image2017-10-27_15-56-53.png| image:: attachments/16004343_image2017-10-27_15-56-53.png
644 .. |image2017-12-5_15-8-37.png| image:: attachments/20086820_image2017-12-5_15-8-37.png
645 .. |image2017-10-27_14-14-37.png| image:: attachments/16004284_image2017-10-27_14-14-37.png
646 .. |image2017-10-27_14-17-0.png| image:: attachments/16004288_image2017-10-27_14-17-0.png
647 .. |image2017-10-27_14-23-38.png| image:: attachments/16004295_image2017-10-27_14-23-38.png
648 .. |image2017-10-27_14-26-38.png| image:: attachments/16004297_image2017-10-27_14-26-38.png
649 .. |image2017-10-27_14-30-33.png| image:: attachments/16004301_image2017-10-27_14-30-33.png
650 .. |image2017-10-27_14-30-51.png| image:: attachments/16004303_image2017-10-27_14-30-51.png
651 .. |image2017-10-27_14-35-46.png| image:: attachments/16004306_image2017-10-27_14-35-46.png
652 .. |image2017-10-27_14-41-13.png| image:: attachments/16004309_image2017-10-27_14-41-13.png
653 .. |image2017-10-27_15-21-13.png| image:: attachments/16004321_image2017-10-27_15-21-13.png
654 .. |ep_trash_icon.png| image:: attachments/1018932_ep_trash_icon.png
655 .. |image2017-10-27_15-24-5.png| image:: attachments/16004324_image2017-10-27_15-24-5.png
656 .. |image2017-10-27_15-27-1.png| image:: attachments/16004327_image2017-10-27_15-27-1.png
657 .. |image2017-10-27_15-28-31.png| image:: attachments/16004329_image2017-10-27_15-28-31.png
658 .. |ep_editmenu_edit.png| image:: attachments/1018942_ep_editmenu_edit.png
659 .. |image2017-10-27_15-51-18.png| image:: attachments/16004338_image2017-10-27_15-51-18.png
660 .. |image2017-10-27_15-52-28.png| image:: attachments/16004340_image2017-10-27_15-52-28.png
661 .. |image2017-10-31_11-12-22.png| image:: attachments/16004934_image2017-10-31_11-12-22.png
662 .. |image2017-10-31_10-49-27.png| image:: attachments/16004915_image2017-10-31_10-49-27.png
663 .. |image2017-10-31_11-16-14.png| image:: attachments/16004936_image2017-10-31_11-16-14.png
664 .. |image2017-10-31_11-21-2.png| image:: attachments/16004943_image2017-10-31_11-21-2.png
665 .. |image2017-10-31_11-23-15.png| image:: attachments/16004944_image2017-10-31_11-23-15.png
666 .. |image2017-10-31_11-29-12.png| image:: attachments/16004954_image2017-10-31_11-29-12.png
667 .. |image2017-10-31_11-34-8.png| image:: attachments/16004962_image2017-10-31_11-34-8.png