Skip to content
Merged
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
2 changes: 1 addition & 1 deletion _topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ Topics:
- Name: Configuring your cluster to place pods on overcommited nodes
File: nodes-cluster-overcommit
- Name: Disabling features using feature gates
File: nodes-pods-disabling-features
File: nodes-cluster-disabling-features
---
Name: Logging
Dir: logging
Expand Down
25 changes: 25 additions & 0 deletions modules/nodes-cluster-disabling-features-about.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * nodes/nodes-cluster-disabling-features.adoc

[id="nodes-pods-cluster-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.
====
////
105 changes: 105 additions & 0 deletions modules/nodes-cluster-disabling-features-cluster.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
// Module included in the following assemblies:
//
// * nodes/nodes-cluster-disabling-features.adoc

[id="nodes-cluster-disabling-features-cluster-{context}"]
= Enabling Technical Preview features using feature gates

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.

[NOTE]
====
Turning on Technical Preview features cannot be undone and prevents upgrades.
====

The following features are affected by Feature Gates.

[options="header"]
|===
| Feature gate| Description

| *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.

|===

.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:

.. 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:
+
[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 `ExperimentalCriticalPodAnnotation`, `RotateKubeletServerCertificate`, and `SupportPodPidsLimit` features.
+
[NOTE]
====
Turning on Technical Preview features cannot be undone and prevents upgrades.
====

. To turn off the Technical Preview features, change the `spec` parameter to:
+
----
apiVersion: config.openshift.io/v1
kind: FeatureGate
metadata:
name: cluster
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
----

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// * nodes/nodes-pods-disabling-features.adoc
// * nodes/nodes-cluster-disabling-features.adoc

[id="nodes-pods-disabling-features-list-{context}"]
[id="nodes-cluster-disabling-features-list-{context}"]
= List of feature gates

Use the following list to determine the name of the feature you want to disable:
Expand Down
11 changes: 7 additions & 4 deletions modules/nodes-pods-disabling-features-about.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
// Module included in the following assemblies:
//
// * nodes/nodes-pods-disabling-features.adoc
// * nodes/nodes-cluster-disabling-features.adoc

[id="nodes-pods-disabling-features-about-{context}"]
[id="nodes-cluster-disabling-features-about-{context}"]
= Understanding how to disable features

As an administrator, you can turn off new features for production clusters while leaving the features on for test clusters where you can
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.

Expand All @@ -19,4 +22,4 @@ displays an error.
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.
====

////
37 changes: 0 additions & 37 deletions modules/nodes-pods-disabling-features-cluster.adoc

This file was deleted.

24 changes: 24 additions & 0 deletions nodes/clusters/nodes-cluster-disabling-features.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:context: nodes-cluster-disabling
[id="nodes-cluster-disabling"]
= Disabling {product-title} features using feature gates
include::modules/common-attributes.adoc[]

toc::[]





As an administrator, you can turn on and off features that are Technical Preview features.

// 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]

include::modules/nodes-cluster-disabling-features-cluster.adoc[leveloffset=+1]

// modules/nodes-cluster-disabling-features-list.adoc[leveloffset=+1]

24 changes: 0 additions & 24 deletions nodes/clusters/nodes-pods-disabling-features.adoc

This file was deleted.