Skip to content

Commit eceeaf8

Browse files
mburke5678mburke5678
authored
Merge pull request #14293 from mburke5678/nodes-feature-gates
Update feature gates for 4.0 new design
2 parents 356fddc + 2f88954 commit eceeaf8

8 files changed

+164
-68
lines changed

‎_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ Topics:
470470
- Name: Configuring your cluster to place pods on overcommited nodes
471471
File: nodes-cluster-overcommit
472472
- Name: Disabling features using feature gates
473-
File: nodes-pods-disabling-features
473+
File: nodes-cluster-disabling-features
474474
---
475475
Name: Logging
476476
Dir: logging

‎modules/nodes-cluster-disabling-features-about.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/nodes-cluster-disabling-features.adoc
4+
5+
[id="nodes-pods-cluster-features-about-{context}"]
6+
= Understanding how to disable features
7+
8+
You can use the Feature Gates Custom Resource to toggle on and off Technical Preview features throughout your cluster.
9+
10+
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
11+
fully test them.
12+
13+
////
14+
If you disable a feature that appears in the web console, you might see that feature, but
15+
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.
16+
17+
If you attempt to use commands associated with a disabled feature, such as `oc start-build`, {product-title}
18+
displays an error.
19+
20+
[NOTE]
21+
====
22+
If you disable a feature that any application in the cluster relies on, the application might not
23+
function properly, depending upon the feature disabled and how the application uses that feature.
24+
====
25+
////

‎modules/nodes-cluster-disabling-features-cluster.adoc

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/nodes-cluster-disabling-features.adoc
4+
5+
[id="nodes-cluster-disabling-features-cluster-{context}"]
6+
= Enabling Technical Preview features using feature gates
7+
8+
You can turn Technical Preview features on and off for all nodes in the cluster
9+
by editing the Feature Gates Custom Resource, named *cluster*, in the
10+
*openshift-config* project.
11+
12+
[NOTE]
13+
====
14+
Turning on Technical Preview features cannot be undone and prevents upgrades.
15+
====
16+
17+
The following features are affected by Feature Gates.
18+
19+
[options="header"]
20+
|===
21+
| Feature gate| Description
22+
23+
| *ExperimentalCriticalPodAnnotation*
24+
| Enables annotating specific pods as critical so that their scheduling is guaranteed.
25+
26+
| *RotateKubeletServerCertificate*
27+
| Enables the rotation of the server TLS certificate on the cluster.
28+
29+
| *SupportPodPidsLimit*
30+
| Enables support for limiting the number of processes (PIDs) running in a pod.
31+
32+
|===
33+
34+
.Procedure
35+
36+
To turn on the Technical Preview features for the entire cluster:
37+
38+
//The steps to create the instance are for Beta only
39+
40+
. Create the Feature Gates instance:
41+
42+
.. Switch to the the *Administration* -> *Custom Resource Definitions* page.
43+
44+
.. On the *Custom Resource Definitions* page, click *FeatureGate*.
45+
46+
.. On the *Custom Resource Definitions* page, click the *Actions Menu* and select *View Instances*.
47+
48+
.. On the *Feature Gates* page, click *Create Feature Gates*.
49+
50+
.. Replace the code with following:
51+
+
52+
[source,yaml]
53+
----
54+
apiVersion: config.openshift.io/v1
55+
kind: FeatureGate
56+
metadata:
57+
name: cluster
58+
spec: {}
59+
----
60+
61+
.. Click *Create*.
62+
63+
. To turn on the Technical Preview features, change the `spec` parameter to:
64+
+
65+
----
66+
apiVersion: config.openshift.io/v1
67+
kind: FeatureGate
68+
metadata:
69+
name: cluster
70+
spec:
71+
featureSet: TechPreviewNoUpgrade <1>
72+
----
73+
+
74+
<1> Add `featureSet: TechPreviewNoUpgrade` to enable the `ExperimentalCriticalPodAnnotation`, `RotateKubeletServerCertificate`, and `SupportPodPidsLimit` features.
75+
+
76+
[NOTE]
77+
====
78+
Turning on Technical Preview features cannot be undone and prevents upgrades.
79+
====
80+
81+
. To turn off the Technical Preview features, change the `spec` parameter to:
82+
+
83+
----
84+
apiVersion: config.openshift.io/v1
85+
kind: FeatureGate
86+
metadata:
87+
name: cluster
88+
spec: {} <1>
89+
----
90+
+
91+
<1> Replace `featureSet: TechPreviewNoUpgrade` with `{}` to disable the `ExperimentalCriticalPodAnnotation`, `RotateKubeletServerCertificate`, and `SupportPodPidsLimit` features.
92+
+
93+
[NOTE]
94+
====
95+
Turning off Technical Preview features removes the features but upgrading of your cluster remains disabled.
96+
====
97+
98+
After creating the CR, use the following command to get the name of the CR for editing as needed:
99+
100+
----
101+
$ oc get FeatureGate cluster -n openshift-config
102+
NAME AGE
103+
cluster 18d
104+
----
105+

‎modules/nodes-pods-disabling-features-list.adoc renamed to ‎modules/nodes-cluster-disabling-features-list.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Module included in the following assemblies:
22
//
3-
// * nodes/nodes-pods-disabling-features.adoc
3+
// * nodes/nodes-cluster-disabling-features.adoc
44

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

88
Use the following list to determine the name of the feature you want to disable:

‎modules/nodes-pods-disabling-features-about.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
// Module included in the following assemblies:
22
//
3-
// * nodes/nodes-pods-disabling-features.adoc
3+
// * nodes/nodes-cluster-disabling-features.adoc
44

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

8-
As an administrator, you can turn off new features for production clusters while leaving the features on for test clusters where you can
8+
You can use the Feature Gates Custom Resource to toggle on and off Technical Preview features throughout your cluster.
9+
10+
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
911
fully test them.
1012

13+
////
1114
If you disable a feature that appears in the web console, you might see that feature, but
1215
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.
1316
@@ -19,4 +22,4 @@ displays an error.
1922
If you disable a feature that any application in the cluster relies on, the application might not
2023
function properly, depending upon the feature disabled and how the application uses that feature.
2124
====
22-
25+
////

‎modules/nodes-pods-disabling-features-cluster.adoc

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎nodes/clusters/nodes-cluster-disabling-features.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:context: nodes-cluster-disabling
2+
[id="nodes-cluster-disabling"]
3+
= Disabling {product-title} features using feature gates
4+
include::modules/common-attributes.adoc[]
5+
6+
toc::[]
7+
8+
9+
10+
11+
12+
As an administrator, you can turn on and off features that are Technical Preview features.
13+
14+
// The following include statements pull in the module files that comprise
15+
// the assembly. Include any combination of concept, procedure, or reference
16+
// modules required to cover the user story. You can also include other
17+
// assemblies.
18+
19+
include::modules/nodes-cluster-disabling-features-about.adoc[leveloffset=+1]
20+
21+
include::modules/nodes-cluster-disabling-features-cluster.adoc[leveloffset=+1]
22+
23+
// modules/nodes-cluster-disabling-features-list.adoc[leveloffset=+1]
24+

‎nodes/clusters/nodes-pods-disabling-features.adoc

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)