Skip to content

Commit 93532f7

Browse files
committed
OSDOCS-4365: Added ability to enable a feature set during install
1 parent 4e7aa69 commit 93532f7

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed

modules/installation-configuration-parameters.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,10 @@ accounts for the dramatically decreased machine performance.
538538
|The number of compute machines, which are also known as worker machines, to provision.
539539
|A positive integer greater than or equal to `2`. The default value is `3`.
540540

541+
|`featureSet`
542+
|Enables the cluster for a feature set. A feature set is a collection of {product-title} features that are not enabled by default. For more information about enabling a feature set during installation, see "Enabling features using feature gates".
543+
|String. The name of the feature set to enable, such as `TechPreviewNoUpgrade`.
544+
541545
|`controlPlane`
542546
|The configuration for the machines that comprise the control plane.
543547
|Array of `MachinePool` objects.
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/cluster/nodes-cluster-enabling-features.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="nodes-cluster-enabling-features-install_{context}"]
7+
= Enabling feature sets at installation
8+
9+
You can enable feature sets for all nodes in the cluster by editing the `install-config.yaml` file before you deploy the cluster.
10+
11+
.Prerequisites
12+
13+
* You have an `install-config.yaml` file.
14+
15+
.Procedure
16+
17+
. Use the `featureSet` parameter to specify the name of the feature set you want to enable, such as `TechPreviewNoUpgrade`:
18+
+
19+
.Sample `install-config.yaml` file with an enabled feature set
20+
21+
[source,yaml]
22+
----
23+
compute:
24+
- hyperthreading: Enabled
25+
name: worker
26+
platform:
27+
aws:
28+
rootVolume:
29+
iops: 2000
30+
size: 500
31+
type: io1
32+
metadataService:
33+
authentication: Optional
34+
type: c5.4xlarge
35+
zones:
36+
- us-west-2c
37+
replicas: 3
38+
featureSet: TechPreviewNoUpgrade
39+
----
40+
41+
. Save the file and reference it when using the installation program to deploy the cluster.
42+
43+
[NOTE]
44+
====
45+
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
46+
====
47+
48+
.Verification
49+
50+
You can verify that the feature gates are enabled by looking at the `kubelet.conf` file on a node after the cluster is installed.
51+
52+
. Start a debug session for a node:
53+
+
54+
[source,terminal]
55+
----
56+
$ oc debug node/<node_name>
57+
----
58+
59+
. Change your root directory to the host:
60+
+
61+
[source,terminal]
62+
----
63+
sh-4.2# chroot /host
64+
----
65+
66+
. View the `kubelet.conf` file:
67+
+
68+
[source,terminal]
69+
----
70+
sh-4.2# cat /etc/kubernetes/kubelet.conf
71+
----
72+
+
73+
.Sample output
74+
+
75+
[source,terminal]
76+
----
77+
...
78+
featureGates:
79+
TechPreviewNoUpgrade: true,
80+
LegacyNodeRoleBehavior: false
81+
...
82+
----
83+
+
84+
The features that are listed as `true` are enabled on your cluster.
85+
+
86+
[NOTE]
87+
====
88+
The features listed vary depending upon the {product-title} version.
89+
====

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ include::modules/nodes-cluster-enabling-features-about.adoc[leveloffset=+1]
1818
** xref:../../cicd/builds/build-strategies.adoc#builds-using-build-volumes_build-strategies-s2i[Source-to-image (S2I) build volumes] and xref:../../cicd/builds/build-strategies.adoc#builds-using-build-volumes_build-strategies-docker[Docker build volumes]
1919
** xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-swap-memory_nodes-nodes-working[Swap memory on nodes]
2020
21+
include::modules/nodes-cluster-enabling-features-install.adoc[leveloffset=+1]
22+
2123
include::modules/nodes-cluster-enabling-features-console.adoc[leveloffset=+1]
2224

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

0 commit comments

Comments
 (0)