diff options
Diffstat (limited to 'docs/sections/platform-doc/dcaedashboard_userguide.rst')
| -rw-r--r-- | docs/sections/platform-doc/dcaedashboard_userguide.rst | 308 |
1 files changed, 0 insertions, 308 deletions
diff --git a/docs/sections/platform-doc/dcaedashboard_userguide.rst b/docs/sections/platform-doc/dcaedashboard_userguide.rst deleted file mode 100644 index 5de36728..00000000 --- a/docs/sections/platform-doc/dcaedashboard_userguide.rst +++ /dev/null @@ -1,308 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _dashboarduserguide: - - -DCAE Dashboard User Guide -========================= - - -Overview --------- - -DCAE Dashboard is a web application that provides a unified interface for DCAE -users and Ops users in ONAP to manage DCAE microservices. - - -Starting with the Dashboard ---------------------------- - -Type in the application login URL in a web browser. The Login page -should appear. - -|dashboard_1.png| - -If you are a first time user, then click on the **Sign up** button. Fill in -the Sign up FORM and submit it to register for an account. Upon a -successful login by providing valid login credentials, the user's -dashboard (Home) screen is displayed. The header navigation bar contains -menu links and a user profile section in the top right corner. The -collapsible left sidebar contains all the application menus; each item -(except "Home") can be expanded into sub-items by clicking on the item. - -User Dashboard contents appear in the panel to the right of the left -navigation menu. By default(initial view), the screen displays tiles -contains the count of blueprints and count of deployments owned by the -signed-in user. The count of plugins uploaded to the Cloudify Orchestrator -is also shown in the Plugins tile. Each tile is clickable and will -navigate control to the individual screens that display detailed -information about the items. There is a switch at the top to toggle -between user level or user role group access for the dashboard -contents. By switching access type to **Group**, the aggregate count of -inventory items at the user group (role) level are shown on the dashboard. - -|dashboard_2.png| - -|dashboard_3.png| - -Auto Refresh switch lets user automatically reload the dashboard at -regular intervals. - -An autocomplete list of blueprints lets a user find a specific blueprint -and trigger a deployments list query. Upon selecting a blueprint item, a -query is triggered to find associated deployments for the selected -blueprint. Similarly upon selecting a specific deployment entity, any -matching execution workflows are queried and displayed in the executions -data grid. By default the user dashboard shows currently active -executions that are happening in Cloudify. - -|dashboard_4.png| - -|dashboard_5.png| - -|dashboard_6.png| - -Working with blueprints and deployments ---------------------------------------- - -Searching/Filtering Blueprints ------------------------------- - - -1. Click on the "Inventory" menu item, which will expand to show - sub-items. Select the "Blueprints" sub-item. - -A "Blueprints" screen appears, which displays the blueprints retrieved from -Inventory. By default, a blueprint owner filter is applied to display -items where the owner is the signed in user. By deselecting the "My -Blueprints" checkbox, all blueprints belonging to the role group will be -displayed. - -|dashboard_7.png| - -|dashboard_8.png| - -2. You can search for blueprints based on their name. Type the name of -the blueprint you wish to work with in the search box at the top right -hand of the screen and press 'enter' or click the magnifying glass icon -to look for it. - -|dashboard_9.png| - -3. You can use search filters by clicking on the down arrow at the right -end of the search box. Filter by blueprint name and/or owner is available. Once -finished, click the magnifying glass at the bottom of the advanced -filters box or press "enter". - -|dashboard_10.png| - -|dashboard_11.png| - -|dashboard_12.png| - -4. Lookup deployments mapped to a blueprint - -|dashboard_13.png| - -Creating Blueprints -------------------- - -1. A user can create a new blueprint either from scratch or by uploading - an existing file. To do this, select the "Blueprints" sub-menu - -Once the existing set of blueprints appear on the screen, click on the -"Upload" Button - -|dashboard_14.png| - -2. In the "Upload Blueprint" pop-up, fill out all the fields. Provide - the name and version number for the blueprint -- hints on nomenclature are - available by clicking on the input field help icon (question mark - symbol). A blueprint file can be either "dragged and dropped" from - the user's own directory or it can be created from scratch. When - finished, press "Save". *Note:*\ **Import Data**\ *function is not - supported and will be removed later.* - -|dashboard_15.png| - -3. Allow the Blueprints screen to reload and then check that the - blueprint you created is in the table. - - -Viewing/Exporting Blueprints ----------------------------- - -1. Navigate to the Blueprints screen via the sidebar menu On the - Blueprints screen, click on the Actions button icon (More actions) - for the blueprint you wish to work with. A number of choices are - indicated in a pop-up: View, Export, Update, Deploy and Delete. - -|dashboard_16.png| - -2. Choose "View" to display the contents of the blueprint - -|dashboard_17.png| - -Deploying Blueprints --------------------- - -3. Navigate to the Blueprints screen via the sidebar menu. On the - Blueprints screen, click on the Actions button icon (More actions) - for the blueprint you wish to work with and select "Deploy" - -|dashboard_18.png| - -4. On the "Deploy Blueprint" pop-up, fill in all the fields. There are - two ways to supply the input parameters for the blueprint: one is to - drag and drop a parameters file; the other is to manually fill in the - name-value pairs. When finished, press the "Deploy" button at the - bottom. - -|dashboard_19.png| - -5. Navigate to the Deployments screen via the sidebar menu and check - that the blueprint deployed is listed on the screen - -|dashboard_20.png| - -Searching/Filtering Deployments -------------------------------- - -1. Navigate to the Deployments screen via the sidebar menu. - -2. By default, the deployment owner filter and application cache filters are - applied to display items where the owner is the signed in user. Data is - fetched from the application cache store. By deselecting the "My - Deployments" checkbox, all deployments belonging to the role group - will be displayed. By deselecting "Cache" checkbox, cache is bypassed - and data is fetched from Cloudify Maanger. "Tenant" filter can be - applied to restrict the query per tenant partition. Upon selecting the - "Tenant" checkbox, the tenants list dropdown appears. - -3. You can search for Deployments by an ID. Enter the ID and press - 'Enter' or click the magnifying glass icon. - -|dashboard_21.png| - -4. If you wish to make an advanced search, select the "Tenant" checkbox, - select a tenant from the tenants list, click the down arrow at the - right end of the input field to expand the advanced search filters. - Here you can filter by deployment IDs, owners, (installation) - Status and Helm chart deployment. Once finished, click the magnifying - glass at the bottom of the advanced filters box. - -|dashboard_22.png| - -Viewing Blueprint, Inputs, Executions -------------------------------------- - -1. Navigate to the Deployments screen on the left hand menu - -On the deployments table screen, click on the "Actions" button icon for -the deployment you wish to manage. - -|dashboard_23.png| - -|dashboard_24.png| - -|dashboard_25.png| - -|dashboard_26.png| - -|dashboard_27.png| - -Undeploying Deployments ------------------------ - -1. Navigate to the Deployments screen on the left hand menu - -2. On the deployments table screen, click on the "Actions" button icon - for the deployment you wish to uninstall. Click on Undeploy. - -|dashboard_28.png| - -3. On the confirmation popup, confirm the tenant is correct and select - "Undeploy" when ready to undeploy - -|dashboard_29.png| - -Helm Status, Upgrade, Rollback ------------------------------- - -1. Navigate to the Deployments screen on the left hand menu - -2. Ensure that the deployment is a helm deployment - -On the deployments table screen, click on the "Actions" button icon for -the deployment you wish to perform helm operations on. - -|dashboard_30.png| - -*Helm Status* - -|dashboard_31.png| - -*Helm Upgrade* - -|dashboard_32.png| - -*Helm Rollback* - -|dashboard_33.png| - -Checking system health ----------------------- - - -Viewing Service Health ----------------------- - -Navigate to the Service Health screen on the sidebar menu - -|dashboard_34.png| - -Node Health ------------ - -Viewing Node Health -------------------- - -Navigate to the Node Health screen on the sidebar menu - -|dashboard_35.png| - -.. |dashboard_1.png| image:: attachments/dashboard_1.png -.. |dashboard_2.png| image:: attachments/dashboard_2.png -.. |dashboard_3.png| image:: attachments/dashboard_3.png -.. |dashboard_4.png| image:: attachments/dashboard_4.png -.. |dashboard_5.png| image:: attachments/dashboard_5.png -.. |dashboard_6.png| image:: attachments/dashboard_6.png -.. |dashboard_7.png| image:: attachments/dashboard_7.png -.. |dashboard_8.png| image:: attachments/dashboard_8.png -.. |dashboard_9.png| image:: attachments/dashboard_9.png -.. |dashboard_10.png| image:: attachments/dashboard_10.png -.. |dashboard_11.png| image:: attachments/dashboard_11.png -.. |dashboard_12.png| image:: attachments/dashboard_12.png -.. |dashboard_13.png| image:: attachments/dashboard_13.png -.. |dashboard_14.png| image:: attachments/dashboard_14.png -.. |dashboard_15.png| image:: attachments/dashboard_15.png -.. |dashboard_16.png| image:: attachments/dashboard_16.png -.. |dashboard_17.png| image:: attachments/dashboard_17.png -.. |dashboard_18.png| image:: attachments/dashboard_18.png -.. |dashboard_19.png| image:: attachments/dashboard_19.png -.. |dashboard_20.png| image:: attachments/dashboard_20.png -.. |dashboard_21.png| image:: attachments/dashboard_21.png -.. |dashboard_22.png| image:: attachments/dashboard_22.png -.. |dashboard_23.png| image:: attachments/dashboard_23.png -.. |dashboard_24.png| image:: attachments/dashboard_24.png -.. |dashboard_25.png| image:: attachments/dashboard_25.png -.. |dashboard_26.png| image:: attachments/dashboard_26.png -.. |dashboard_27.png| image:: attachments/dashboard_27.png -.. |dashboard_28.png| image:: attachments/dashboard_28.png -.. |dashboard_29.png| image:: attachments/dashboard_29.png -.. |dashboard_30.png| image:: attachments/dashboard_30.png -.. |dashboard_31.png| image:: attachments/dashboard_31.png -.. |dashboard_32.png| image:: attachments/dashboard_32.png -.. |dashboard_33.png| image:: attachments/dashboard_33.png -.. |dashboard_34.png| image:: attachments/dashboard_34.png -.. |dashboard_35.png| image:: attachments/dashboard_35.png |