From 0294656752c40e3b8ae6c169512fd8337574d842 Mon Sep 17 00:00:00 2001 From: Jeana Routh Date: Wed, 26 Jun 2024 11:25:51 -0400 Subject: [PATCH] Adds attribute for Cluster CAPI Operator --- _attributes/common-attributes.adoc | 4 +++- .../cluster_api_machine_management/cluster-api-about.adoc | 8 ++++---- .../cluster-api-troubleshooting.adoc | 2 +- modules/capi-arch-operator.adoc | 8 ++++---- .../cco-short-term-creds-component-permissions-aws.adoc | 2 +- .../cco-short-term-creds-component-permissions-azure.adoc | 2 +- modules/cluster-capi-operator.adoc | 4 ++-- modules/mco-update-boot-images.adoc | 2 +- 8 files changed, 17 insertions(+), 15 deletions(-) diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 11c270f496..1779731066 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -313,7 +313,9 @@ endif::openshift-origin[] :entra-short: Workload ID -// Cluster API Providers +// Cluster API terminology +// Cluster CAPI Operator +:cluster-capi-operator: Cluster CAPI Operator // Cluster API Provider Amazon Web Services (AWS) :cap-aws-first: Cluster API Provider Amazon Web Services (AWS) :cap-aws-short: Cluster API Provider AWS diff --git a/machine_management/cluster_api_machine_management/cluster-api-about.adoc b/machine_management/cluster_api_machine_management/cluster-api-about.adoc index caf2bf4279..6fa385b298 100644 --- a/machine_management/cluster_api_machine_management/cluster-api-about.adoc +++ b/machine_management/cluster_api_machine_management/cluster-api-about.adoc @@ -31,15 +31,15 @@ include::modules/capi-limitations.adoc[leveloffset=+2] [id="cluster-api-architecture_{context}"] == Cluster API architecture -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. +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. -//The Cluster CAPI Operator +//The {cluster-capi-operator} include::modules/capi-arch-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[Cluster CAPI Operator] +* xref:../../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[{cluster-capi-operator}] //Cluster API primary resources include::modules/capi-arch-resources.adoc[leveloffset=+2] \ No newline at end of file diff --git a/machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc b/machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc index 9b2591cb8d..91eb85cf1c 100644 --- a/machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc +++ b/machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc @@ -12,7 +12,7 @@ include::snippets/technology-preview.adoc[] Use the information in this section to understand and recover from issues you might encounter. Generally, troubleshooting steps for problems with the Cluster API are similar to those steps for problems with the Machine API. -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. +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. //Returning the intended machines when using the CLI include::modules/ts-capi-cli-reference-intended-objects.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/capi-arch-operator.adoc b/modules/capi-arch-operator.adoc index 6947c6d25c..eaa6c6f057 100644 --- a/modules/capi-arch-operator.adoc +++ b/modules/capi-arch-operator.adoc @@ -4,11 +4,11 @@ :_mod-docs-content-type: CONCEPT [id="capi-arch-operator_{context}"] -= The Cluster CAPI Operator += The {cluster-capi-operator} -The Cluster CAPI Operator is an {product-title} Operator that maintains the lifecycle of Cluster API resources. +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. -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. +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. -For more information, see the "Cluster CAPI Operator" entry in the _Cluster Operators reference_ content. \ No newline at end of file +For more information, see the "{cluster-capi-operator}" entry in the _Cluster Operators reference_ content. \ No newline at end of file diff --git a/modules/cco-short-term-creds-component-permissions-aws.adoc b/modules/cco-short-term-creds-component-permissions-aws.adoc index 2d108ce801..447291db9b 100644 --- a/modules/cco-short-term-creds-component-permissions-aws.adoc +++ b/modules/cco-short-term-creds-component-permissions-aws.adoc @@ -17,7 +17,7 @@ These permissions apply to all resources. Unless specified, there are no request |==== |Component |Custom resource |Required permissions for services -|Cluster CAPI Operator +|{cluster-capi-operator} |`openshift-cluster-api-aws` |**EC2** diff --git a/modules/cco-short-term-creds-component-permissions-azure.adoc b/modules/cco-short-term-creds-component-permissions-azure.adoc index 483f7c65f7..8bb6013507 100644 --- a/modules/cco-short-term-creds-component-permissions-azure.adoc +++ b/modules/cco-short-term-creds-component-permissions-azure.adoc @@ -24,7 +24,7 @@ * `Microsoft.Network/publicIPAddresses/read` * `Microsoft.Network/publicIPAddresses/write` -|Cluster CAPI Operator +|{cluster-capi-operator} |`openshift-cluster-api-azure` |role: `Contributor` ^[1]^ diff --git a/modules/cluster-capi-operator.adoc b/modules/cluster-capi-operator.adoc index 73c69f313d..f99d0703bc 100644 --- a/modules/cluster-capi-operator.adoc +++ b/modules/cluster-capi-operator.adoc @@ -3,7 +3,7 @@ // * operators/operator-reference.adoc [id="cluster-capi-operator_{context}"] -= Cluster CAPI Operator += {cluster-capi-operator} [NOTE] ==== @@ -13,7 +13,7 @@ This Operator is available as a link:https://access.redhat.com/support/offerings [discrete] == Purpose -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. +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. [discrete] == Project diff --git a/modules/mco-update-boot-images.adoc b/modules/mco-update-boot-images.adoc index 71203cd77c..bbd1be743c 100644 --- a/modules/mco-update-boot-images.adoc +++ b/modules/mco-update-boot-images.adoc @@ -17,7 +17,7 @@ This process could cause the following issues: * Certificate expiration issues * Version skew issues -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. +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. :FeatureName: The updating boot image feature include::snippets/technology-preview.adoc[]