diff --git a/_topic_map.yml b/_topic_map.yml index 69a01160da8b..588eb6020103 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -572,7 +572,10 @@ Topics: - Name: Configuring your cluster to place pods on overcommited nodes File: nodes-cluster-overcommit Distros: openshift-enterprise,openshift-origin - - Name: Disabling features using feature gates + - 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 --- diff --git a/machine_management/deploying-machine-health-checks.adoc b/machine_management/deploying-machine-health-checks.adoc index 95056149d6e8..4c7d740e6336 100644 --- a/machine_management/deploying-machine-health-checks.adoc +++ b/machine_management/deploying-machine-health-checks.adoc @@ -10,6 +10,16 @@ damaged machines in a machine pool. :FeatureName: Machine health checks include::modules/technology-preview.adoc[leveloffset=+1] +.Prerequistes + +* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc[Enable a FeatureGate] +so you can access Technology Preview features. ++ +[NOTE] +==== +Turning on Technology Preview features cannot be undone and prevents upgrades. +==== + include::modules/machine-health-checks-about.adoc[leveloffset=+1] include::modules/machine-health-checks-resource.adoc[leveloffset=+1] diff --git a/modules/feature-gate-features.adoc b/modules/feature-gate-features.adoc new file mode 100644 index 000000000000..2fba2d92a5e3 --- /dev/null +++ b/modules/feature-gate-features.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * nodes/nodes-cluster-disabling-features.adoc +// * nodes/nodes-cluster-enabling-features.adoc + +[id="feature-gate-features_{context}"] += Features that are affected by FeatureGates + +The following features are affected by FeatureGates: + +[options="header"] +|=== +| FeatureGate| Description + +| *CSIBlockVolume* +| Enables external CSI drivers to implement raw block volume support. + +| *ExperimentalCriticalPodAnnotation* +| Enables annotating specific pods as critical so that their scheduling is guaranteed. + +| *MachineHealthCheck* +| Enables automatically repairing damaged machines in a machine pool + +| *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. + +|=== \ No newline at end of file diff --git a/modules/nodes-cluster-disabling-features-cluster.adoc b/modules/nodes-cluster-disabling-features-cluster.adoc index 8cc3c8a34816..d934b8c45051 100644 --- a/modules/nodes-cluster-disabling-features-cluster.adoc +++ b/modules/nodes-cluster-disabling-features-cluster.adoc @@ -3,85 +3,47 @@ // * nodes/nodes-cluster-disabling-features.adoc [id="nodes-cluster-disabling-features-cluster_{context}"] -= Enabling Technical Preview features using feature gates += Disabling Technology Preview features using FeatureGates -You can turn Technical Preview features on and off for all nodes in the cluster -by editing the Feature Gates Custom Resource, named *cluster*, in the -*openshift-config* project. +If you no longer want to use Technology Preview features, you can disable them. [NOTE] ==== -Turning on Technical Preview features cannot be undone and prevents upgrades. +Turning off Technology Preview features removes the features, but updating +your cluster remains disabled. ==== -The following features are affected by Feature Gates. +.Prerequisites -[options="header"] -|=== -| Feature gate| Description - -| *CSIBlockVolume* -| Enables external CSI drivers to implement raw block volume support. - -| *ExperimentalCriticalPodAnnotation* -| Enables annotating specific pods as critical so that their scheduling is guaranteed. - -| *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. - -|=== +* 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 -To turn on the Technical Preview features for the entire cluster: - -//The steps to create the instance are for Beta only - -. Create the Feature Gates instance: +. Obtain the name of the Custom Resource for the FeatureGate: ++ +---- +$ oc get FeatureGate cluster -n openshift-config +NAME AGE +cluster 18d +---- -.. Switch to the the *Administration* -> *Custom Resource Definitions* page. +. 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 the *Actions Menu* and select *View Instances*. +.. On the *Custom Resource Definitions* page, click *Actions* and +select *View Instances*. -.. On the *Feature Gates* page, click *Create Feature Gates*. +.. Click the name of the CR for the FeatureGate. -.. Replace the code with following: -+ -[source,yaml] ----- -apiVersion: config.openshift.io/v1 -kind: FeatureGate -metadata: - name: cluster -spec: {} ----- - -.. Click *Create*. - -. To turn on the Technical Preview features, change the `spec` parameter to: -+ ----- -apiVersion: config.openshift.io/v1 -kind: FeatureGate -metadata: - name: cluster -spec: - featureSet: TechPreviewNoUpgrade <1> ----- -+ -<1> Add `featureSet: TechPreviewNoUpgrade` to enable the `CSIBlockVolume`, `ExperimentalCriticalPodAnnotation`, `RotateKubeletServerCertificate`, and `SupportPodPidsLimit` features. -+ -[NOTE] -==== -Turning on Technical Preview features cannot be undone and prevents upgrades. -==== +.. On the *FeatureGate Overview* page, click *Actions* and +select *Edit Feature Gate*. -. To turn off the Technical Preview features, change the `spec` parameter to: +.. To turn off the Technology Preview features, modify the `spec` parameter: + ---- apiVersion: config.openshift.io/v1 @@ -91,18 +53,5 @@ metadata: spec: {} <1> ---- + -<1> Replace `featureSet: TechPreviewNoUpgrade` with `{}` to disable the `ExperimentalCriticalPodAnnotation`, `RotateKubeletServerCertificate`, and `SupportPodPidsLimit` features. -+ -[NOTE] -==== -Turning off Technical Preview features removes the features but upgrading of your cluster remains disabled. -==== - -After creating the CR, use the following command to get the name of the CR for editing as needed: - ----- -$ oc get FeatureGate cluster -n openshift-config -NAME AGE -cluster 18d ----- - +<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 new file mode 100644 index 000000000000..1b1756ba6b7b --- /dev/null +++ b/modules/nodes-cluster-enabling-features-cluster.adoc @@ -0,0 +1,63 @@ +// Module included in the following assemblies: +// +// * nodes/nodes-cluster-disabling-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. + +[NOTE] +==== +Turning on Technology Preview features cannot be undone and prevents upgrades. +==== + +.Procedure + +To turn on the Technology Preview features for the entire cluster: + +//The steps to create the instance are for Beta only + +. Create the FeatureGates instance: + +.. Switch to the the *Administration* -> *Custom Resource Definitions* page. + +.. On the *Custom Resource Definitions* page, click *FeatureGate*. + +.. On the *Custom Resource Definitions* page, click the *Actions Menu* and select *View Instances*. + +.. On the *Feature Gates* page, click *Create Feature Gates*. + +.. Replace the code with following sample: ++ +[source,yaml] +---- +apiVersion: config.openshift.io/v1 +kind: FeatureGate +metadata: + name: cluster +spec: {} +---- + +.. Click *Create*. + +. To turn on the Technology Preview features, change the `spec` parameter to: ++ +---- +apiVersion: config.openshift.io/v1 +kind: FeatureGate +metadata: + name: cluster +spec: + featureSet: TechPreviewNoUpgrade <1> +---- ++ +<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-disabling-features-about.adoc b/modules/nodes-cluster-features-about.adoc similarity index 64% rename from modules/nodes-cluster-disabling-features-about.adoc rename to modules/nodes-cluster-features-about.adoc index 4ded740c4a91..f34822022501 100644 --- a/modules/nodes-cluster-disabling-features-about.adoc +++ b/modules/nodes-cluster-features-about.adoc @@ -2,12 +2,12 @@ // // * nodes/nodes-cluster-disabling-features.adoc -[id="nodes-pods-cluster-features-about_{context}"] -= Understanding how to disable features +[id="nodes-cluster-features-about_{context}"] += Understanding FeatureGates and Technology Preview features -You can use the Feature Gates Custom Resource to toggle on and off Technical Preview features throughout your cluster. +You can use the FeatureGates Custom Resource to toggle on and off Technology 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 +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. //// diff --git a/nodes/clusters/nodes-cluster-disabling-features.adoc b/nodes/clusters/nodes-cluster-disabling-features.adoc index 8436b2be8613..bf3a8dcb7bb0 100644 --- a/nodes/clusters/nodes-cluster-disabling-features.adoc +++ b/nodes/clusters/nodes-cluster-disabling-features.adoc @@ -1,24 +1,33 @@ :context: nodes-cluster-disabling [id="nodes-cluster-disabling"] -= Disabling {product-title} features using feature gates += 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. - - - -As an administrator, you can turn on and off features that are Technical 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. -include::modules/nodes-cluster-disabling-features-about.adoc[leveloffset=+1] +.Prerequisites + +* You xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc[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 new file mode 100644 index 000000000000..f91e11f6798b --- /dev/null +++ b/nodes/clusters/nodes-cluster-enabling-features.adoc @@ -0,0 +1,18 @@ +:context: nodes-cluster-enabling +[id="nodes-cluster-enabling"] += Enabling {product-title} features using FeatureGates +include::modules/common-attributes.adoc[] + +toc::[] + +As an administrator, you can turn on features that are Technology Preview features. + + +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] +