public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 20:48:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

#501 feature flags missing from documentation (#504)

Browse Source 
* #501 Undocumented feature flags in 2.7.x

did a refresh of the feature flag page while waiting for a response to request for blurbs

* undocumented features listed with blurbs based on the UI

* typo fix

* Apply suggestions from code review

Co-authored-by: Brad Davidson <brad@oatmail.org>

* note about discontinued flags, rewording descriptions, updated table to rm things that have been available since before 2.5

* added rke1 flag info, updated 2.6 page

* added 2.5 page

* rm'd pointless column from 2.5 table

* updated based on suggestions from code review

* rm'd specific mention of version

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Brad Davidson <brad@oatmail.org>
Co-authored-by: Billy Tat <btat@suse.com>
This commit is contained in:
Marty Hernandez Avedon
2023-04-17 11:19:12 -04:00
committed by GitHub
co-authored by Brad Davidson Billy Tat
parent f3612708d0
commit 470d730424
3 changed files with 63 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md
+14 -18
View File
@@ -2,32 +2,28 @@
title: Feature Flags
---
Feature flags were introduced to allow you to try experimental features that are not enabled by default.
With feature flags, you can try out optional or experimental features.
To learn about feature values and how to enable features, refer [here](../../pages-for-subheaders/enable-experimental-features.md).
To learn more about feature values and how to enable them, see [Enabling Experimental Features](../../pages-for-subheaders/enable-experimental-features.md).
:::note
There are some feature flags that may require a restart of the Rancher server container. These features that require a restart are marked in the table of these docs and in the UI.
Some feature flags require a restart of the Rancher container. Features that require a restart are marked in the Rancher UI.
:::
The following is a list of the feature flags available in Rancher:
The following is a list of feature flags available in Rancher. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard`:
- `fleet`: Rancher comes with Fleet preinstalled in v2.5+.
- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules,](../../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features.md) which are traffic management features of Istio.
- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.](../../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md). In other words, it enables types for storage providers and provisioners that are not enabled by default.
- `unsupported-storage-drivers`: Enables types for storage providers and provisioners that aren't enabled by default. See [Allow Unsupported Storage Drivers](../../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md) for more information.
The below table shows the availability and default value for feature flags in Rancher:
The following table shows the availability and default value for some feature flags in Rancher. Features marked "GA" are generally available:
| Feature Flag Name | Default Value | Status | Available as of | Rancher Restart Required? |
| ----------------------------- | ------------- | ------------ | --------------- |---|
| `dashboard` | `true` | Experimental | v2.4.0 | X |
| `dashboard` | `true` | GA* and no longer a feature flag | v2.5.0 | X |
| `istio-virtual-service-ui` | `false` | Experimental | v2.3.0 | |
| `istio-virtual-service-ui` | `true` | GA* | v2.3.2 | |
| `proxy` | `false` | Experimental | v2.4.0 | |
| `proxy` | N/A | Discontinued | v2.5.0 | X |
| `unsupported-storage-drivers` | `false` | Experimental | v2.3.0 | |
| `fleet` | `true` | GA* | v2.5.0 | |
\* Generally Available. This feature is included in Rancher and it is not experimental.
| Feature Flag Name | Default Value | Status | Available As Of |
| ----------------- | ------------- | ------ | --------------- |
| `dashboard` | `true` | GA and no longer a feature flag | v2.5.0 |
| `dashboard` | `true` | Experimental | v2.4.0 |
| `fleet` | `true` | GA | v2.5.0 |
| `proxy` | N/A | Discontinued | v2.5.0 |
| `proxy` | `false` | Experimental | v2.4.0 |