Skip to content

Commit d146cbf

Browse files
mburke5678mburke5678
committed
updating feature gates in master to match branches
1 parent e08528e commit d146cbf

8 files changed

+155
-140
lines changed

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
//
3+
// nodes/cluster/nodes-cluster-enabling-features.adoc
4+
5+
[id="nodes-cluster-enabling-features-about_{context}"]
6+
= Understanding feature gates
7+
8+
You can use the `FeatureGate` custom resource (CR) to enable specific feature sets in your cluster. A feature set is a collection of {product-title} features that are not enabled by default.
9+
10+
For example, the `TechPreviewNoUpgrade` feature set allows you to enable a subset of the current Technology Preview features on test clusters, where you can fully test them, while leaving the features disabled on production clusters.
11+
12+
You can activate any of the following feature sets by using the `FeatureGate` CR:
13+
14+
[options="header"]
15+
|===
16+
| Feature Set| Description
17+
18+
|`IPv6DualStackNoUpgrade`
19+
|Enables the dual-stack networking mode in your cluster. Dual-stack networking supports the use of IPv4 and IPv6 simultaneously. Enabling this feature set is _not supported_, cannot be undone, and prevents upgrades. This feature set is not recommended on production clusters.
20+
21+
|`TechPreviewNoUpgrade`
22+
a|Enables Technology Preview features that are not part of the default features. Enabling this feature set cannot be undone and prevents upgrades. This feature set is not recommended on production clusters.
23+
24+
The following Technology Preview features are enabled by this feature set:
25+
26+
* link:https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/#certificate-rotation[RotateKubeletServerCertificate]. Enables the rotation of the server TLS certificate on the kubelet.
27+
* link:https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits[Pod PID limits (SupportPodPidsLimit)]. Enables limiting process IDs (PIDs) in pods.
28+
29+
|===
30+
31+
////
32+
Do not document per Derek Carr: https://github.com/openshift/api/pull/370#issuecomment-510632939
33+
|`CustomNoUpgrade` ^[2]^
34+
|Allows the enabling or disabling of any feature. Turning on this feature set on is not supported, cannot be undone, and prevents upgrades.
35+
36+
[.small]
37+
--
38+
1.
39+
2. If you use the `CustomNoUpgrade` feature set to disable a feature that appears in the web console, you might see that feature, but
40+
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.
41+
42+
[NOTE]
43+
====
44+
If you disable a feature that any application in the cluster relies on, the application might not
45+
function properly, depending upon the feature disabled and how the application uses that feature.
46+
====
47+
////

‎modules/nodes-cluster-enabling-features-cli.adoc‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/cluster/nodes-cluster-enabling-features.adoc
4+
5+
[id="nodes-cluster-enabling-features-cli_{context}"]
6+
= Enabling feature sets using the CLI
7+
8+
You can use the OpenShift CLI (`oc`) to enable feature sets for all of the nodes in a cluster by editing the `FeatureGate` custom resource (CR).
9+
10+
.Prerequisites
11+
12+
* You have installed the OpenShift CLI (`oc`).
13+
14+
.Procedure
15+
16+
To enable feature sets:
17+
18+
. Edit the `FeatureGate` CR, named `cluster`, in the `openshift-config` project:
19+
+
20+
[source,terminal]
21+
----
22+
$ oc edit featuregate cluster -n openshift-config
23+
----
24+
+
25+
.Sample FeatureGate custom resource
26+
[source,yaml]
27+
----
28+
apiVersion: config.openshift.io/v1
29+
kind: FeatureGate
30+
metadata:
31+
name: cluster <1>
32+
...
33+
spec:
34+
featureSet: TechPreviewNoUpgrade <2>
35+
----
36+
+
37+
--
38+
<1> The name of the `FeatureGate` CR must be `cluster`.
39+
<2> Add the feature sets that you want to enable in a comma-separated list:
40+
* `IPv6DualStackNoUpgrade` enables the dual-stack networking mode.
41+
* `TechPreviewNoUpgrade` enables specific Technology Preview features.
42+
--
43+
+
44+
[NOTE]
45+
====
46+
Enabling the `TechPreviewNoUpgrade` or `IPv6DualStackNoUpgrade` feature sets cannot be undone and prevents upgrades. These feature sets are not recommended on production clusters.
47+
====

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

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

‎modules/nodes-cluster-enabling-features-console.adoc‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/cluster/nodes-cluster-enabling-features.adoc
4+
5+
[id="nodes-cluster-enabling-features-console_{context}"]
6+
= Enabling feature sets using the web console
7+
8+
You can use the {product-title} web console to enable feature sets for all of the nodes in a cluster by editing the `FeatureGate` custom resource (CR).
9+
10+
.Procedure
11+
12+
To enable feature sets:
13+
14+
. In the {product-title} web console, switch to the *Administration* -> *Custom Resource Definitions* page.
15+
16+
. On the *Custom Resource Definitions* page, click *FeatureGate*.
17+
18+
. On the *Custom Resource Definition Details* page, click the *Instances* tab.
19+
20+
. Click the *cluster* feature gate, then click the *YAML* tab.
21+
22+
. Edit the *cluster* instance to add specific feature sets:
23+
+
24+
.Sample Feature Gate custom resource
25+
[source,yaml]
26+
----
27+
apiVersion: config.openshift.io/v1
28+
kind: FeatureGate
29+
metadata:
30+
name: cluster <1>
31+
....
32+
33+
spec:
34+
featureSet: TechPreviewNoUpgrade <2>
35+
----
36+
+
37+
--
38+
<1> The name of the `FeatureGate` CR must be `cluster`.
39+
<2> Add the feature sets that you want to enable in a comma-separated list:
40+
* `IPv6DualStackNoUpgrade` enables the dual-stack networking mode.
41+
* `TechPreviewNoUpgrade` enables specific Technology Preview features.
42+
--
43+
+
44+
[NOTE]
45+
====
46+
Enabling the `TechPreviewNoUpgrade` or `IPv6DualStackNoUpgrade` feature sets cannot be undone and prevents upgrades. These feature sets are not recommended on production clusters.
47+
====

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

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

