Skip to content

Commit fe48487

Browse files
committed
OSDOCS-6810 adding 4.14 capabilities
1 parent 0b96695 commit fe48487

File tree

5 files changed

+41
-11
lines changed

5 files changed

+41
-11
lines changed

installing/cluster-capabilities.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,15 @@ include::modules/insights-operator.adoc[leveloffset=+2]
6262
.Additional resources
6363
* xref:../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using Insights Operator]
6464
65+
include::modules/machine-api-capability.adoc[leveloffset=+2]
66+
67+
[role="_additional-resources"]
68+
.Additional resources
69+
* xref:../machine_management/index.html#index[Overview of machine management]
70+
* xref:../operators/operator-reference.html#machine-api-operator_cluster-operators-ref[Machine API Operator]
71+
* xref:../operators/operator-reference.html#cluster-autoscaler-operator_cluster-operators-ref[Cluster Autoscaler Operator]
72+
* xref:../operators/operator-reference.html#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator]
73+
6574
include::modules/operator-marketplace.adoc[leveloffset=+2]
6675

6776
[role="_additional-resources"]

modules/cluster-bare-metal-operator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ The Cluster Baremetal Operator provides the features for the `baremetal` capabil
3434

3535
endif::cluster-caps[]
3636

37-
The Cluster Baremetal Operator (CBO) deploys all the components necessary to take a bare-metal server to a fully functioning worker node ready to run {product-title} compute nodes. The CBO ensures that the metal3 deployment, which consists of the Bare Metal Operator (BMO) and Ironic containers, runs on one of the control plane nodes within the {product-title} cluster. The CBO also listens for {product-title} updates to resources that it watches and takes appropriate action.
37+
The Cluster Baremetal Operator (CBO) deploys all the components necessary to take a bare-metal server to a fully functioning worker node ready to run {product-title} compute nodes. The CBO ensures that the metal3 deployment, which consists of the Bare Metal Operator (BMO) and Ironic containers, runs on one of the control plane nodes within the {product-title} cluster. The CBO also listens for {product-title} updates to resources that it watches and takes appropriate action.
3838

3939
ifdef::cluster-caps[]
4040
The bare-metal capability is required for deployments using installer-provisioned infrastructure. Disabling the bare-metal capability can result in unexpected problems with these deployments.
4141

42-
It is recommended that cluster administrators only disable the bare-metal capability during installations with user-provisioned infrastructure that do not have any `BareMetalHost` resources in the cluster.
42+
It is recommended that cluster administrators only disable the bare-metal capability during installations with user-provisioned infrastructure that do not have any `BareMetalHost` resources in the cluster.
4343

4444
[IMPORTANT]
4545
====
46-
If the bare-metal capability is disabled, the cluster cannot provision or manage bare-metal nodes. Only disable the capability if there are no `BareMetalHost` resources in your deployment.
46+
If the bare-metal capability is disabled, the cluster cannot provision or manage bare-metal nodes. Only disable the capability if there are no `BareMetalHost` resources in your deployment. The `baremetal` capability depends on the `MachineAPI` capability. If you enable the `baremetal` capability, you must also enable `MachineAPI`.
4747
====
4848
endif::cluster-caps[]
4949

modules/cluster-image-registry-operator.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ ifeval::["{context}" == "cluster-capabilities"]
1313
:cluster-caps:
1414
endif::[]
1515

16+
:_content-type: REFERENCE
1617
[id="cluster-image-registry-operator_{context}"]
17-
= Cluster Image Registry Operator
18+
ifdef::operator-ref[= Cluster Image Registry Operator]
19+
ifdef::cluster-caps[= Cluster Image Registry capability]
1820

1921
[discrete]
2022
== Purpose
@@ -39,3 +41,10 @@ endif::[]
3941
== Project
4042

4143
link:https://github.com/openshift/cluster-image-registry-operator[cluster-image-registry-operator]
44+
45+
ifeval::["{context}" == "cluster-operators-ref"]
46+
:!operator-ref:
47+
endif::[]
48+
ifeval::["{context}" == "cluster-capabilities"]
49+
:!cluster-caps:
50+
endif::[]

modules/machine-api-capability.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/cluster-capabilities.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="machine-api-capability_{context}"]
7+
= Machine API capability
8+
9+
[discrete]
10+
== Purpose
11+
12+
The `machine-api-operator`, `cluster-autoscaler-operator`, and `cluster-control-plane-machine-set-operator` Operators provide the features for the `MachineAPI` capability. You can disable this capability only if you install a cluster with user-provisioned infrastructure.
13+
14+
The Machine API capability is responsible for all machine configuration and management in the cluster. If you disable the Machine API capability during installation, you need to manage all machine-related tasks manually.

snippets/capabilities-table.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,19 @@ The following table describes the `baselineCapabilitySet` values.
88
|Value|Description
99

1010
|`vCurrent`
11-
|Specify this option when you want to automatically add new, default capabilities that are introduced in new releases.
11+
|Specify this option when you want to automatically add new, default capabilities that are introduced in new releases.
1212

1313
|`v4.11`
14-
|Specify this option when you want to enable the default capabilities for {product-title} 4.11. By specifying `v4.11`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.11 are `baremetal`, `marketplace`, and `openshift-samples`.
14+
|Specify this option when you want to enable the default capabilities for {product-title} 4.11. By specifying `v4.11`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.11 are `baremetal`, `MachineAPI`, `marketplace`, and `openshift-samples`.
1515

1616
|`v4.12`
17-
|Specify this option when you want to enable the default capabilities for {product-title} 4.12. By specifying `v4.12`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.12 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage` and `CSISnapshot`.
17+
|Specify this option when you want to enable the default capabilities for {product-title} 4.12. By specifying `v4.12`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.12 are `baremetal`, `MachineAPI`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, and `CSISnapshot`.
1818

1919
|`v4.13`
20-
|Specify this option when you want to enable the default capabilities for {product-title} 4.13. By specifying `v4.13`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.13 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot` and `NodeTuning`.
20+
|Specify this option when you want to enable the default capabilities for {product-title} 4.13. By specifying `v4.13`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.13 are `baremetal`, `MachineAPI`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, and `NodeTuning`.
2121

2222
|`v4.14`
23-
|Specify this option when you want to enable the default capabilities for {product-title} 4.14. By specifying `v4.14`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.14 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, `NodeTuning`, and `ImageRegistry`.
24-
25-
// TODO: Add `Build` and `DeploymentConfig` to the list for 4.14.
23+
|Specify this option when you want to enable the default capabilities for {product-title} 4.14. By specifying `v4.14`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.14 are `baremetal`, `MachineAPI`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, `NodeTuning`, `ImageRegistry`, `Build`, and `DeploymentConfig`.
2624

2725
|`None`
2826
|Specify when the other sets are too large, and you do not need any capabilities or want to fine-tune via `additionalEnabledCapabilities`.

0 commit comments

Comments
 (0)