Skip to content

Commit d97c010

Browse files
authored
Merge pull request #72312 from jeana-redhat/OCPBUGS-29907-remodularize-capi-arch-for-xref
OCPBUGS-29907: split modules to move xref
2 parents 22b2a3b + b119fc1 commit d97c010

File tree

3 files changed

+26
-19
lines changed

3 files changed

+26
-19
lines changed

machine_management/capi-machine-management.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,21 @@ Using the Cluster API to manage machines is a Technology Preview feature and has
4747

4848
* Full feature parity with the Machine API is not available.
4949

50-
//Cluster API architecture
51-
include::modules/cluster-api-architecture.adoc[leveloffset=+1]
50+
[id="cluster-api-architecture_{context}"]
51+
== Cluster API architecture
52+
53+
The {product-title} integration of the upstream Cluster API is implemented and managed by the Cluster CAPI Operator. The Cluster CAPI Operator and its operands are provisioned in the `openshift-cluster-api` namespace, in contrast to the Machine API, which uses the `openshift-machine-api` namespace.
54+
55+
//The Cluster CAPI Operator
56+
include::modules/capi-arch-operator.adoc[leveloffset=+2]
5257

5358
[role="_additional-resources"]
5459
.Additional resources
5560
* xref:../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[Cluster CAPI Operator]
5661

62+
//Cluster API primary resources
63+
include::modules/capi-arch-resources.adoc[leveloffset=+2]
64+
5765
[id="capi-sample-yaml-files"]
5866
== Sample YAML files
5967

modules/capi-arch-operator.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/capi-machine-management.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="capi-arch-operator_{context}"]
7+
= The Cluster CAPI Operator
8+
9+
The Cluster CAPI Operator is an {product-title} Operator that maintains the lifecycle of Cluster API resources. This Operator is responsible for all administrative tasks related to deploying the Cluster API project within an {product-title} cluster.
10+
11+
If a cluster is configured correctly to allow the use of the Cluster API, the Cluster CAPI Operator installs the Cluster API components on the cluster.
12+
13+
For more information, see the "Cluster CAPI Operator" entry in the _Cluster Operators reference_ content.

modules/cluster-api-architecture.adoc renamed to modules/capi-arch-resources.adoc

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,9 @@
22
//
33
// * machine_management/capi-machine-management.adoc
44

5-
:_mod-docs-content-type: CONCEPT
6-
[id="cluster-api-architecture_{context}"]
7-
= Cluster API architecture
8-
9-
The {product-title} integration of the upstream Cluster API is implemented and managed by the Cluster CAPI Operator. The Cluster CAPI Operator and its operands are provisioned in the `openshift-cluster-api` namespace, in contrast to the Machine API, which uses the `openshift-machine-api` namespace.
10-
11-
[id="capi-arch-operator"]
12-
== The Cluster CAPI Operator
13-
14-
The Cluster CAPI Operator is an {product-title} Operator that maintains the lifecycle of Cluster API resources. This Operator is responsible for all administrative tasks related to deploying the Cluster API project within an {product-title} cluster.
15-
16-
If a cluster is configured correctly to allow the use of the Cluster API, the Cluster CAPI Operator installs the Cluster API components on the cluster.
17-
18-
For more information, see the entry for the Cluster CAPI Operator in the _Cluster Operators reference_ content.
19-
20-
[id="capi-arch-resources"]
21-
== Primary resources
5+
:_mod-docs-content-type: REFERENCE
6+
[id="capi-arch-resources_{context}"]
7+
= Cluster API primary resources
228

239
The Cluster API consists of the following primary resources. For the Technology Preview of this feature, you must create these resources manually in the `openshift-cluster-api` namespace.
2410

0 commit comments

Comments
 (0)