1. Documentation
×

Enabling features using feature gates

As an administrator, you can use feature gates to enable features that are not part of the default set of features.

Understanding feature gates

You can use the FeatureGate custom resource (CR) to enable specific feature sets in your cluster. A feature set is a collection of OKD features that are not enabled by default.

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.

You can activate any of the following feature sets by using the FeatureGate CR:

Feature Set Description

TechPreviewNoUpgrade

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.

The following Technology Preview features are enabled by this feature set:

Enabling feature sets using the web console

You can use the OKD web console to enable feature sets for all of the nodes in a cluster by editing the FeatureGate custom resource (CR).

Procedure

To enable feature sets:

  1. In the OKD web console, switch to the Administration → Custom Resource Definitions page.

  2. On the Custom Resource Definitions page, click FeatureGate.

  3. On the Custom Resource Definition Details page, click the Instances tab.

  4. Click the cluster feature gate, then click the YAML tab.

  5. Edit the cluster instance to add specific feature sets:

    Sample Feature Gate custom resource
    apiVersion: config.openshift.io/v1
kind: FeatureGate
metadata:
  name: cluster (1)
....

spec:
  featureSet: TechPreviewNoUpgrade (2)
    1 The name of the FeatureGate CR must be cluster.
    2 Add the feature sets that you want to enable in a comma-separated list:

    • TechPreviewNoUpgrade enables specific Technology Preview features.

    Enabling the TechPreviewNoUpgrade feature set cannot be undone and prevents upgrades. These feature sets are not recommended on production clusters.

Enabling feature sets using the CLI

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

Prerequisites

  • You have installed the OpenShift CLI (oc).

Procedure

To enable feature sets:

  1. Edit the FeatureGate CR named cluster:

    $ oc edit featuregate cluster
    Sample FeatureGate custom resource
    apiVersion: config.openshift.io/v1
kind: FeatureGate
metadata:
  name: cluster (1)
spec:
  featureSet: TechPreviewNoUpgrade (2)
    1 The name of the FeatureGate CR must be cluster.
    2 Add the feature sets that you want to enable in a comma-separated list:

    • TechPreviewNoUpgrade enables specific Technology Preview features.

    Enabling the TechPreviewNoUpgrade feature set cannot be undone and prevents upgrades. These feature sets are not recommended on production clusters.