‎modules/setting-up-topology-manager.adoc‎

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="seting_up_topology_manager_{context}"]
77
= Setting up Topology Manager
88

9-
To use Topology Manager, you must enable the `LatencySensitive` Feature Gate and configure the Topology Manager policy in the `cpumanager-enabled` custom resource (CR). This file might exist if you have set up CPU Manager. If the file does not exist, you can create the file.
9+
To use Topology Manager, you must configure an allocation policy in the `cpumanager-enabled` custom resource (CR). This file might exist if you have set up CPU Manager. If the file does not exist, you can create the file.
1010

1111
.Prequisites
1212

@@ -16,53 +16,7 @@ To use Topology Manager, you must enable the `LatencySensitive` Feature Gate and
1616

1717
To activate Topololgy Manager:
1818

19-
. Edit the `FeatureGate` object to add the `LatencySensitive` feature set:
20-
+
21-
[source,terminal]
22-
----
23-
$ oc edit featuregate/cluster
24-
----
25-
+
26-
[source,yaml]
27-
----
28-
apiVersion: config.openshift.io/v1
29-
kind: FeatureGate
30-
metadata:
31-
annotations:
32-
release.openshift.io/create-only: "true"
33-
creationTimestamp: 2020-06-05T14:41:09Z
34-
generation: 2
35-
managedFields:
36-
- apiVersion: config.openshift.io/v1
37-
fieldsType: FieldsV1
38-
fieldsV1:
39-
f:metadata:
40-
f:annotations:
41-
.: {}
42-
f:release.openshift.io/create-only: {}
43-
f:spec: {}
44-
manager: cluster-version-operator
45-
operation: Update
46-
time: 2020-06-05T14:41:09Z
47-
- apiVersion: config.openshift.io/v1
48-
fieldsType: FieldsV1
49-
fieldsV1:
50-
f:spec:
51-
f:featureSet: {}
52-
manager: oc
53-
operation: Update
54-
time: 2020-06-05T15:21:44Z
55-
name: cluster
56-
resourceVersion: "28457"
57-
selfLink: /apis/config.openshift.io/v1/featuregates/cluster
58-
uid: e802e840-89ee-4137-a7e5-ca15fd2806f8
59-
spec:
60-
featureSet: LatencySensitive <1>
61-
...
62-
----
63-
<1> Add the `LatencySensitive` feature set in a comma-separated list.
64-
65-
. Configure the Topology Manager policy in the `cpumanager-enabled` custom resource (CR).
19+
. Configure the Topology Manager allocation policy in the `cpumanager-enabled` custom resource (CR).
6620
+
6721
[source,terminal]
6822
----
@@ -85,5 +39,5 @@ spec:
8539
topologyManagerPolicy: single-numa-node <2>
8640
----
8741
<1> This parameter must be `static`.
88-
<2> Specify your selected Topology Manager policy. Here, the policy is `single-numa-node`.
42+
<2> Specify your selected Topology Manager allocation policy. Here, the policy is `single-numa-node`.
8943
Acceptable values are: `default`, `best-effort`, `restricted`, `single-numa-node`.

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
As an administrator, you can turn on features that are in Technology Preview
9-
status.
8+
As an administrator, you can use feature gates to enable features that are not part of the default set of features.
109

11-
include::modules/nodes-cluster-features-about.adoc[leveloffset=+1]
10+
include::modules/nodes-cluster-enabling-features-about.adoc[leveloffset=+1]
1211

13-
include::modules/feature-gate-features.adoc[leveloffset=+1]
12+
include::modules/nodes-cluster-enabling-features-console.adoc[leveloffset=+1]
1413

15-
include::modules/nodes-cluster-enabling-features-cluster.adoc[leveloffset=+1]
14+
include::modules/nodes-cluster-enabling-features-cli.adoc[leveloffset=+1]

‎post_installation_configuration/cluster-tasks.adoc‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,13 @@ include::modules/machine-autoscaler-cr.adoc[leveloffset=+2]
9292
:FeatureName: MachineAutoscaler
9393
include::modules/deploying-resource.adoc[leveloffset=+2]
9494

95-
include::modules/nodes-cluster-enabling-features-cluster.adoc[leveloffset=+1]
95+
[id="post-install-tp-tasks"]
96+
== Enabling Technology Preview features using FeatureGates
97+
98+
You can turn on a subset of the current Technology Preview features on for all nodes in the cluster by editing the `FeatureGate` custom resource (CR).
99+
100+
include::modules/nodes-cluster-enabling-features-about.adoc[leveloffset=+2]
101+
include::modules/nodes-cluster-enabling-features-cli.adoc[leveloffset=+2]
96102

97103
[id="post-install-etcd-tasks"]
98104
== etcd tasks

0 commit comments

Comments
 (0)