Skip to content

Commit dbda8dc

Browse files
docs: Document stylus.includeTui flag deprecation (#8678)
* Document that Palette TUI is always enabled * ci: auto-formatting prettier issues * Update glossary-all.md --------- Co-authored-by: svetlana-efimova <[email protected]>
1 parent c415488 commit dbda8dc

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

docs/docs-content/clusters/edge/edge-configuration/installer-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ listed in alphabetical order.
3333
| `stylus.enableMultiNode` | When set to `true`, the host can link with other nodes to form a multi-node cluster. For more information, refer to [Link Hosts](../local-ui/cluster-management/link-hosts.md). | boolean | `false` |
3434
| `stylus.externalRegistries` | Use this parameter to configure multiple external registries and apply domain re-mapping rules. Refer to [Multiple External Registries](#multiple-external-registries) for more details. | Object | None |
3535
| `stylus.featureGate` | This parameter contains a comma-separated list of features you want to enable on your host. | String | `''` |
36-
| `stylus.includeTui` | Enable Palette TUI for initial Edge host configuration. For more information, refer to [Initial Edge Host Configuration](../site-deployment/site-installation/initial-setup.md). | boolean | `false` |
36+
| `stylus.includeTui` | (Deprecated) Enable Palette TUI for initial Edge host configuration. This parameter has been deprecated, and Palette TUI is always enabled regardless of its value. For more information, refer to [Initial Edge Host Configuration](../site-deployment/site-installation/initial-setup.md). | boolean | `false` |
3737
| `stylus.installationMode` | (Deprecated) Allowed values are `connected` and `airgap`. `connected` means the Edge host is connected to Palette; `airgap` means the Edge host has no connection. This parameter has been deprecated and will be removed in an future release. Use the `stylus.managementMode` parameter instead. | String | `connected` |
3838
| `stylus.localUI.login.attemptsBeforeExponentialDelayStarts` | Number of consecutive failed Local UI login attempts before the exponential delay begins. After this threshold, each additional failed attempt doubles the wait time before the user can attempt to log in again. This parameter takes effect only when `stylus.localUI.login.disableRateLimiting` is set to `false` and is supported for Edge hosts built with Palette agent version 4.7.16 or later. | Integer | `3` |
3939
| `stylus.localUI.login.disableRateLimiting` | When set to `false`, Local UI enforces a short delay after several consecutive failed login attempts and temporarily blocks the user's access. This parameter is supported for Edge hosts built with Palette agent version 4.7.16 or later. | boolean | `false` |

docs/docs-content/glossary-all.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -249,9 +249,8 @@ upstream open source Kubernetes distribution.
249249

250250
## Palette Terminal User Interface (TUI)
251251

252-
Palette TUI is a terminal user interface that allows users to configure host and network settings for their Edge hosts.
253-
Palette TUI is not enabled by default, and must have the `stylus.includeTui` parameter set to true for it to be enabled
254-
automatically.
252+
Palette TUI is a terminal user interface that is always enabled and allows users to configure host and network settings
253+
for their Edge hosts.
255254

256255
## Palette Upgrade Controller
257256

0 commit comments

Comments
 (0)