Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions configuration/managing-preview-features.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,37 @@
:_mod-docs-content-type: ASSEMBLY
[id="managing-preview-features"]
= Managing technology preview features
= Managing Technology Preview features
include::modules/common-attributes.adoc[]
:context: managing-preview-features

toc::[]

[role="_abstract"]

You can enable or disable features that are Technology Preview by using feature flags.

[IMPORTANT]
====
[subs="attributes+"]
Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features give early access to upcoming product features, enabling customers to test functionality and give feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
For more information about the support scope of Red{nbsp}Hat Technology Preview features, see the "Technology Preview Features Support Scope".
====

//Managing feature flags
include::modules/managing-feature-flags.adoc[leveloffset=+1]
include::modules/managing-feature-flags.adoc[leveloffset=+1]

//Prerequisites
include::modules/managing-feature-flags-prerequisites.adoc[leveloffset=+2]

//Managing feature flags procedure
include::modules/managing-feature-flags-procedure.adoc[leveloffset=+2]

//Best practices
include::modules/managing-feature-flags-best-practices.adoc[leveloffset=+2]

//Troubleshooting
include::modules/managing-feature-flags-troubleshooting.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]
14 changes: 14 additions & 0 deletions modules/managing-feature-flags-best-practices.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Module included in the following assemblies:
//
// * configuration/managing-preview-features.adoc

:_mod-docs-content-type: REFERENCE
[id="best-practices_{context}"]
= Best practices

[role="_abstract"]
Best practices for using feature flags to manage Technology Preview features.

* Always test feature changes in a staging environment before applying them to production.
* Keep a record of all feature flags and their current status.
* Prepare to revert the changes if the feature causes issues.
15 changes: 15 additions & 0 deletions modules/managing-feature-flags-prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * configuration/managing-preview-features.adoc

:_mod-docs-content-type: REFERENCE
[id="prerequisites_{context}"]
= Prerequisites

[role="_abstract"]
Requirements for managing feature flags in {product-title-short}.

* You have access to the environment running the {product-title-short} component.
* You have permission to change environment variables.
* You understand that the Technology Preview features might be incomplete and have limited support.
* You know if you must configure the flag for the Technology Preview feature before the deployment. Check the installation manifests to see if they use the required flag.
25 changes: 25 additions & 0 deletions modules/managing-feature-flags-procedure.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * configuration/managing-preview-features.adoc

:_mod-docs-content-type: PROCEDURE
[id="managing-feature-flags-procedure_{context}"]
= Managing feature flags

[role="_abstract"]
You can enable or disable Technology Preview features by modifying environment variables associated with feature flags.

.Procedure

. Identify the environment variable name associated with the feature flag.
Consult the release notes or the `/v1/featureflags` API endpoint to identify the flag for the feature you want to enable or disable.

. Change the feature flag by completing one of the following actions:
* To enable a feature, configure the environment variable associated with the flag by setting its value to `true`. Configure this directly on the Kubernetes deployment or during installation by using the Helm chart or the Operator custom resource (CR).
* To disable a feature, set the environment variable associated with the flag to `false`.

. After you restart or redeploy the application, verify that you enabled or disabled the feature by completing the following steps:

* Check the output of the `/v1/featureflags` API endpoint.
* Check the application functionality related to the feature.
* Review logs or monitoring tools for any errors or confirmation messages.
13 changes: 13 additions & 0 deletions modules/managing-feature-flags-troubleshooting.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Module included in the following assemblies:
//
// * configuration/managing-preview-features.adoc

:_mod-docs-content-type: REFERENCE
[id="troubleshooting_{context}"]
= Troubleshooting

[role="_abstract"]
Troubleshooting guidelines for resolving issues with feature flags.

* If the feature does not appear, ensure that the environment variable is correctly named and set. Check application logs for any errors related to feature flag parsing.
* If enabling a feature causes application errors, disable the feature and contact Red{nbsp}Hat Support.
40 changes: 3 additions & 37 deletions modules/managing-feature-flags.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,9 @@
//
// * configuration/managing-preview-features.adoc

:_mod-docs-content-type: PROCEDURE
:_mod-docs-content-type: CONCEPT
[id="managing-feature-flags_{context}"]
= Managing feature flags

[id="prerequisites_{context}"]
== Prerequisites
* You have access to the environment where the {product-title-short} component is deployed.
* You have permission to modify environment variables.
* You understand that the Technology Preview features might be incomplete and are provided with limited support.
* You know if the flag for the Technology Preview feature needs to be configured before the deployment. Check the installation manifests to see if they use the required flag.

.Procedure

. Identify the environment variable name associated with the feature flag.
Consult the release notes or the `/v1/featureflags` API endpoint to identify the flag for the feature you want to enable or disable.

. Modify the feature flag by completing one of the following actions:
* To enable a feature, configure the environment variable associated with the flag by setting its value to `true`. Configure this directly on the Kubernetes deployment or during installation by using the Helm chart or the Operator custom resource (CR).
* To disable a feature, set the environment variable associated with the flag to `false`.

. After the application is restarted or redeployed, verify that the feature has been enabled or disabled by completing the following steps:

* Check the output of the `/v1/featureflags` API endpoint.
* Check the application functionality related to the feature.
* Review logs or monitoring tools for any errors or confirmation messages.

[id="best-practices_{context}"]
== Best practices
Follow these best practices for using the feature flag:

* Always test feature changes in a staging environment before applying them to production.
* Keep a record of all feature flags and their current status.
* Be prepared to revert the changes if the feature causes issues.

[id="troubleshooting_{context}"]
== Troubleshooting
Follow these troubleshooting guidelines:

* If the feature does not appear, ensure that the environment variable is correctly named and set. Check application logs for any errors related to feature flag parsing.
* If enabling a feature causes application errors, disable the feature and contact Red Hat Support.
[role="_abstract"]
You can use feature flags to enable or disable Technology Preview features in {product-title-short}. You control feature flags through environment variables that you configure on the Kubernetes deployment or during installation by using the Helm chart or the Operator custom resource.