Skip to content

Commit dfd7e3b

Browse files
committed
OSDOCS-3644 Installer allows users to select optional components
1 parent fe8505e commit dfd7e3b

15 files changed

+72
-1
lines changed

modules/installation-alibaba-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ publish: External
5252
pullSecret: '{"auths": {"cloud.openshift.com": {"auth": ... }' <5>
5353
sshKey: |
5454
ssh-rsa AAAA... <6>
55+
capabilities:
56+
baselineCapabilitySet: None
57+
additionalEnabledCapabilities:
58+
- openshift-samples
5559
----
5660
<1> Required. The installation program prompts you for a cluster name.
5761
<2> Optional. Specify parameters for machine pools that do not define their own platform configuration.

modules/installation-aws-config-yaml.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,10 @@ imageContentSources: <15>
273273
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
274274
endif::openshift-origin[]
275275
endif::restricted[]
276-
276+
capabilities:
277+
baselineCapabilitySet: None
278+
additionalEnabledCapabilities:
279+
- openshift-samples
277280
278281
----
279282
ifndef::gov,secret,china[]

modules/installation-azure-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ ifdef::openshift-origin[]
164164
publish: Internal <16>
165165
endif::openshift-origin[]
166166
endif::gov[]
167+
capabilities:
168+
baselineCapabilitySet: None
169+
additionalEnabledCapabilities:
170+
- openshift-samples
167171
----
168172
ifndef::gov[]
169173
<1> Required. The installation program prompts you for this value.

modules/installation-azure-stack-hub-config-yaml.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ additionalTrustBundle: | <9>
7575
-----END CERTIFICATE-----
7676
sshKey: ssh-ed25519 AAAA... <10>
7777
endif::openshift-origin[]
78+
capabilities:
79+
baselineCapabilitySet: None
80+
additionalEnabledCapabilities:
81+
- openshift-samples
7882
----
7983
<1> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
8084
<2> Specify the name of the cluster.
@@ -160,6 +164,10 @@ endif::openshift-origin[]
160164
-----BEGIN CERTIFICATE-----
161165
<MY_TRUSTED_CA_CERT>
162166
-----END CERTIFICATE-----
167+
capabilities:
168+
baselineCapabilitySet: None
169+
additionalEnabledCapabilities:
170+
- openshift-samples
163171
----
164172
<1> Required.
165173
<2> If you do not provide these parameters and values, the installation program provides the default value.

modules/installation-bare-metal-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,10 @@ ifndef::ibm-z,ibm-z-kvm[]
205205
endif::ibm-z,ibm-z-kvm[]
206206
endif::openshift-origin[]
207207
endif::restricted[]
208+
capabilities:
209+
baselineCapabilitySet: None
210+
additionalEnabledCapabilities:
211+
- openshift-samples
208212
----
209213
<1> The base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name.
210214
<2> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.

modules/installation-configuration-parameters.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,18 @@ Optional installation configuration parameters are described in the following ta
473473
|A PEM-encoded X.509 certificate bundle that is added to the nodes' trusted certificate store. This trust bundle may also be used when a proxy has been configured.
474474
|String
475475

476+
|`capabilities`
477+
|Controls the installation of optional core cluster components. You can reduce the footprint of your {product-title} cluster by disabling optional components.
478+
|String array
479+
480+
|`capabilities.baselineCapabilitySet`
481+
|Selects an initial set of optional capabilities to enable. Valid values are `None`, `v4.11` and `vCurrent`. `v4.11` enables the `baremetal` Operator, the `marketplace` Operator, and the `openshift-samples` content. `vCurrent` installs the recommended set of capabilities for the current version of {product-title}. The default value is `vCurrent`.
482+
|String
483+
484+
|`capabilities.additionalEnabledCapabilities`
485+
|Extends the set of optional capabilities beyond what you specify in `baselineCapabilitySet`. Valid values are `baremetal`, `marketplace` and `openshift-samples`. You may specify multiple capabilities in this parameter.
486+
|String array
487+
476488
|`cgroupsV2`
477489
|Enables link:https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html[Linux control groups version 2] (cgroups v2) on specific nodes in your cluster. The {product-title} process for enabling cgroups v2 disables all cgroup version 1 controllers and hierarchies. The {product-title} cgroups version 2 feature is in Developer Preview and is not supported by Red Hat at this time.
478490
|`true`

modules/installation-gcp-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,10 @@ imageContentSources: <12>
174174
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
175175
endif::openshift-origin[]
176176
endif::restricted[]
177+
capabilities:
178+
baselineCapabilitySet: None
179+
additionalEnabledCapabilities:
180+
- openshift-samples
177181
----
178182
<1> Required. The installation program prompts you for this value.
179183
<2> If you do not provide these parameters and values, the installation program provides the default value.

modules/installation-gcp-user-infra-shared-vpc-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ ifdef::openshift-origin[]
6666
sshKey: ssh-ed25519 AAAA... <7>
6767
publish: Internal <8>
6868
endif::openshift-origin[]
69+
capabilities:
70+
baselineCapabilitySet: None
71+
additionalEnabledCapabilities:
72+
- openshift-samples
6973
----
7074
<1> Specify the public DNS on the host project.
7175
<2> If you do not provide these parameters and values, the installation program provides the default value.

modules/installation-ibm-cloud-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ endif::openshift-origin[]
7171
ifdef::openshift-origin[]
7272
sshKey: ssh-ed25519 AAAA... <5>
7373
endif::openshift-origin[]
74+
capabilities:
75+
baselineCapabilitySet: None
76+
additionalEnabledCapabilities:
77+
- openshift-samples
7478
----
7579
<1> Required. The installation program prompts you for this value.
7680
<2> If you do not provide these parameters and values, the installation program provides the default value.

modules/installation-installer-provisioned-vsphere-config-yaml.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ imageContentSources: <12>
111111
- <local_registry>/<local_repository_name>/release
112112
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
113113
endif::restricted[]
114+
capabilities:
115+
baselineCapabilitySet: None
116+
additionalEnabledCapabilities:
117+
- openshift-samples
114118
----
115119
<1> The base domain of the cluster. All DNS records must be sub-domains of this
116120
base and include the cluster name.

0 commit comments

Comments
 (0)