[2.9.0] Document the SQLite-backed caching experimental feature (#1337)

* Document the SQLite-backed caching experimental feature

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* fix vale warnings

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* Apply suggestions from code review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* specify hotkey by OS

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* whitespace fix

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* port fixes to 2.9 version

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* Apply suggestions from code review

Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>

* Update docs/how-to-guides/advanced-user-guides/enable-experimental-features/sqlite-caching.md

Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>

* use clearer title, fix vale warning

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* Apply suggestions from code review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* Apply suggestions from code review

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* add flag to installation guide

Signed-off-by: Silvio Moioli <silvio@moioli.net>

---------

Signed-off-by: Silvio Moioli <silvio@moioli.net>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>
This commit is contained in:
Silvio Moioli
2024-08-01 01:27:26 +02:00
committed by GitHub
parent 65611d53d3
commit 89a564610c
4 changed files with 88 additions and 0 deletions
@@ -29,6 +29,8 @@ The following is a list of feature flags available in Rancher. If you've upgrade
- `rke2`: Enables provisioning RKE2 clusters. This flag is enabled by default.
- `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.
- `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 a SQLite-based cache for UI tables. See [UI Server-Side Pagination](../../../how-to-guides/advanced-user-guides/enable-experimental-features/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:
@@ -42,3 +44,4 @@ The following table shows the availability and default values for some feature f
| `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 |
| `rke2` | `true` | Experimental | v2.6.0 |
| `token-hashing` | `false` for new installs, `true` for upgrades | GA | v2.6.0 |
| `ui-sql-cache` | `false` | Highly experimental | v2.9.0 |