Skip to main content

Home

App installation and launch

Unravel uses the telemetry data available from your cluster to provide valuable views and insights through Plotly dash apps. You can manage these dash apps from the App Store on Unravel UI.

From the App Store, you can install an app, run the administrative tasks for managing your apps, navigate to different apps, and open the apps.

You can customize the configurations set by default for the App Store. Refer to App Store configuration.

Important

Ensure to install GNU Compiler Collection (GCC) version 4.9.3, which consists of compilers and libraries for C, C++, etc., on the Unravel node for the App Store to function properly.

In case of a multi-cluster deployment, install GCC on the Unravel core node.

Installing Apps from the Unravel Apps page

  1. Download the app and save it in your system.

  2. On the Unravel UI, from the upper-right corner, click appstore-icon.png. The App Store page is displayed. A blank page is displayed, If there are no apps installed.

  3. Click manage-apps.png. The Manage page is displayed.

  4. On the Manage page, click install-app.png. The Install New App dialog box is displayed.

  5. Choose the app tar file. You can either browse and select or drag and drop the app tar file.

  6. Click the Upload & Install button. The App is installed and is listed in the App Store. After installation, you must start the app to get the app running.

Viewing App Store

The App Store has the administrator view and the user view.

Launching an App

On the Unravel UI, from the upper-right corner, click appstore-icon.png. The App Store page is displayed, listing all the installed apps. You can click the image of an app to open the app.

open-app.png

Starting/stopping an App in the App Store

  1. On the App Store, click the manage-apps.png button on the right. The App list is displayed.

  2. Click the Start Launch link in the Actions column corresponding to the app that you want to start. A notification is displayed after the app is started successfully.

    The App Status column displays Running corresponding to the app that is started.

    Click Stop Launch in the Actions column corresponding to the app that you want to stop. A notification is displayed after the app is stopped successfully.

    The App Status column displays Stopped corresponding to the app that is stopped.

Monitor the App resources in App Store

As an administrator, you can view the list of all the apps in the App Store and monitor the set resources.

On the App Store, click the manage-apps.png button on the right. The App list is displayed.

manage-apps.png

The following columns are shown:

Columns

Description

App Name

Name of the app.

App Status

Status of the app; Running or Stopped.

Resources

The following resource details are shown based on the ones that you have set:

  • Process count

  • # Threads

  • RSS

  • VMS

  • % Memory

  • CPU time

  • % CPU

The resource usage is shown for each resource, and the resource limit set for the resources is superscripted adjacent to the resource usage.

For example, in the following image, for the Dashboard app, the process count is 5, whereas the limit is (20).

superscript.png

Actions

The following actions can be performed:

  • Add/edit resource usage.

  • Start/stop an app.

  • Uninstall an app.

  • Check the event log of an app.

Set/Edit resource limits for an App

If you are an App Store administrator, you can add specific resources for an app that you can monitor. In the App Store, you are notified if an App has overrun the set resources. Also, the app is stopped automatically if its resource usage exceeds the specified limit.

  1. On the App Store, click the manage-apps.png button on the right. The App list is displayed.

  2. In the Actions column, corresponding to an app for which you want to add a resource, click Edit resource limit. The Resource Setting dialog box is displayed, where you can add the following resources:

    • Process count

    • Number of threads

    • RSS

    • Memory percentage

    • VMS

    • CPU time

    • CPU percentage

  3. Set the following for the selected resource:

    • Limit

    • Unit

  4. Click appstore-resource-save.png and click Yes to confirm. The resources are added, and you can monitor the resource usage from the App list.

Check event logs of an App in the App Store

In case your App has stopped suddenly or you detect any other irregularity in the normal functioning of your app, you can check the event log to analyze the issue.

  1. On the App Store, click the manage-apps.png button on the right. The App list is displayed.

  2. Click Event logs in the Actions column corresponding to the app for which you want to view the event log.

    The Logs page is displayed with the corresponding app logs. The time of the event, event type, and description are shown.

Uninstall an App in the App Store

  1. On the App Store, click the manage-apps.png button on the right. The App list is displayed.

  2. Click Uninstall in the Actions column corresponding to the app you want to uninstall.

  3. Click Yes to confirm. The app is uninstalled.