Skip to content

Commit 22db4da

Browse files
committed
Adds attribute for Cluster CAPI Operator
1 parent 941fd9b commit 22db4da

8 files changed

+17
-15
lines changed

_attributes/common-attributes.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,9 @@ endif::openshift-origin[]
312312
:entra-short: Workload ID
313313

314314

315-
// Cluster API Providers
315+
// Cluster API terminology
316+
// Cluster CAPI Operator
317+
:cluster-capi-operator: Cluster CAPI Operator
316318
// Cluster API Provider Amazon Web Services (AWS)
317319
:cap-aws-first: Cluster API Provider Amazon Web Services (AWS)
318320
:cap-aws-short: Cluster API Provider AWS

machine_management/cluster_api_machine_management/cluster-api-about.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ include::modules/capi-limitations.adoc[leveloffset=+2]
3131
[id="cluster-api-architecture_{context}"]
3232
== Cluster API architecture
3333

34-
The {product-title} integration of the upstream Cluster API is implemented and managed by the Cluster CAPI Operator.
35-
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.
34+
The {product-title} integration of the upstream Cluster API is implemented and managed by the {cluster-capi-operator}.
35+
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.
3636

37-
//The Cluster CAPI Operator
37+
//The {cluster-capi-operator}
3838
include::modules/capi-arch-operator.adoc[leveloffset=+2]
3939

4040
[role="_additional-resources"]
4141
.Additional resources
42-
* xref:../../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[Cluster CAPI Operator]
42+
* xref:../../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[{cluster-capi-operator}]
4343

4444
//Cluster API primary resources
4545
include::modules/capi-arch-resources.adoc[leveloffset=+2]

machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ include::snippets/technology-preview.adoc[]
1212
Use the information in this section to understand and recover from issues you might encounter.
1313
Generally, troubleshooting steps for problems with the Cluster API are similar to those steps for problems with the Machine API.
1414

15-
The Cluster CAPI Operator and its operands are provisioned in the `openshift-cluster-api` namespace, whereas the Machine API uses the `openshift-machine-api` namespace. When using `oc` commands that reference a namespace, be sure to reference the correct one.
15+
The {cluster-capi-operator} and its operands are provisioned in the `openshift-cluster-api` namespace, whereas the Machine API uses the `openshift-machine-api` namespace. When using `oc` commands that reference a namespace, be sure to reference the correct one.
1616

1717
//Returning the intended machines when using the CLI
1818
include::modules/ts-capi-cli-reference-intended-objects.adoc[leveloffset=+1]

modules/capi-arch-operator.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="capi-arch-operator_{context}"]
7-
= The Cluster CAPI Operator
7+
= The {cluster-capi-operator}
88

9-
The Cluster CAPI Operator is an {product-title} Operator that maintains the lifecycle of Cluster API resources.
9+
The {cluster-capi-operator} is an {product-title} Operator that maintains the lifecycle of Cluster API resources.
1010
This Operator is responsible for all administrative tasks related to deploying the Cluster API project within an {product-title} cluster.
1111

12-
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+
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.
1313

14-
For more information, see the "Cluster CAPI Operator" entry in the _Cluster Operators reference_ content.
14+
For more information, see the "{cluster-capi-operator}" entry in the _Cluster Operators reference_ content.

modules/cco-short-term-creds-component-permissions-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These permissions apply to all resources. Unless specified, there are no request
1717
|====
1818
|Component |Custom resource |Required permissions for services
1919

20-
|Cluster CAPI Operator
20+
|{cluster-capi-operator}
2121
|`openshift-cluster-api-aws`
2222
|**EC2**
2323

modules/cco-short-term-creds-component-permissions-azure.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* `Microsoft.Network/publicIPAddresses/read`
2525
* `Microsoft.Network/publicIPAddresses/write`
2626

27-
|Cluster CAPI Operator
27+
|{cluster-capi-operator}
2828
|`openshift-cluster-api-azure`
2929
|role: `Contributor` ^[1]^
3030

modules/cluster-capi-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * operators/operator-reference.adoc
44

55
[id="cluster-capi-operator_{context}"]
6-
= Cluster CAPI Operator
6+
= {cluster-capi-operator}
77

88
[NOTE]
99
====
@@ -13,7 +13,7 @@ This Operator is available as a link:https://access.redhat.com/support/offerings
1313
[discrete]
1414
== Purpose
1515

16-
The Cluster CAPI Operator 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.
16+
The {cluster-capi-operator} 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.
1717

1818
[discrete]
1919
== Project

modules/mco-update-boot-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This process could cause the following issues:
1717
* Certificate expiration issues
1818
* Version skew issues
1919
20-
To avoid these issues, you can configure your cluster to update the boot image whenever you update your cluster. By modifying the `MachineConfiguration` object, you can enable this feature. Currently, the ability to update the boot image is available for only Google Cloud Platform (GCP) clusters and is not supported for Cluster CAPI Operator managed clusters.
20+
To avoid these issues, you can configure your cluster to update the boot image whenever you update your cluster. By modifying the `MachineConfiguration` object, you can enable this feature. Currently, the ability to update the boot image is available for only Google Cloud Platform (GCP) clusters and is not supported for {cluster-capi-operator} managed clusters.
2121

2222
:FeatureName: The updating boot image feature
2323
include::snippets/technology-preview.adoc[]

0 commit comments

Comments
 (0)