Web console
You can interact with Portworx Backup through a central user interface called Portworx Backup web console. From here, you can:
- Import licenses
- Add cloud credentials
- Add backup locations
- Add different types of clusters
- Add schedule policies
- Add backup rules
- View all the resources currently on your application cluster
- Filter resources by namespace and labels
- View profile information
- Add and map roles to users
Portworx Backup presents a simple and easy-to-use dashboard for quick navigation.
The following topics take you through various components of the user interface and briefly explain the purpose of each component.
Navigation pane
Navigation pane on the left of the home screen is the frozen pane for critical and frequently used tasks related to back up and restore and holds the following controls:
Home page
Home page displays cluster data, provides links to shared clusters, helps you navigate to all the backups associated with your user credentials and users belonging to a specific groups (if you are an administrator).
Clusters
Clusters control displays the cluster you have added along with its as-is status, number of applications and data it currently protects and its Kubernetes version.
All Shared clusters
If you have shared all the backups of a cluster with other users or user groups, such clusters are displayed in this page along with share status, user, and the permissions given. For more information on this page, refer to All shared clusters.
All Backups
All Backups page displays all the backups you own and the backups (created by another user) shared with you.
Lighthouse
Lighthouse option allows you to add a Portworx cluster to your Portworx Backup by providing necessary details and lets you choose the required cluster security option.
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 status, number of nodes that can be associated with the purchased license type.
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.
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.
Portworx Backup Security
Portworx Backup Security is a built-in feature in Portworx Backup. Portworx Backup Security allows you to control user access to certain resources by setting governance policies and managing permissions for the application owners on the platform. Portworx Backup Security is 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.
Role Mapping
This tab displays the roles linked with your profile, allows you to map a role to your user account and also helps to quickly filter the required role tagged with your profile.
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.
Settings
Settings drop-down menu helps you to add new schedule policies, cloud accounts, backup locations, pre-exec and post-exec rules to be associated with backups.
Add clusters
Add clusters option aids in adding different types of Kubernetes clusters supported by Portworx Backup in a few clicks. You just have to select your cloud platform, key-in necessary details and add the cluster. Portworx Backup lets you auto-discover your EKS clusters and then add them to back up and restore your application data and resources.