Skip to main content
Version: 2.8

Portworx Backup dashboard

The Portworx Backup dashboard provides a centralized view for monitoring applications, backups, and restores of applications across different clusters. The main features of this interface are the application protection status overview, total backup data size, backup and restore activity timeline, and system alerts. Users can interact with the interface through clickable tabs, drop-down filters, search bars, and pagination controls. Hover-over actions reveal more options or information tooltips.

You can access the dashboard with the Portworx Backup web console and this serves as the home page. The various components of the dashboard page that help to monitor your clusters, backups, and restores are explained in the below section.

Dashboard components​

  • Filter by clusters: A drop-down that allows you to choose the required cluster. By default, the dashboard displays the backup and restore data with separate tabs for all the clusters. To view dashboard data (protected applications, total backup data, latest alerts, and activity timeline) of a specific cluster, you need to choose the required cluster from this drop-down. This drop-down list the first 200 application clusters added to PXB. You can also quickly search the required cluster with its name.

  • Applications: displays the application protection status, shows the total number of applications with the breakdown of protected vs unprotected applications. Web console auto-refreshes this data frequently to fetch latest data.

    • Protected: the number of applications that are currently backed up and hence protected
    • Unprotected: the number of applications that you have not backed up or protected
    note

    If you have backed up a namespace with Partial Success state, that namespace will be listed as protected.

  • Total Backup Data: this widget shows the cumulative size of all backup data across all clusters

  • Latest alerts: a panel that displays system-generated alerts and displays the recent five alerts

    To view the alerts associated with all the clusters or specific clusters, from the left navigation pane:

    • Click Alerts icon, and the Alerts page appears. You can either filter by alert type or by clusters

    OR

    • Click Clusters icon, choose the required cluster and then move to Alerts tab

  • Activity timeline: this component can be broadly classified into Activity timeline chart and Activity timeline table and holds following components:

    • Backup: this tab displays the details of all the backups of various applications you have created across multiple clusters and single cluster

    • Restore: this tab allows you to view the restore details of applications across multiple clusters and specific cluster

    The following options/fields are common to both Backup and Restore tab:

    • Search by backup/restore name: a search box which allows you to search a backup by its name

    • Filter by status: filter by status field helps to shortlist the backups or restores with the following status:

      • In-Progress
      • Success
      • Failed
      • Deleting
      • Delete pending
      • Partial success

    • Time Filter (Last 24 hours): a drop-down that shows the backup or restore status data by time created

      • Last 24 hours
      • Last 1 week
      • Last 1 month

    • Download report: a drop-down that allows you to download backup or restore report either in:

      • PDF format
      • CSV format
    note

    Portworx Backup currently supports 20K backup and restore objects in PDF report and 40K objects in CSV report. You may observe system timeout issues while downloading the report if the number of objects exceed the specified limit.

    • Activity timeline chart: displays a bar graph representation of backups/restores along with their status. Hovering over the individual bar graph displays the number of backups/restores associated with the selected bar.
    note

    Activity timeline chart displays:

    • Success, Failed, In-Progress, and Partial Success only for both backups and restores.

    • Activity timeline table for backup: displays specific details of backups spread across multiple backup locations and namespaces in tabular format. Lists individual backup activities with the following details:

      • Details: an expandable arrow to give more information on the backup such as status, activity information, backup schedules, upcoming schedules, rentention period information, number of namespaces, resources, and volumes backed up in this backup. You can click View All to view all the namespaces, resources and volumes associated with the backup. Besides, it gives options to delete, view Json, duplicate, edit and restore the backup.

        note

        Retention period information is visible only for AWS object lock enabled backup and for backups with Azure immutability support.

      • BACKUP NAME: the unique identifier for the backup

      • CLUSTER: cluster from where that backup is created

      • LOCATIONS: where the backup is stored

      • BACKUP LABELS: additional labels for categorization or identification purposes

      • APPLICATION TYPE: type of application data that is backed up

      • SIZE: the size of the backup

      • CREATE TIME: the timestamp when the backup was created

      • Clock icon and/or lock icon: a small clock icon after timestamp indicates that the backup is a scheduled backup. A lock icon indicates that backup is an object lock enabled backup.

      • Vertical ellipsis: provides options to restore the backup, view json details, show backup details, edit the backup to apply labels, duplicate the backup and to completely delete the backup

    • Activity timeline table for restore: displays specific details of and restores spread across multiple backup locations and namespaces in tabular format. Lists individual backup/restore activities with the following details:

      • Details: an expand more arrow that gives more information on the restore such as status, activity info, schedule associated with the restore and so on
      • RESTORE NAME: the unique identifier for the backup
      • CLUSTER: the cluster to which restore belongs to
      • BACKUP NAME: name of the backup utilized to create the restore
      • APPLICATION TYPE: type of application data that was backed up and then restored
      • SIZE: the size of the restore
      • CREATE TIME: the timestamp when the restore was created
      • Vertical ellipsis: provides options to view json details, show restore details, duplicate the restore, and to completely remove the restore
    note

    If there is no backup/restore created, activity timeline chart/table remains blank without any data.

    note

    If you are on OCP cluster and if you see any data loss in activity timeline table or chart, refer OCP configuration for troubleshooting information.

  • Pagination: navigational controls to move through different pages of the Activity timeline.

  • Error alerts: displays a red bar in the top-right corner of the page to indicate that there is an issue to be troubleshooted

  • Notification alerts: a green bar appears at the top-right corner to notify that the task (adding cloud account, adding backup location, creating a backup, restoring a backup and so on) is successful

Filter by status and time combination

  • In the backup tab, if you select In-Progress option from Filter by status drop-down and choose Last 24 hours from the time filter drop-down, the activity timeline chart/table displays the number of backups that are in in-progress state out of the backups you triggered in the last 24 hours. For example, if you created 10 backups in the last 24 hours out of which 4 backups are in in-progress state the activity timeline chart/table displays only 4 backups along with their details.

  • In the restore tab, if you select Partial success option from Filter by status and choose Last one month from the time filter drop-down, the activity timeline chart/table displays the number of restores that are in partial success state from past one month. In other words, if you have created 26 restores in last one month out of which 3 restores are in partial success state, active timeline table/chart displays only 3 restores and their details.

Last updated on