The landing page of the UI is divided into 3 main panels
The help icon "?" next to the logged in user name superimposes a help view that explains the different icons, layers and coloring available on the landing page. However, an explanation of the concepts is provided below as well.
The navigation panel is where users connect TVK enabled Kubernetes clusters (or namespaces) and navigate between the namespaces within them. A namespace selected on the left panel dictates the context within which applications would be protected. Switching context by clicking another namespace in the navigation panel automatically changes the the information shown in the application discovery and monitoring panel to match that selected namespace.
The Application Discovery Panel enables a user to select Kubernetes objects and resources through multiple views and define their protection scope (BackupPlan). Since there is no standard definition of an application in Kubernetes, this is a very powerful tool for the user in a microservices based environment.
There are 4 different views that are presented to the user. A user can click through and select items across all 4 views to
In this view, all Helm based applications and Operators within the selected namespace from the navigation are shown. Currently, this view does not support OLM based operators ( will be added in the next release).
In this view, all resources within the selected namespace are consolidated and shown based on their labels. For example, all resources with the label
app:frontend will be consolidated for selection by the user.
In this view, all objects/resources within the selected namespace are shown. These are the lowest level Kubernetes resources - PVC's, secretes, ConfigMaps etc. that can be selected for protection.
Backups performed by choosing items from the first 3 views are saved as a BackupPlan so that they can be reused. BackupPlans can be selected again to be further combined with items from the first 3 views in order to support dynamic growth of the application scope - which results in the creation of a new backupPlan consisting of the contents of the selected backupPlan and the other items from the views. For example if the user performs a backup by selecting a helm chart, label and object, that would show up in the backupPlan view. After that the user can select the backupPlan, along with items from any of the other views (BackupPlan + Label item; BackupPlan + helm chart + Object) to support the growth of their protection scope.
There are icons and layers presented on top of the different application views that provide the user additional details around the status of their applications from a management and protection point of view.
Protected Indicator - A green border around an item in any of the views indicates that the specific item has a BackupPlan with at least 1 successful backup.
Backup Status Indicator - Indicates status of the last backup based on a backupPlan with that specific item only. This is denoted by a green/yellow/red dot accordingly.
Restore Status Indicator - Indicates if a restore has occurred based on a backup of a backupPlan with that specific item only.
Scheduling Policy - Indicates if there is backupPlan with that specific item and if it is protected via a scheduled policy
Labels/Objects - Additional items that describe the items based on labels and objects names.
Application layers can be turned on/off based on the view in scope.
For each of the views provided, Trilio also provides filters to simplify searching for applications based on 'protected/unprotected', 'has a PV' etc. status.
Application Status - Filters applications that are protected or unprotected. A protected application is one that has a matching backupPlan with exactly that application defined in the backup component section, with at least one successful backup.
Application Tooling - Available only for the Application Tooling view that allows users to filter based on Helm or Operator based applications.
Persistent Volume Claim - Available for all views except object view enabling users to filter apps on the discovery page based on whether or not an app has an associated PV.
Search by Labels - Available only for Labels view, allows users to filter by searching for the label directly.
Search by Object Type - Available only for the Object view, allows users to filter by object type directly
Search by BackupPlan - Available only for the BackupPlan View, allows users to search based on the BackupPlans available.
The right-most panel of the landing page is the Monitoring panel. This panel shows a summary of the backups, restore, targets and the applications that the user selects as they are defining their BackupPlan or protection scope.
The Backup and Restore summary monitor box provides a snapshot view of either the namespace selected in the navigation panel or applications/items selected from the views provided. As a user selects items from different views, the monitors change information to reflect information for backupPlans consisting of the selected applications only.
These monitor boxes provide information in terms of Successful, In-progress, and Failed backups and restores.
The Backups tab shows the backups associated for the applications selected on the application discovery panel for all BackupPlans consisting of those application. If there are no existing backupPlans or backups based on backupPlans, then the Backups tab will be empty. The user can choose to restore, delete, view metadata, view restores and status log for the backups available.
The details tab is activated when the user selects one or more applications on the discovery panel. The details tab shows the metadata associated with the applications selected. It provides the user an idea of the objects that will be collected if the user chooses to backup the selected applications. The Details tab provides the user an intuitive understanding of his application selection and whether the selected applications satisfy backup requirements or not.
The Target Summary view shows the space occupied by either the backups in a namespace selected on the navigation panel or backups based on the backupPlans of items (exact match) selected from the discovery panel.
For items selected from the Application Discovery panel, space occupied by the selected items along with the space of their backups are shown together.
The application summary view is a guide to help the user understand the different items selected between the various views that have been provided. When no items are selected from the application views, the summary represents a snapshot of the applications in the entire namespace. The counters for the application types increase based on the items selected from the different views. Along with a list of the items chosen, the summary also provides information around the protected/unprotected status of those items.
The logic used to build the Application summary is as follows
BackupPlan with a helm release only = Helm app
BackupPlan with a Operator block only = Operator app
BackupPlan with labels only = Custom app
BackupPlan with any combination of 1-3 = Custom app
The logic used to show the Application summary based on selection of items by the user is as follows:
Selection of a Helm item = Helm counter++
Selection of a Operator item = Operator counter ++
Selection from Labels view = Custom counter ++
Selection from Object View = Custom counter++
Selection from BackupPlan view = Custom counter++
Trilio will add a separate counter for BackupPlan in the next release.
The TVK Health Box is a static box that provides the health information for the pods supporting the TVK solution instance.