Skip to content

Commit

Permalink
Docs - clarifying consequences of capabilities override
Browse files Browse the repository at this point in the history
Disabling capabilities could cause problems in some situations, e.g.
disabling the baremetal-operator on a baremetal platform cluster will
cause installation to fail. The docs should be more clear about these
consequences.

```
Mar 06 15:38:49 master1 bootkube.sh[5424]: "99_openshift-cluster-api_master-machines-0.yaml": failed to create machines.v1beta1.machine.openshift.io/minimal-xkgn9-master-0 -n openshift-machine-api: the server could not find the requested resource
```
  • Loading branch information
omertuc committed Mar 12, 2024
1 parent f24b433 commit 6492159
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/user-guide/install-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Since [OpenShift 4.12](https://github.com/openshift/enhancements/blob/master/enh

The features (`baremetal-operator`, `marketplace`, `Console`, `Insights`, `Storage`, `CSISnapshot` and `openshift-samples-content`) can be disabled by setting the `baselineCapabilitySet` and `addittionalEnabledCapabilities` parameters in the `install-config.yaml`.

To perform the customization, spec for capabilities must be adjusted, for example:
Here is an example of disabling all capabilities except openshift-samples:

```yaml
capabilities:
Expand All @@ -165,7 +165,10 @@ capabilities:
- openshift-samples
```

The `CVO`, will then calculate the effective status, that means, based on the [axioms](https://github.com/openshift/enhancements/blob/master/enhancements/installer/component-selection.md#axioms), CVO will allow to have them disabled at install time or still install them based on requirements, etc. Note that axioms will help in day-2 behaviors, for an installation, it will install the components not excluded or the required ones for dependencies.
See https://docs.openshift.com/container-platform/latest/installing/cluster-capabilities.html for more information.

> [!IMPORTANT]
Note that disabling capabilities could cause problems in some situations, e.g. disabling the baremetal-operator on a baremetal platform cluster will cause installation to fail.

#### Patching the install config

Expand Down

0 comments on commit 6492159

Please sign in to comment.