| Scott Baker | 9c9a804 | 2022-03-03 10:28:17 -0800 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
| 5 | Aether ROC GUI Basics |
| 6 | ===================== |
| 7 | |
| 8 | This section documents common aspects and features of the GUI. |
| 9 | |
| 10 | .. _committing: |
| 11 | |
| 12 | Committing |
| 13 | ********** |
| 14 | To commit the changes |
| 15 | |
| 16 | #. Click on the **Basket** icon (2nd icon from top right) to see the Basket view |
| 17 | #. Inspect the changes to be committed (optional) |
| 18 | #. Click **Commit** to perform the commit |
| 19 | #. Observe the response that's temporarily displayed that shows the success or failure of the commit |
| 20 | |
| 21 | |BASKETVIEW-NEWRANGE| |
| 22 | |
| 23 | History |
| 24 | ******* |
| 25 | If you are an Aether ROC Administrator, you will be able to see the History of changes, from the *Basket View* by |
| 26 | clicking on the **History** button. |
| 27 | |
| 28 | |BASKETVIEW-HISTORY| |
| 29 | |
| 30 | .. note:: The *History* button will only be visible if you are in the **AetherROCAdmin** group. |
| 31 | |
| Scott Baker | f07ec23 | 2022-03-08 12:20:24 -0800 | [diff] [blame] | 32 | Logging in to the portal |
| 33 | ************************ |
| 34 | Navigating to the portal URL e.g. ``https://roc.<cluster-ingress-hostname>`` will briefly show |
| 35 | an empty dashboard, before temporarily redirecting to the Authentication server's login |
| 36 | page e.g. ``https://keycloak.ananki.io`` |
| 37 | |
| 38 | .. image:: images/keycloak-login.png |
| 39 | :width: 800 |
| 40 | |
| 41 | .. note:: The username and password are your Keycloak credentials - if you have forgotten |
| 42 | your password, please contact the system administrator. |
| 43 | |
| 44 | On entering the "username" and "password" you will be redirected to the dashboard. |
| 45 | |
| 46 | Clicking the user name in the drop down menu will display your name and the groups you belong to: |
| 47 | |
| 48 | .. image:: images/ops-portal-login-details.png |
| 49 | :width: 800 |
| 50 | |
| 51 | .. note:: Click on the panel to dismiss it |
| 52 | |
| 53 | Clicking on the API Key, shows your Session API Key, along with the time it |
| 54 | expires (in 24 hours time). |
| 55 | |
| 56 | .. image:: images/ops-portal-api-key.png |
| 57 | :width: 800 |
| 58 | |
| 59 | Logging out of the portal |
| 60 | ************************* |
| 61 | |
| 62 | To log out of the portal click the "Sign Out" button at the end of the drop down menu. |
| 63 | This releases all resources and redirects you to the Keycloak Account Management page, |
| 64 | where you will have to click **Sign Out** to terminate the Keycloak session. |
| 65 | |
| 66 | .. image:: images/keycloak-account-management.png |
| 67 | :width: 800 |
| 68 | |
| 69 | Before you "Sign Out", while still in this screen, it is possible to: |
| 70 | |
| 71 | * inspect your **Personal Info**, |
| 72 | * configure ways to sign in |
| 73 | * set up 2 factor authentication |
| 74 | * change your password if required. |
| 75 | * see your device activity |
| 76 | |
| 77 | .. note:: To return to the Operations Portal you can simply browse to the Portal's URL, or use the |
| 78 | browser's back button to return to the dashboard. |
| 79 | |
| Scott Baker | 9c9a804 | 2022-03-03 10:28:17 -0800 | [diff] [blame] | 80 | .. |BASKETVIEW-NEWRANGE| image:: images/aether-roc-gui-basket-view-new-range.png |
| 81 | :width: 635 |
| 82 | :alt: Basket View with some changes ready to be committed |
| 83 | |
| 84 | .. |BASKETVIEW-HISTORY| image:: images/aether-roc-gui-basket-view-history.png |
| 85 | :width: 800 |
| 86 | :alt: Basket View with history of last changes |