mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 12:38:05 +00:00
Updating content after review feedback. Synthesizing the known limitations section.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
This commit is contained in:
Sunil Singh
@@ -6,7 +6,9 @@ title: UI Server-Side Pagination
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/ui-server-side-pagination"/>
|
||||
</head>
|
||||
|
||||
UI Server-Side Pagination (SSP) is **enabled by default** via the feature flag `ui-sql-cache` and provides an SQLite-backed cache of Kubernetes objects. This unlocks sorting, filtering and pagination features used by the UI to restrict the amount of resources it fetches and stores in browser memory, and also monitors. These features are primarily used to improve list performance for resources with high counts.
|
||||
Server-Side Pagination (SSP) is a Rancher feature to provide significant performance improvements across the UI for resources with high counts, restricting the amount of resources browser fetches and stores in memory.
|
||||
|
||||
Note that SSP is optional, **enabled by default**, and it can be disabled via the feature flag `ui-sql-cache`.
|
||||
|
||||
## Disk Space
|
||||
|
||||
@@ -22,14 +24,14 @@ For example, internal tests showed that caching 5000 ConfigMaps, totaling 50 MB,
|
||||
|
||||
SQLite-backed caching persists copies of any cached Kubernetes objects to disk. See [Encrypting SQLite-backed Caching](#encrypting-sqlite-backed-caches) if this is a security concern.
|
||||
|
||||
## Enabling via UI: `ui-sql-cache` and Server-Side Pagination
|
||||
## Enabling Server-Side Pagination
|
||||
|
||||
1. In the upper left corner, click **☰ > Global Settings > Feature Flags**.
|
||||
1. Find **`ui-sql-cache`** and select **⋮ > Activate > Activate**.
|
||||
1. Wait for Rancher to restart. This also restarts agents on all downstream clusters.
|
||||
1. Reload the page with the browser button (or the equivalent keyboard combination, typically `CTRL + R` on Windows and Linux, and `⌘ + R` on macOS).
|
||||
|
||||
## Disabling via UI: `ui-sql-cache` and Server-Side Pagination
|
||||
## Disabling Server-Side Pagination
|
||||
|
||||
1. In the upper left corner, click **☰ > Global Settings > Feature Flags**.
|
||||
1. Find **`ui-sql-cache`** and select **⋮ > Deactivate > Deactivate**.
|
||||
@@ -44,20 +46,17 @@ Secrets and security Tokens are always encrypted regardless of the above setting
|
||||
|
||||
## Known Limitations of UI Server-Side Pagination
|
||||
|
||||
- This initial release improves the performance of most pages used to view, create or edit resources within the `local` or downstream clusters i.e. the Cluster Explorer view.
|
||||
- Areas outside the Cluster Explorer are not yet covered by this feature.
|
||||
- Resources in Lists are automatically updated, however not instantaneously.
|
||||
This release improves the performance of most pages used to view, create or edit resources within the `local` or downstream clusters i.e. the Cluster Explorer view. However, RBAC related resources and areas outside the Cluster Explorer are not yet covered by this feature.
|
||||
|
||||
### Regressions
|
||||
|
||||
The following regressions occur when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists.
|
||||
Additionally, the following limitations are present when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists:
|
||||
|
||||
- Resources in lists are automatically updated, however, not instantaneously.
|
||||
- All lists that utilize Server-Side Pagination:
|
||||
- `State` column sort and filter features work on the resources `metadata.state.name` field instead of one deduced locally by the UI.
|
||||
- Updates are shown every 5 seconds, rather than instantly.
|
||||
- Cluster Explorer:
|
||||
- `Cluster` group --> `Nodes` page
|
||||
- The following columns are now not sortable or filterable: `Roles`, `External/Internal IP`, `CPU`, `RAM` (logic to determine their value is calculated in the browser)
|
||||
- The following columns are not sortable or filterable: `Roles`, `External/Internal IP`, `CPU`, `RAM` (logic to determine their value is calculated in the browser)
|
||||
- `Workloads` list:
|
||||
- The `Workloads` list, which showed multiple different resource types has been removed.
|
||||
- Server-Side Pagination of multiple resources is not currently possible.
|
||||
@@ -65,13 +64,13 @@ The following regressions occur when the feature is enabled. These mainly revolv
|
||||
- `Pod Restarts` and `Workload Health` columns have been removed.
|
||||
- [Re-enable Pod Restart Count and Pod Health columns for Workload lists #14211](https://github.com/rancher/dashboard/issues/14211)
|
||||
- `Workloads` group / `Job` List
|
||||
- `Duration` is now not sortable (sorting on a duration).
|
||||
- `Duration` is not sortable (sorting on a duration).
|
||||
- [Implement more complex server-side pagination sorting #12815](https://github.com/rancher/dashboard/issues/12815)
|
||||
- `Workloads` group / `Pod` List
|
||||
- `Images` is now not sortable (sorting on an array).
|
||||
- `Images` is not sortable (sorting on an array).
|
||||
- `Service Discovery` group / `Ingresses`
|
||||
- `Default` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Default` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Storage` group / `ConfigMaps`
|
||||
- `Data` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Data` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Storage` group / `Secrets`
|
||||
- `Data` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Data` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
|
||||
+14
-15
@@ -6,7 +6,9 @@ title: UI Server-Side Pagination
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/ui-server-side-pagination"/>
|
||||
</head>
|
||||
|
||||
UI Server-Side Pagination (SSP) is **enabled by default** via the feature flag `ui-sql-cache` and provides an SQLite-backed cache of Kubernetes objects. This unlocks sorting, filtering and pagination features used by the UI to restrict the amount of resources it fetches and stores in browser memory, and also monitors. These features are primarily used to improve list performance for resources with high counts.
|
||||
Server-Side Pagination (SSP) is a Rancher feature to provide significant performance improvements across the UI for resources with high counts, restricting the amount of resources browser fetches and stores in memory.
|
||||
|
||||
Note that SSP is optional, **enabled by default**, and it can be disabled via the feature flag `ui-sql-cache`.
|
||||
|
||||
## Disk Space
|
||||
|
||||
@@ -22,14 +24,14 @@ For example, internal tests showed that caching 5000 ConfigMaps, totaling 50 MB,
|
||||
|
||||
SQLite-backed caching persists copies of any cached Kubernetes objects to disk. See [Encrypting SQLite-backed Caching](#encrypting-sqlite-backed-caches) if this is a security concern.
|
||||
|
||||
## Enabling via UI: `ui-sql-cache` and Server-Side Pagination
|
||||
## Enabling Server-Side Pagination
|
||||
|
||||
1. In the upper left corner, click **☰ > Global Settings > Feature Flags**.
|
||||
1. Find **`ui-sql-cache`** and select **⋮ > Activate > Activate**.
|
||||
1. Wait for Rancher to restart. This also restarts agents on all downstream clusters.
|
||||
1. Reload the page with the browser button (or the equivalent keyboard combination, typically `CTRL + R` on Windows and Linux, and `⌘ + R` on macOS).
|
||||
|
||||
## Disabling via UI: `ui-sql-cache` and Server-Side Pagination
|
||||
## Disabling Server-Side Pagination
|
||||
|
||||
1. In the upper left corner, click **☰ > Global Settings > Feature Flags**.
|
||||
1. Find **`ui-sql-cache`** and select **⋮ > Deactivate > Deactivate**.
|
||||
@@ -44,20 +46,17 @@ Secrets and security Tokens are always encrypted regardless of the above setting
|
||||
|
||||
## Known Limitations of UI Server-Side Pagination
|
||||
|
||||
- This initial release improves the performance of most pages used to view, create or edit resources within the `local` or downstream clusters i.e. the Cluster Explorer view.
|
||||
- Areas outside the Cluster Explorer are not yet covered by this feature.
|
||||
- Resources in Lists are automatically updated, however not instantaneously.
|
||||
This release improves the performance of most pages used to view, create or edit resources within the `local` or downstream clusters i.e. the Cluster Explorer view. However, RBAC related resources and areas outside the Cluster Explorer are not yet covered by this feature.
|
||||
|
||||
### Regressions
|
||||
|
||||
The following regressions occur when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists.
|
||||
Additionally, the following limitations are present when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists:
|
||||
|
||||
- Resources in lists are automatically updated, however, not instantaneously.
|
||||
- All lists that utilize Server-Side Pagination:
|
||||
- `State` column sort and filter features work on the resources `metadata.state.name` field instead of one deduced locally by the UI.
|
||||
- Updates are shown every 5 seconds, rather than instantly.
|
||||
- Cluster Explorer:
|
||||
- `Cluster` group --> `Nodes` page
|
||||
- The following columns are now not sortable or filterable: `Roles`, `External/Internal IP`, `CPU`, `RAM` (logic to determine their value is calculated in the browser)
|
||||
- The following columns are not sortable or filterable: `Roles`, `External/Internal IP`, `CPU`, `RAM` (logic to determine their value is calculated in the browser)
|
||||
- `Workloads` list:
|
||||
- The `Workloads` list, which showed multiple different resource types has been removed.
|
||||
- Server-Side Pagination of multiple resources is not currently possible.
|
||||
@@ -65,13 +64,13 @@ The following regressions occur when the feature is enabled. These mainly revolv
|
||||
- `Pod Restarts` and `Workload Health` columns have been removed.
|
||||
- [Re-enable Pod Restart Count and Pod Health columns for Workload lists #14211](https://github.com/rancher/dashboard/issues/14211)
|
||||
- `Workloads` group / `Job` List
|
||||
- `Duration` is now not sortable (sorting on a duration).
|
||||
- `Duration` is not sortable (sorting on a duration).
|
||||
- [Implement more complex server-side pagination sorting #12815](https://github.com/rancher/dashboard/issues/12815)
|
||||
- `Workloads` group / `Pod` List
|
||||
- `Images` is now not sortable (sorting on an array).
|
||||
- `Images` is not sortable (sorting on an array).
|
||||
- `Service Discovery` group / `Ingresses`
|
||||
- `Default` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Default` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Storage` group / `ConfigMaps`
|
||||
- `Data` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Data` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Storage` group / `Secrets`
|
||||
- `Data` is now not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
- `Data` is not sortable/filterable (logic to determine their value is calculated in the browser).
|
||||
|
||||
Reference in New Issue
Block a user