From 7da4eec177ed3eacf8e83414313b3bc0e819f732 Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 22 Mar 2023 17:42:26 -0400 Subject: [PATCH 01/11] #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 --- .../installation-references/feature-flags.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index d41c822709a3..48f76cce326d 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -2,27 +2,27 @@ 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 experimental features that aren't enabled by default. -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, and in the table at the end of this document. ::: -The following is a list of the feature flags available in Rancher: - -- `harvester`: This feature flag is available starting in v2.6.1. It is used to manage access to the Virtualization Management page where users can navigate directly to Harvester clusters and access the Harvester UI. For more information, see [this page](../../../integrations-in-rancher/harvester.md#feature-flag/). -- `rke2`: Used to enable the ability to provision RKE2 clusters. By default, this feature flag is enabled, which allows users to attempt to provision these type of clusters. -- `fleet`: The previous `fleet` feature flag is now required to be enabled as the Fleet capabilities are leveraged within the new provisioning framework. If you had this feature flag disabled in earlier versions, upon upgrading to Rancher v2.6, the flag will automatically be enabled. See this [page](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that could not be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow the GitOps feature of Fleet to be disabled. For more information, see [this page.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) -- `legacy`: There are a set of features from previous versions that are slowly being phased out of Rancher for newer iterations of the feature. This is a mix of deprecated features as well as features that will eventually be moved to newer variations in Rancher. By default, this feature flag is disabled for new installations. If you are upgrading from a previous version, this feature flag would be enabled. -- `token-hashing`: Used to enable new token-hashing feature. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically using the SHA256 algorithm. Once a token is hashed it cannot be undone. Once this feature flag is enabled, it cannot be disabled. See [hashing of tokens](../../../reference-guides/about-the-api/api-tokens.md) for more information. -- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md). In other words, it enables types for storage providers and provisioners that are not enabled by default. -- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules,](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) which are traffic management features of Istio. -- `multi-cluster-management`: Used for multi-cluster provisioning and management of Kubernetes clusters. This feature flag can only be set at install time and not changed afterwards. +The following is a list of feature flags available in Rancher: + +- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that couldn't be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow Fleet GitOps to be disabled. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. +- `fleet`: You must enable this flag in Rancher versions v2.6 and later, since Fleet features are required by the provisioning framework. If you had this flag disabled in earlier versions of Rancher, the flag will be automatically enabled when you upgrade to v2.6 or later. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. +- `harvester` (Rancher v2.6.1 and later): Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. +- `istio-virtual-service-ui`: This flag enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. +- `legacy`: There are a set of features from previous versions of Rancher that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually move to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. +- `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. +- `rke2`: Enables provisioning RKE2 clusters. This flag is enabled bt default. +- `token-hashing`: Enables token-hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically, using 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](../../../reference-guides/about-the-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. The below table shows the availability and default value for feature flags in Rancher: From f95284a67f8e7b84a2e578d0dfc84ba9dbcf9f98 Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 22 Mar 2023 18:03:40 -0400 Subject: [PATCH 02/11] undocumented features listed with blurbs based on the UI --- .../installation-references/feature-flags.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 48f76cce326d..f467bd6f7db9 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -15,11 +15,14 @@ Some feature flags require a restart of the Rancher container. Features that req The following is a list of feature flags available in Rancher: - `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that couldn't be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow Fleet GitOps to be disabled. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. +- `dashboard` (v2.7.1): Enables an experimental cluster resource management UI. - `fleet`: You must enable this flag in Rancher versions v2.6 and later, since Fleet features are required by the provisioning framework. If you had this flag disabled in earlier versions of Rancher, the flag will be automatically enabled when you upgrade to v2.6 or later. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. - `harvester` (Rancher v2.6.1 and later): Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. - `istio-virtual-service-ui`: This flag enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: There are a set of features from previous versions of Rancher that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually move to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. +- `proxy` (v2.7.1): Enables an experimental proxy for Kubernetes API requests. +- `rke1-custom-node-cleanup` (v2.6.1 and later): Enables cleanup of deleted RKE1 custom nodes. - `rke2`: Enables provisioning RKE2 clusters. This flag is enabled bt default. - `token-hashing`: Enables token-hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically, using 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](../../../reference-guides/about-the-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. From ddb2db8b286325f84e6245c84aec93fdfae057de Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 22 Mar 2023 18:15:13 -0400 Subject: [PATCH 03/11] typo fix --- .../installation-references/feature-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index f467bd6f7db9..2374fa81d4ae 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -22,7 +22,7 @@ The following is a list of feature flags available in Rancher: - `legacy`: There are a set of features from previous versions of Rancher that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually move to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. - `proxy` (v2.7.1): Enables an experimental proxy for Kubernetes API requests. -- `rke1-custom-node-cleanup` (v2.6.1 and later): Enables cleanup of deleted RKE1 custom nodes. +- `rke1-custom-node-cleanup` (v2.7.1 and later): Enables cleanup of deleted RKE1 custom nodes. - `rke2`: Enables provisioning RKE2 clusters. This flag is enabled bt default. - `token-hashing`: Enables token-hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically, using 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](../../../reference-guides/about-the-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. From 8e13bb2f7052c37de51e72d2aaf42949ccaf6f72 Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Wed, 22 Mar 2023 19:30:46 -0400 Subject: [PATCH 04/11] Apply suggestions from code review Co-authored-by: Brad Davidson --- .../installation-references/feature-flags.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 2374fa81d4ae..fd15dd3be306 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -2,7 +2,7 @@ title: Feature Flags --- -With feature flags, you can try out experimental features that aren't enabled by default. +With feature flags, you can try out experimental features that aren't enabled by default, or enable legacy features that are being phased out. To learn more about feature values and how to enable them, see [Enabling Experimental Features](../../../pages-for-subheaders/enable-experimental-features.md). @@ -23,7 +23,7 @@ The following is a list of feature flags available in Rancher: - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. - `proxy` (v2.7.1): Enables an experimental proxy for Kubernetes API requests. - `rke1-custom-node-cleanup` (v2.7.1 and later): Enables cleanup of deleted RKE1 custom nodes. -- `rke2`: Enables provisioning RKE2 clusters. This flag is enabled bt default. +- `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, using 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](../../../reference-guides/about-the-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. From fa50567dd6486e4845dbe383c7c6b8866a4d4759 Mon Sep 17 00:00:00 2001 From: martyav Date: Mon, 27 Mar 2023 14:28:24 -0400 Subject: [PATCH 05/11] note about discontinued flags, rewording descriptions, updated table to rm things that have been available since before 2.5 --- .../installation-references/feature-flags.md | 53 ++++++++----------- 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index fd15dd3be306..ddb85525a73f 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -2,45 +2,38 @@ title: Feature Flags --- -With feature flags, you can try out experimental features that aren't enabled by default, or enable legacy features that are being phased out. +With feature flags, you can try out optional or experimental features, or enable legacy features that are being phased out. To learn more about feature values and how to enable them, see [Enabling Experimental Features](../../../pages-for-subheaders/enable-experimental-features.md). :::note -Some feature flags require a restart of the Rancher container. Features that require a restart are marked in the Rancher UI, and in the table at the end of this document. +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 feature flags available in Rancher: - -- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that couldn't be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow Fleet GitOps to be disabled. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. -- `dashboard` (v2.7.1): Enables an experimental cluster resource management UI. -- `fleet`: You must enable this flag in Rancher versions v2.6 and later, since Fleet features are required by the provisioning framework. If you had this flag disabled in earlier versions of Rancher, the flag will be automatically enabled when you upgrade to v2.6 or later. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `harvester` (Rancher v2.6.1 and later): Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. -- `istio-virtual-service-ui`: This flag enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. -- `legacy`: There are a set of features from previous versions of Rancher that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually move to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. -- `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. -- `proxy` (v2.7.1): Enables an experimental proxy for Kubernetes API requests. -- `rke1-custom-node-cleanup` (v2.7.1 and later): Enables cleanup of deleted RKE1 custom nodes. +The following is a list of feature flags available in Rancher v2.7. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md) in Rancher v2.5 and later): + +- `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. +- `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. +- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. +- `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. +- `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. +- `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. +- `rke1-custom-node-cleanup`: Enables cleanup of deleted RKE1 custom nodes. - `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, using 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](../../../reference-guides/about-the-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. -The below table shows the availability and default value for feature flags in Rancher: - -| Feature Flag Name | Default Value | Status | Available as of | Rancher Restart Required? | -| ----------------------------- | ------------- | ------------ | --------------- |---| -| `istio-virtual-service-ui` | `false` | Experimental | v2.3.0 | | -| `istio-virtual-service-ui` | `true` | GA* | v2.3.2 | | -| `unsupported-storage-drivers` | `false` | Experimental | v2.3.0 | | -| `fleet` | `true` | GA* | v2.5.0 | | -| `fleet` | `true` | Can no longer be disabled | v2.6.0 | N/A | -| `continuous-delivery` | `true` | GA* | v2.6.0 | | -| `token-hashing` | `false` for new installs, `true` for upgrades | GA* | v2.6.0 | | -| `legacy` | `false` for new installs, `true` for upgrades | GA* | v2.6.0 | | -| `multi-cluster-management` | `false` | GA* | v2.5.0 | | -| `harvester` | `true` | Experimental | v2.6.1 | | -| `rke2` | `true` | Experimental | v2.6.0 | | - -\* Generally Available. This feature is included in Rancher and it is not experimental. \ No newline at end of file +The below table shows the availability and default values for some feature flags in Rancher. Features marked "generally available" are no longer experimental: + +| Feature Flag Name | Default Value | Status | Available As Of | +| ----------------------------- | ------------- | ------------ | --------------- | +| `continuous-delivery` | `true` | Generally available | v2.6.0 | +| `fleet` | `true` | Generally available | v2.5.0 | +| `fleet` | `true` | Can no longer be disabled | v2.6.0 | +| `harvester` | `true` | Experimental | v2.6.1 | +| `legacy` | `false` for new installs, `true` for upgrades | Generally available | v2.6.0 | +| `rke1-custom-node-cleanup`| `true` | | v2.6.0 | +| `rke2` | `true` | Experimental | v2.6.0 | +| `token-hashing` | `false` for new installs, `true` for upgrades | Generally available | v2.6.0 | From cade5255df6dd792b0b87807cdb63a38c6141f76 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 Mar 2023 14:36:33 -0400 Subject: [PATCH 06/11] added rke1 flag info, updated 2.6 page --- .../installation-references/feature-flags.md | 18 +++--- .../installation-references/feature-flags.md | 56 +++++++++---------- 2 files changed, 35 insertions(+), 39 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index ddb85525a73f..540798715944 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -2,7 +2,7 @@ title: Feature Flags --- -With feature flags, you can try out optional or experimental features, or enable legacy features that are being phased out. +With feature flags, you can try out optional or experimental features, and enable legacy features that are being phased out. To learn more about feature values and how to enable them, see [Enabling Experimental Features](../../../pages-for-subheaders/enable-experimental-features.md). @@ -20,20 +20,20 @@ The following is a list of feature flags available in Rancher v2.7. If you've up - `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. -- `rke1-custom-node-cleanup`: Enables cleanup of deleted RKE1 custom nodes. +- `rke1-custom-node-cleanup`: Enables cleanup of deleted RKE1 custom nodes. We recommend that you keep this flag enabled, to prevent removed nodes from attempting to rejoin the cluster. - `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, using 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](../../../reference-guides/about-the-api/api-tokens.md#token-hashing) for more information. +- `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](../../../reference-guides/about-the-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. -The below table shows the availability and default values for some feature flags in Rancher. Features marked "generally available" are no longer experimental: +The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: | Feature Flag Name | Default Value | Status | Available As Of | | ----------------------------- | ------------- | ------------ | --------------- | -| `continuous-delivery` | `true` | Generally available | v2.6.0 | -| `fleet` | `true` | Generally available | v2.5.0 | +| `continuous-delivery` | `true` | GA | v2.6.0 | +| `fleet` | `true` | GA | v2.5.0 | | `fleet` | `true` | Can no longer be disabled | v2.6.0 | | `harvester` | `true` | Experimental | v2.6.1 | -| `legacy` | `false` for new installs, `true` for upgrades | Generally available | v2.6.0 | -| `rke1-custom-node-cleanup`| `true` | | v2.6.0 | +| `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | +| `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 | | `rke2` | `true` | Experimental | v2.6.0 | -| `token-hashing` | `false` for new installs, `true` for upgrades | Generally available | v2.6.0 | +| `token-hashing` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md index d41c822709a3..d41237d35627 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -2,42 +2,38 @@ 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, and enable legacy features that are being phased out. -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 v2.6. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md) in Rancher v2.5 and later): -- `harvester`: This feature flag is available starting in v2.6.1. It is used to manage access to the Virtualization Management page where users can navigate directly to Harvester clusters and access the Harvester UI. For more information, see [this page](../../../integrations-in-rancher/harvester.md#feature-flag/). -- `rke2`: Used to enable the ability to provision RKE2 clusters. By default, this feature flag is enabled, which allows users to attempt to provision these type of clusters. -- `fleet`: The previous `fleet` feature flag is now required to be enabled as the Fleet capabilities are leveraged within the new provisioning framework. If you had this feature flag disabled in earlier versions, upon upgrading to Rancher v2.6, the flag will automatically be enabled. See this [page](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that could not be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow the GitOps feature of Fleet to be disabled. For more information, see [this page.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) -- `legacy`: There are a set of features from previous versions that are slowly being phased out of Rancher for newer iterations of the feature. This is a mix of deprecated features as well as features that will eventually be moved to newer variations in Rancher. By default, this feature flag is disabled for new installations. If you are upgrading from a previous version, this feature flag would be enabled. -- `token-hashing`: Used to enable new token-hashing feature. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically using the SHA256 algorithm. Once a token is hashed it cannot be undone. Once this feature flag is enabled, it cannot be disabled. See [hashing of tokens](../../../reference-guides/about-the-api/api-tokens.md) for more information. +- `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. +- `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. +- `harvester`: This feature flag is available starting in v2.6.1. Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. +- `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. +- `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. +- `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. +- `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](../../../reference-guides/about-the-api/api-tokens.md#token-hashing) for more information. - `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md). In other words, it enables types for storage providers and provisioners that are not enabled by default. -- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules,](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) which are traffic management features of Istio. -- `multi-cluster-management`: Used for multi-cluster provisioning and management of Kubernetes clusters. This feature flag can only be set at install time and not changed afterwards. - -The below table shows the availability and default value for feature flags in Rancher: - -| Feature Flag Name | Default Value | Status | Available as of | Rancher Restart Required? | -| ----------------------------- | ------------- | ------------ | --------------- |---| -| `istio-virtual-service-ui` | `false` | Experimental | v2.3.0 | | -| `istio-virtual-service-ui` | `true` | GA* | v2.3.2 | | -| `unsupported-storage-drivers` | `false` | Experimental | v2.3.0 | | -| `fleet` | `true` | GA* | v2.5.0 | | -| `fleet` | `true` | Can no longer be disabled | v2.6.0 | N/A | -| `continuous-delivery` | `true` | GA* | v2.6.0 | | -| `token-hashing` | `false` for new installs, `true` for upgrades | GA* | v2.6.0 | | -| `legacy` | `false` for new installs, `true` for upgrades | GA* | v2.6.0 | | -| `multi-cluster-management` | `false` | GA* | v2.5.0 | | -| `harvester` | `true` | Experimental | v2.6.1 | | -| `rke2` | `true` | Experimental | v2.6.0 | | - -\* Generally Available. This feature is included in Rancher and it is not experimental. \ No newline at end of file + +The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: + +| Feature Flag Name | Default Value | Status | Available As Of | +| ----------------------------- | ------------- | ------------ | --------------- | +| `continuous-delivery` | `true` | GA | v2.6.0 | +| `fleet` | `true` | GA | v2.5.0 | +| `fleet` | `true` | Can no longer be disabled | v2.6.0 | +| `harvester` | `true` | Experimental | v2.6.1 | +| `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | +| `multi-cluster-management` | `false` | GA | v2.5.0 | +| `rke2` | `true` | Experimental | v2.6.0 | +| `token-hashing` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | +| `unsupported-storage-drivers` | `false` | Experimental | v2.3.0 | From da0f636abadc995b19606df283ea7b6b61a6e6a8 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 Mar 2023 14:47:50 -0400 Subject: [PATCH 07/11] added 2.5 page --- .../installation-references/feature-flags.md | 2 +- .../installation-references/feature-flags.md | 30 ++++++++----------- .../installation-references/feature-flags.md | 2 +- 3 files changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 540798715944..2f68927e9be1 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -12,7 +12,7 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.7. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md) in Rancher v2.5 and later): +The following is a list of feature flags available in Rancher v2.7. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. diff --git a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md index 55296b948396..a51265af5de9 100644 --- a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md +++ b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md @@ -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, and enable legacy features that are being phased out. -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 v2.5. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both discontinued): + - `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" (generally available) are no longer experimental: -| Feature Flag Name | Default Value | Status | Available as of | Rancher Restart Required? | +| 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. \ No newline at end of file +| `dashboard` | `true` | Experimental | v2.4.0 | X | +| `dashboard` | `true` | GA and no longer a feature flag | v2.5.0 | X | +| `fleet` | `true` | GA | v2.5.0 | | +| `proxy` | `false` | Experimental | v2.4.0 | | +| `proxy` | N/A | Discontinued | v2.5.0 | X | diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md index d41237d35627..ebdd953815f8 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -12,7 +12,7 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.6. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md) in Rancher v2.5 and later): +The following is a list of feature flags available in Rancher v2.6. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. From 867ea147dff22c8578b374e7bbed61170d791d08 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 Mar 2023 14:50:18 -0400 Subject: [PATCH 08/11] rm'd pointless column from 2.5 table --- .../installation-references/feature-flags.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md index a51265af5de9..4268f8754515 100644 --- a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md +++ b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md @@ -2,7 +2,7 @@ title: Feature Flags --- -With feature flags, you can try out optional or experimental features, and enable legacy features that are being phased out. +With feature flags, you can try out optional or experimental features. To learn more about feature values and how to enable them, see [Enabling Experimental Features](../../pages-for-subheaders/enable-experimental-features.md). @@ -20,10 +20,10 @@ The following is a list of feature flags available in Rancher v2.5. If you've up The following table shows the availability and default value for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: -| 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 | -| `fleet` | `true` | GA | v2.5.0 | | -| `proxy` | `false` | Experimental | v2.4.0 | | -| `proxy` | N/A | Discontinued | v2.5.0 | X | +| Feature Flag Name | Default Value | Status | Available As Of | +| ----------------- | ------------- | ------ | --------------- | +| `dashboard` | `true` | Experimental | v2.4.0 | +| `dashboard` | `true` | GA and no longer a feature flag | v2.5.0 | +| `fleet` | `true` | GA | v2.5.0 | +| `proxy` | `false` | Experimental | v2.4.0 | +| `proxy` | N/A | Discontinued | v2.5.0 | From d10aa296053ab646bbaaa41bc0828b4cd7c53f3f Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 29 Mar 2023 15:08:17 -0400 Subject: [PATCH 09/11] updated based on suggestions from code review --- .../installation-references/feature-flags.md | 6 +++--- .../installation-references/feature-flags.md | 8 ++++---- .../installation-references/feature-flags.md | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 2f68927e9be1..dd70cc469d24 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -16,7 +16,7 @@ The following is a list of feature flags available in Rancher v2.7. If you've up - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. +- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md) for more information. - `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. @@ -25,13 +25,13 @@ The following is a list of feature flags available in Rancher v2.7. If you've up - `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](../../../reference-guides/about-the-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. -The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: +The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available: | Feature Flag Name | Default Value | Status | Available As Of | | ----------------------------- | ------------- | ------------ | --------------- | | `continuous-delivery` | `true` | GA | v2.6.0 | -| `fleet` | `true` | GA | v2.5.0 | | `fleet` | `true` | Can no longer be disabled | v2.6.0 | +| `fleet` | `true` | GA | v2.5.0 | | `harvester` | `true` | Experimental | v2.6.1 | | `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | | `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 | diff --git a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md index 4268f8754515..704cb0c5a36e 100644 --- a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md +++ b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md @@ -12,18 +12,18 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.5. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both discontinued): +The following is a list of feature flags available in Rancher v2.5. 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`: 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 following table shows the availability and default value for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: +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 | | ----------------- | ------------- | ------ | --------------- | -| `dashboard` | `true` | Experimental | v2.4.0 | | `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` | `false` | Experimental | v2.4.0 | | `proxy` | N/A | Discontinued | v2.5.0 | +| `proxy` | `false` | Experimental | v2.4.0 | diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md index ebdd953815f8..297c43e5282e 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -16,7 +16,7 @@ The following is a list of feature flags available in Rancher v2.6. If you've up - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `harvester`: This feature flag is available starting in v2.6.1. Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md#feature-flag/) for more information. +- `harvester`: This feature flag is available starting in v2.6.1. Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md) for more information. - `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. @@ -24,13 +24,13 @@ The following is a list of feature flags available in Rancher v2.6. If you've up - `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](../../../reference-guides/about-the-api/api-tokens.md#token-hashing) for more information. - `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md). In other words, it enables types for storage providers and provisioners that are not enabled by default. -The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" (generally available) are no longer experimental: +The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available: | Feature Flag Name | Default Value | Status | Available As Of | | ----------------------------- | ------------- | ------------ | --------------- | | `continuous-delivery` | `true` | GA | v2.6.0 | -| `fleet` | `true` | GA | v2.5.0 | | `fleet` | `true` | Can no longer be disabled | v2.6.0 | +| `fleet` | `true` | GA | v2.5.0 | | `harvester` | `true` | Experimental | v2.6.1 | | `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | | `multi-cluster-management` | `false` | GA | v2.5.0 | From 5b9a778645757e151d05c6565cc4509688cd67ae Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 29 Mar 2023 15:12:22 -0400 Subject: [PATCH 10/11] rm'd specific mention of version --- .../installation-references/feature-flags.md | 2 +- .../reference-guides/installation-references/feature-flags.md | 2 +- .../installation-references/feature-flags.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index dd70cc469d24..5409ddb917d3 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -12,7 +12,7 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.7. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): +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` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. diff --git a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md index 704cb0c5a36e..c633d8c65d48 100644 --- a/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md +++ b/versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md @@ -12,7 +12,7 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.5. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard`: +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. diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 297c43e5282e..84172e75ad28 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -12,7 +12,7 @@ Some feature flags require a restart of the Rancher container. Features that req ::: -The following is a list of feature flags available in Rancher v2.6. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): +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` (both [discontinued](../../../../versioned_docs/version-2.5/reference-guides/installation-references/feature-flags.md)): - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. From 29086d2f05a352866bd6dfd02376c33d0a7adb7e Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Thu, 30 Mar 2023 13:11:40 -0400 Subject: [PATCH 11/11] Apply suggestions from code review Co-authored-by: Billy Tat --- .../installation-references/feature-flags.md | 4 ++-- .../installation-references/feature-flags.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 5409ddb917d3..3c8fe0845b45 100644 --- a/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -16,7 +16,7 @@ The following is a list of feature flags available in Rancher. If you've upgrade - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md) for more information. +- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Harvester Integration](../../../integrations-in-rancher/harvester.md) for more information. - `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later. @@ -25,7 +25,7 @@ The following is a list of feature flags available in Rancher. If you've upgrade - `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](../../../reference-guides/about-the-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. -The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available: +The following table shows the availability and default values for some feature flags in Rancher. Features marked "GA" are generally available: | Feature Flag Name | Default Value | Status | Available As Of | | ----------------------------- | ------------- | ------------ | --------------- | diff --git a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md index 84172e75ad28..73e6b80df4cb 100644 --- a/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md +++ b/versioned_docs/version-2.6/getting-started/installation-and-upgrade/installation-references/feature-flags.md @@ -16,7 +16,7 @@ The following is a list of feature flags available in Rancher. If you've upgrade - `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information. - `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Fleet - GitOps at Scale](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. -- `harvester`: This feature flag is available starting in v2.6.1. Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Fleet - GitOps at Scale](../../../integrations-in-rancher/harvester.md) for more information. +- `harvester`: This feature flag is available starting in v2.6.1. Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Harvester Integration](../../../integrations-in-rancher/harvester.md) for more information. - `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features. - `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled. - `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later.