diff --git a/_topic_map.yml b/_topic_map.yml index c02171560559..bc2e03f79c6a 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -607,9 +607,6 @@ Topics: - Name: Enabling features using FeatureGates File: nodes-cluster-enabling-features Distros: openshift-enterprise,openshift-origin - - Name: Disabling features using FeatureGates - File: nodes-cluster-disabling-features - Distros: openshift-enterprise,openshift-origin --- Name: Logging Dir: logging diff --git a/modules/feature-gate-features.adoc b/modules/feature-gate-features.adoc index 2fba2d92a5e3..0bacb33be53d 100644 --- a/modules/feature-gate-features.adoc +++ b/modules/feature-gate-features.adoc @@ -1,6 +1,5 @@ // Module included in the following assemblies: // -// * nodes/nodes-cluster-disabling-features.adoc // * nodes/nodes-cluster-enabling-features.adoc [id="feature-gate-features_{context}"] @@ -12,19 +11,19 @@ The following features are affected by FeatureGates: |=== | FeatureGate| Description -| *CSIBlockVolume* -| Enables external CSI drivers to implement raw block volume support. +|`CSIBlockVolume` +|Enables external CSI drivers to implement raw block volume support. -| *ExperimentalCriticalPodAnnotation* -| Enables annotating specific pods as critical so that their scheduling is guaranteed. +|`ExperimentalCriticalPodAnnotation` +|Enables annotating specific Pods as critical so that their scheduling is guaranteed. -| *MachineHealthCheck* -| Enables automatically repairing damaged machines in a machine pool +|`MachineHealthCheck` +|Enables automatically repairing damaged machines in a machine pool. -| *RotateKubeletServerCertificate* -| Enables the rotation of the server TLS certificate on the cluster. +|`RotateKubeletServerCertificate` +|Enables the rotation of the server TLS certificate on the cluster. -| *SupportPodPidsLimit* -| Enables support for limiting the number of processes (PIDs) running in a pod. +|`SupportPodPidsLimit` +|Enables support for limiting the number of processes (PIDs) running in a Pod. -|=== \ No newline at end of file +|=== diff --git a/modules/nodes-cluster-disabling-features-cluster.adoc b/modules/nodes-cluster-disabling-features-cluster.adoc deleted file mode 100644 index d934b8c45051..000000000000 --- a/modules/nodes-cluster-disabling-features-cluster.adoc +++ /dev/null @@ -1,57 +0,0 @@ -// Module included in the following assemblies: -// -// * nodes/nodes-cluster-disabling-features.adoc - -[id="nodes-cluster-disabling-features-cluster_{context}"] -= Disabling Technology Preview features using FeatureGates - -If you no longer want to use Technology Preview features, you can disable them. - -[NOTE] -==== -Turning off Technology Preview features removes the features, but updating -your cluster remains disabled. -==== - -.Prerequisites - -* You added a FeatureGate and enabled Technology Preview features. -* Install the OpenShift Command-line Interface (CLI), commonly known as `oc`. -* You must log in to the cluster with a user that has the `cluster-admin` role. - -.Procedure - -. Obtain the name of the Custom Resource for the FeatureGate: -+ ----- -$ oc get FeatureGate cluster -n openshift-config -NAME AGE -cluster 18d ----- - -. Edit the FeatureGate: -.. From the web console, switch to the the -*Administration* -> *Custom Resource Definitions* page. - -.. On the *Custom Resource Definitions* page, click *FeatureGate*. - -.. On the *Custom Resource Definitions* page, click *Actions* and -select *View Instances*. - -.. Click the name of the CR for the FeatureGate. - -.. On the *FeatureGate Overview* page, click *Actions* and -select *Edit Feature Gate*. - -.. To turn off the Technology Preview features, modify the `spec` parameter: -+ ----- -apiVersion: config.openshift.io/v1 -kind: FeatureGate -metadata: - name: cluster -spec: {} <1> ----- -+ -<1> Set the `spec` value to `{}` to disable the Technology Preview features that -prevent you from updating a cluster. \ No newline at end of file diff --git a/modules/nodes-cluster-enabling-features-cluster.adoc b/modules/nodes-cluster-enabling-features-cluster.adoc index 1b1756ba6b7b..2bd13006aa41 100644 --- a/modules/nodes-cluster-enabling-features-cluster.adoc +++ b/modules/nodes-cluster-enabling-features-cluster.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * nodes/nodes-cluster-disabling-features.adoc +// * nodes/nodes-cluster-enabling-features.adoc [id="nodes-cluster-enabling-features-cluster_{context}"] = Enabling Technology Preview features using FeatureGates -You can turn Technology Preview features on and off for all nodes in the cluster -by editing the FeatureGates Custom Resource, named *cluster*, in the -*openshift-config* project. +You can turn Technology Preview features on for all nodes in the cluster by +editing the FeatureGates Custom Resource, named `cluster`, in the +`openshift-config` project. -[NOTE] +[IMPORTANT] ==== Turning on Technology Preview features cannot be undone and prevents upgrades. ==== @@ -56,8 +56,3 @@ spec: + <1> Add `featureSet: TechPreviewNoUpgrade` to enable the Technology Preview features that are affected by FeatureGates. -+ -[NOTE] -==== -Turning on Technology Preview features cannot be undone and prevents upgrades. -==== \ No newline at end of file diff --git a/modules/nodes-cluster-features-about.adoc b/modules/nodes-cluster-features-about.adoc index f34822022501..0dbc8c986b20 100644 --- a/modules/nodes-cluster-features-about.adoc +++ b/modules/nodes-cluster-features-about.adoc @@ -1,14 +1,26 @@ // Module included in the following assemblies: // -// * nodes/nodes-cluster-disabling-features.adoc +// * nodes/nodes-cluster-enabling-features.adoc [id="nodes-cluster-features-about_{context}"] = Understanding FeatureGates and Technology Preview features -You can use the FeatureGates Custom Resource to toggle on and off Technology Preview features throughout your cluster. +You can use the FeatureGates Custom Resource to enable Technology Preview +features throughout your cluster. This allows you, for example, to enable +Technology Preview features on test clusters where you can fully test them while +ensuring they are disabled on production clusters. + +[IMPORTANT] +==== +After turning Technology Preview features on using FeatureGates, they cannot be +turned off and cluster upgrades are prevented. + +ifndef::openshift-origin[] +For more information about the support scope of Red Hat Technology Preview features, +see link:https://access.redhat.com/support/offerings/techpreview/[]. +endif::[] +==== -This allows you, for example, to ensure that Technology Preview features are off for production clusters while leaving the features on for test clusters where you can -fully test them. //// If you disable a feature that appears in the web console, you might see that feature, but diff --git a/modules/nodes-pods-disabling-features-about.adoc b/modules/nodes-pods-disabling-features-about.adoc deleted file mode 100644 index 19973dcf97e3..000000000000 --- a/modules/nodes-pods-disabling-features-about.adoc +++ /dev/null @@ -1,25 +0,0 @@ -// Module included in the following assemblies: -// -// * nodes/nodes-cluster-disabling-features.adoc - -[id="nodes-cluster-disabling-features-about_{context}"] -= Understanding how to disable features - -You can use the Feature Gates Custom Resource to toggle on and off Technical Preview features throughout your cluster. - -This allows you, for example, to ensure that Technical Preview features are off for production clusters while leaving the features on for test clusters where you can -fully test them. - -//// -If you disable a feature that appears in the web console, you might see that feature, but -no objects are listed. For example, if you disable builds, you can see the *Builds* tab in the web console, but there are no builds present. - -If you attempt to use commands associated with a disabled feature, such as `oc start-build`, {product-title} -displays an error. - -[NOTE] -==== -If you disable a feature that any application in the cluster relies on, the application might not -function properly, depending upon the feature disabled and how the application uses that feature. -==== -//// diff --git a/nodes/clusters/nodes-cluster-disabling-features.adoc b/nodes/clusters/nodes-cluster-disabling-features.adoc deleted file mode 100644 index 36f0afd65f9c..000000000000 --- a/nodes/clusters/nodes-cluster-disabling-features.adoc +++ /dev/null @@ -1,32 +0,0 @@ -:context: nodes-cluster-disabling -[id="nodes-cluster-disabling"] -= Disabling {product-title} features using FeatureGates -include::modules/common-attributes.adoc[] - -toc::[] - -As an administrator, you can turn off features that are Technology Preview features. - -[IMPORTANT] -==== -Even if you disable Technology Preview features, you still cannot update your -cluster. -==== - -// The following include statements pull in the module files that comprise -// the assembly. Include any combination of concept, procedure, or reference -// modules required to cover the user story. You can also include other -// assemblies. - -.Prerequisites - -* You xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features-cluster_nodes-cluster-enabling[enabled a FeatureGate] -to access Technology Preview features. - -include::modules/nodes-cluster-features-about.adoc[leveloffset=+1] - -include::modules/nodes-cluster-disabling-features-cluster.adoc[leveloffset=+1] - -include::modules/feature-gate-features.adoc[leveloffset=+1] - -// modules/nodes-cluster-disabling-features-list.adoc[leveloffset=+1] diff --git a/nodes/clusters/nodes-cluster-enabling-features.adoc b/nodes/clusters/nodes-cluster-enabling-features.adoc index f91e11f6798b..237fa213d815 100644 --- a/nodes/clusters/nodes-cluster-enabling-features.adoc +++ b/nodes/clusters/nodes-cluster-enabling-features.adoc @@ -5,14 +5,11 @@ include::modules/common-attributes.adoc[] toc::[] -As an administrator, you can turn on features that are Technology Preview features. - +As an administrator, you can turn on features that are in Technology Preview +status. include::modules/nodes-cluster-features-about.adoc[leveloffset=+1] include::modules/feature-gate-features.adoc[leveloffset=+1] include::modules/nodes-cluster-enabling-features-cluster.adoc[leveloffset=+1] - -// modules/nodes-cluster-disabling-features-list.adoc[leveloffset=+1] -