Skip to main content
Version: 2.9

Web console

You can interact with Portworx Backup through a central user interface called Portworx Backup web console. From here, you can monitor and manage most of the key operations of Portworx Backup:

Portworx Backup presents a simple and easy-to-use dashboard for quick navigation.

The following topics take you through various components of the web console and briefly explain the purpose of each component.

Left navigation pane​

Navigation pane on the left of the home screen is a frozen pane for critical and frequently used tasks related to back up and restore and holds the following controls:

Dashboard​

Dashboard provides a centralized view for monitoring and managing 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 activity timeline, backup activity table, and system alerts.

Clusters​

Clusters page displays the cluster(s) you have added along with its as-is status, number of applications and data it currently protects, its Kubernetes version, permissions, owner and so on. The vertical ellipsis at the end of the cluster provides allows you to view json, share all backup it holds, edit the cluster details, and an option to remove the cluster.

All Backups​

All Backups page displays all the backups you own and the backups (created by another user) shared with you. Namespace and VM backups are segregated separately under NS and VM tabs. You can also search your backups with its name and by the user it belongs to. You can refresh the latest backup data with reload option. Vertical ellipsis at the end of each back row allows you to view json, view backup details, share the backup with another user, edit the backup details, duplicate the backup, restore the backup, and to completely remove the backup. Pagination control allows you to navigate to different pages to view the required backups.

Lighthouse​

Lighthouse page allows you to add a Portworx cluster to your Portworx Backup and displays the Portworx clusters you have added previously through this option. It also provides necessary details and lets you choose the required cluster security option. You can also search your Portworx cluster by its name and refresh for the web console to fetch the most recent data.

License​

Portworx Backup license page enables you to import license through license key, license file, and subscription model for internet-connected hosts and air-gapped environments. In addition, this page displays the license type, license status, number of licenses, used, total number of nodes that can be associated with the purchased license type, start date and license expiry details.

Alerts​

Alerts page displays alerts for all the application clusters added to Portworx Backup. The page captures critical alerts related to failures in backups, restores, backup location addition and if the clusters are not reachable. Furthermore, you can search an alert with the object name (backups, restores, backup location, and cluster) or with the error reason. You can also filter the alerts by alert type and cluster associated with the alert. Email Alerts tab helps you to associate your SMTP server and provide the recipient email addresses to send failure alerts to the intended users.

Status​

Service Status page displays the status and the current version of various services that actively run in the background for Portworx Backup operations to run seamlessly.

Settings​

Settings option menu helps you to add new schedule policies to automate scheduled backups, cloud accounts (to add backup locations and clusters), backup locations (backup targets), pre-exec and post-exec rules to be associated with backups.

User Profile​

User profile helps you to access your profile, Portworx Backup role and role mapping options and provides an option to log out.

Profile​

This option displays user information related to role, group the user belongs to, role associated with the user with respect to Portworx Central and Portworx Backup along with other key information.

User Management​

User Management is a built-in feature of Portworx Backup that allows you to control user access to certain resources by setting governance policies and managing permissions for the application owners on the platform. Besides, it provides a role-based access control (RBAC) system that enables authorization for users or user groups through an existing OIDC authentication service such as Keycloak and Okta.

User

This tab displays the users and groups added in the Keycloak or registered through login page. It also includes the users/groups existing in your authorization providers and synced with Keycloak.

Roles

The Roles tab displays the built-in roles of Portworx Backup. The Portworx Backup built-in roles match user personas managing the Kubernetes infrastructure and applications:

  • Infrastructure administrator (px-backup.infra.admin): The infrastructure owner with administrator privileges for Portworx Backup resources such as cloud accounts, backup locations, schedules, and roles. Infrastructure administrators create custom roles, in addition to the built-in roles in Portworx Backup. Infrastructure owners or any user can create a shared resource pool to share backup locations, schedules, and backup roles with other users.

  • Application administrator (px-backup.app.admin): Application administrators can manage applications they own. Application administrators contain privileges for schedules and rules, and can use existing cloud accounts.

  • Application user (px-backup.app.user): The application users who can back up and restore applications, but cannot create a schedule policy or rules.

Notification alerts​

Web console displays Success alerts at the top-right corner for every successful operation like adding cloud account, adding backup location, adding clusters, rules, schedules, creating backups ad restores and so on.

📄️ 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.