mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 04:28:15 +00:00
Updating after review to include disk space info and moving out of experimental section.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
This commit is contained in:
Sunil Singh
+1
-1
@@ -56,7 +56,7 @@ You can enable this feature on a per-cluster basis. For more information, please
|
||||
- `token-hashing`: Enables token hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically with the SHA256 algorithm. Once a token is hashed it can't be undone. This flag can't be disabled after its enabled. See [API Tokens](../../../api/api-tokens.md#token-hashing) for more information.
|
||||
- `uiextension`: Enables UI extensions. This flag is enabled by default. Enabling or disabling the flag forces the Rancher pod to restart. The first time this flag is set to `Active`, it creates a CRD and enables the controllers and endpoints necessary for the feature to work. If set to `Disabled`, it disables the previously mentioned controllers and endpoints. Setting `uiextension` to `Disabled` has no effect on the CRD -- it does not create a CRD if it does not yet exist, nor does it delete the CRD if it already exists.
|
||||
- `unsupported-storage-drivers`: Enables types for storage providers and provisioners that aren't enabled by default. See [Allow Unsupported Storage Drivers](../../../how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md) for more information.
|
||||
- `ui-sql-cache`: Enables an SQLite-based cache for UI tables and Server-Side Pagination. See [UI Server-Side Pagination](../../../how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination.md) for more information.
|
||||
- `ui-sql-cache`: Enables an SQLite-based cache for UI tables and Server-Side Pagination. See [UI Server-Side Pagination](../../../how-to-guides/advanced-user-guides/ui-server-side-pagination.md) for more information.
|
||||
|
||||
The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available:
|
||||
|
||||
|
||||
+17
-7
@@ -3,12 +3,22 @@ title: UI Server-Side Pagination
|
||||
---
|
||||
|
||||
<head>
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination"/>
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/ui-server-side-pagination"/>
|
||||
</head>
|
||||
|
||||
The feature flag `ui-sql-cache` is enabled by default and implements the UI server-side pagination caching. The functionality provides an SQLite-backed cache of Kubernetes objects to improve performance. This adds sorting, filtering and pagination features used by the UI to restrict the amount of resources it fetches and stores in browser memory. These features are primarily used to improve list performance for resources with high counts.
|
||||
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.
|
||||
|
||||
This feature creates file system based caches in the `rancher` pods of the upstream cluster, and in the `cattle-cluster-agent` pods of the downstream clusters. In most environments, disk usage and I/O should not be significant. However, you should monitor activity after you enable caching.
|
||||
## Disk Space
|
||||
|
||||
:::important
|
||||
It is crucial that you review the available disk space on your nodes and plan accordingly before upgrading to Rancher v2.12.0 and later to avoid potential disk pressure and pod eviction issues.
|
||||
:::
|
||||
|
||||
The SSP relies on a caching mechanism that introduces a new requirement for ephemeral disk space on your cluster nodes. This cache, an internal SQLite database, is stored within the container's file system. This affects the nodes running the **Rancher server pods** (`rancher` in the `cattle-system` namespace on the local cluster) and the nodes running the **Rancher agent pods** (`cattle-cluster-agent` in the `cattle-system` namespace on all downstream clusters).
|
||||
|
||||
The amount of disk space required is dynamic and depends on the quantity and size of Kubernetes resources visualized in the UI. As a guideline, the cache may consume approximately **twice the size of the raw Kubernetes objects** it stores.
|
||||
|
||||
For example, internal tests showed that caching 5000 ConfigMaps, totaling 50 MB, consumed 81 MB of disk space. For a conservative, high-level estimate, you can plan for the available disk space on each relevant node to be at least **twice the size of your etcd snapshot**. For most production environments, ensuring a few extra gigabytes of storage are available on the relevant nodes is a safe starting point.
|
||||
|
||||
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.
|
||||
|
||||
@@ -34,13 +44,13 @@ 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 Pods, Secrets, Nodes and ConfigMaps in the Cluster Explorer pages, and most resources in the Explorer's **More Resources** section.
|
||||
|
||||
Pages can't be automatically refreshed. You can manually refresh table contents by clicking the **Refresh** button.
|
||||
- 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.
|
||||
|
||||
### Regressions
|
||||
|
||||
There were performance regressions following the resource cache support changes, and they are outlined below:
|
||||
The following regressions occur when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists.
|
||||
|
||||
- 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.
|
||||
+1
-1
@@ -785,7 +785,6 @@ const sidebars = {
|
||||
id: "how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features",
|
||||
},
|
||||
items: [
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/rancher-on-arm64",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features",
|
||||
@@ -801,6 +800,7 @@ const sidebars = {
|
||||
"how-to-guides/advanced-user-guides/enable-cluster-agent-scheduling-customization",
|
||||
"how-to-guides/advanced-user-guides/configure-layer-7-nginx-load-balancer",
|
||||
"how-to-guides/advanced-user-guides/configure-oidc-provider",
|
||||
"how-to-guides/advanced-user-guides/ui-server-side-pagination"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
+1
-1
@@ -56,7 +56,7 @@ You can enable this feature on a per-cluster basis. For more information, please
|
||||
- `token-hashing`: Enables token hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically with the SHA256 algorithm. Once a token is hashed it can't be undone. This flag can't be disabled after its enabled. See [API Tokens](../../../api/api-tokens.md#token-hashing) for more information.
|
||||
- `uiextension`: Enables UI extensions. This flag is enabled by default. Enabling or disabling the flag forces the Rancher pod to restart. The first time this flag is set to `Active`, it creates a CRD and enables the controllers and endpoints necessary for the feature to work. If set to `Disabled`, it disables the previously mentioned controllers and endpoints. Setting `uiextension` to `Disabled` has no effect on the CRD -- it does not create a CRD if it does not yet exist, nor does it delete the CRD if it already exists.
|
||||
- `unsupported-storage-drivers`: Enables types for storage providers and provisioners that aren't enabled by default. See [Allow Unsupported Storage Drivers](../../../how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md) for more information.
|
||||
- `ui-sql-cache`: Enables an SQLite-based cache for UI tables and Server-Side Pagination. See [UI Server-Side Pagination](../../../how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination.md) for more information.
|
||||
- `ui-sql-cache`: Enables an SQLite-based cache for UI tables and Server-Side Pagination. See [UI Server-Side Pagination](../../../how-to-guides/advanced-user-guides/ui-server-side-pagination.md) for more information.
|
||||
|
||||
The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available:
|
||||
|
||||
|
||||
+17
-7
@@ -3,12 +3,22 @@ title: UI Server-Side Pagination
|
||||
---
|
||||
|
||||
<head>
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination"/>
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/ui-server-side-pagination"/>
|
||||
</head>
|
||||
|
||||
The feature flag `ui-sql-cache` is enabled by default and implements the UI server-side pagination caching. The functionality provides an SQLite-backed cache of Kubernetes objects to improve performance. This adds sorting, filtering and pagination features used by the UI to restrict the amount of resources it fetches and stores in browser memory. These features are primarily used to improve list performance for resources with high counts.
|
||||
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.
|
||||
|
||||
This feature creates file system based caches in the `rancher` pods of the upstream cluster, and in the `cattle-cluster-agent` pods of the downstream clusters. In most environments, disk usage and I/O should not be significant. However, you should monitor activity after you enable caching.
|
||||
## Disk Space
|
||||
|
||||
:::important
|
||||
It is crucial that you review the available disk space on your nodes and plan accordingly before upgrading to Rancher v2.12.0 and later to avoid potential disk pressure and pod eviction issues.
|
||||
:::
|
||||
|
||||
The SSP relies on a caching mechanism that introduces a new requirement for ephemeral disk space on your cluster nodes. This cache, an internal SQLite database, is stored within the container's file system. This affects the nodes running the **Rancher server pods** (`rancher` in the `cattle-system` namespace on the local cluster) and the nodes running the **Rancher agent pods** (`cattle-cluster-agent` in the `cattle-system` namespace on all downstream clusters).
|
||||
|
||||
The amount of disk space required is dynamic and depends on the quantity and size of Kubernetes resources visualized in the UI. As a guideline, the cache may consume approximately **twice the size of the raw Kubernetes objects** it stores.
|
||||
|
||||
For example, internal tests showed that caching 5000 ConfigMaps, totaling 50 MB, consumed 81 MB of disk space. For a conservative, high-level estimate, you can plan for the available disk space on each relevant node to be at least **twice the size of your etcd snapshot**. For most production environments, ensuring a few extra gigabytes of storage are available on the relevant nodes is a safe starting point.
|
||||
|
||||
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.
|
||||
|
||||
@@ -34,13 +44,13 @@ 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 Pods, Secrets, Nodes and ConfigMaps in the Cluster Explorer pages, and most resources in the Explorer's **More Resources** section.
|
||||
|
||||
Pages can't be automatically refreshed. You can manually refresh table contents by clicking the **Refresh** button.
|
||||
- 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.
|
||||
|
||||
### Regressions
|
||||
|
||||
There were performance regressions following the resource cache support changes, and they are outlined below:
|
||||
The following regressions occur when the feature is enabled. These mainly revolve around different sort or filter behaviors in affected lists.
|
||||
|
||||
- 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.
|
||||
@@ -751,7 +751,6 @@
|
||||
"id": "how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features"
|
||||
},
|
||||
"items": [
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/ui-server-side-pagination",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/rancher-on-arm64",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers",
|
||||
"how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features",
|
||||
@@ -766,7 +765,8 @@
|
||||
"how-to-guides/advanced-user-guides/enable-user-retention",
|
||||
"how-to-guides/advanced-user-guides/enable-cluster-agent-scheduling-customization",
|
||||
"how-to-guides/advanced-user-guides/configure-layer-7-nginx-load-balancer",
|
||||
"how-to-guides/advanced-user-guides/configure-oidc-provider"
|
||||
"how-to-guides/advanced-user-guides/configure-oidc-provider",
|
||||
"how-to-guides/advanced-user-guides/ui-server-side-pagination"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user