Skip to content

Commit c3f2b73

Browse files
authored
Merge pull request #59196 from aireilly/chore-fix-ztp-refs
2 parents 26e4fdd + 5925af9 commit c3f2b73

File tree

88 files changed

+226
-225
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+226
-225
lines changed

architecture/mce-overview-ocp.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ When you enable multicluster engine on {product-title}, you gain the following c
1919
* xref:../architecture/control-plane.adoc#hosted-control-planes-overview_control-plane[Hosted control planes], which is a feature that is based on the HyperShift project. With a centralized hosted control plane, you can operate {product-title} clusters in a hyperscale manner.
2020
* Hive, which provisions self-managed {product-title} clusters to the hub and completes the initial configurations for those clusters.
2121
* klusterlet agent, which registers managed clusters to the hub.
22-
* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as SNO on bare metal. The Infrastructure Operator includes xref:../scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[zero touch provisioning (ZTP)], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
22+
* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as SNO on bare metal. The Infrastructure Operator includes xref:../scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
2323
* Open cluster management, which provides resources to manage Kubernetes clusters.
2424

2525
The multicluster engine is included with your {product-title} support subscription and is delivered separately from the core payload. To start to use multicluster engine, you deploy the {product-title} cluster and then install the operator. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#mce-install-intro[the installation documentation].
2626

2727
[id="mce-on-rhacm"]
2828
== Cluster management with Red Hat Advanced Cluster Management
2929

30-
If you need cluster management capabilities beyond what {product-title} with multicluster engine can provide, consider Red Hat Advanced Cluster Management. The multicluster engine is an integral part of Red Hat Advanced Cluster Management and is enabled by default.
30+
If you need cluster management capabilities beyond what {product-title} with multicluster engine can provide, consider Red Hat Advanced Cluster Management. The multicluster engine is an integral part of Red Hat Advanced Cluster Management and is enabled by default.
3131

3232
[id="mce-additional-resources-ocp"]
3333
== Additional resources

installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ include::modules/sample-ztp-custom-resources.adoc[leveloffset=+1]
4141
[role="_additional-resources"]
4242
.Additional resources
4343

44-
* See xref:../../scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-deploying-far-edge-clusters-at-scale[Challenges of the network far edge] to learn more about zero touch provisioning (ZTP).
44+
* See xref:../../scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-deploying-far-edge-clusters-at-scale[Challenges of the network far edge] to learn more about {ztp-first}.

modules/about-ztp.adoc

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

55
:_content-type: CONCEPT
66
[id="about-ztp_{context}"]
7-
= Using ZTP to provision clusters at the network far edge
7+
= Using {ztp} to provision clusters at the network far edge
88

9-
{rh-rhacm-first} manages clusters in a hub-and-spoke architecture, where a single hub cluster manages many spoke clusters. Hub clusters running {rh-rhacm} provision and deploy the managed clusters by using zero touch provisioning (ZTP) and the assisted service that is deployed when you install {rh-rhacm}.
9+
{rh-rhacm-first} manages clusters in a hub-and-spoke architecture, where a single hub cluster manages many spoke clusters. Hub clusters running {rh-rhacm} provision and deploy the managed clusters by using {ztp-first} and the assisted service that is deployed when you install {rh-rhacm}.
1010

1111
The assisted service handles provisioning of {product-title} on single node clusters, three-node clusters, or standard clusters running on bare metal.
1212

13-
A high-level overview of using ZTP to provision and maintain bare-metal hosts with {product-title} is as follows:
13+
A high-level overview of using {ztp} to provision and maintain bare-metal hosts with {product-title} is as follows:
1414

1515
* A hub cluster running {rh-rhacm} manages an {product-registry} that mirrors the {product-title} release images. {rh-rhacm} uses the {product-registry} to provision the managed clusters.
1616
@@ -20,4 +20,4 @@ A high-level overview of using ZTP to provision and maintain bare-metal hosts wi
2020
2121
Installing and deploying the clusters is a two-stage process, involving an initial installation phase, and a subsequent configuration phase. The following diagram illustrates this workflow:
2222

23-
image::217_OpenShift_Zero_Touch_Provisioning_updates_1022_2.png[Using GitOps and ZTP to install and deploy managed clusters]
23+
image::217_OpenShift_Zero_Touch_Provisioning_updates_1022_2.png[Using GitOps and {ztp} to install and deploy managed clusters]

modules/agent-install-about-mirroring-for-disconnected-registry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Use the output of the command to update the `imageContentSources` field in the `
4949

5050
The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry.
5151

52-
If you are using the optional method of the ZTP manifests, there are two mirror configuration files: `registries.conf` and `ca- bundle.crt` . These files must be added to the `mirror/directory` path to add the mirror configuration in the agent ISO image.
52+
If you are using the optional method of the {ztp} manifests, there are two mirror configuration files: `registries.conf` and `ca- bundle.crt` . These files must be added to the `mirror/directory` path to add the mirror configuration in the agent ISO image.
5353

5454
You can create the `registries.conf` file from the output of either the `oc adm release mirror` or `oc mirror` command. The format of the `/etc/containers/registries.conf` file has changed . It is now version 2 and in TOML format.
5555

modules/agent-install-networking.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ rendezvousIP: 192.168.111.80 <1>
8181
<6> Next hop address for the node traffic. This must be in the same subnet as the IP address set for the specified interface.
8282

8383
+
84-
.. Optional method: ZTP manifests
84+
.. Optional method: {ztp} manifests
8585

8686
+
87-
The optional method of the ZTP custom resources comprises 6 custom resources; you can configure static IPs in the `nmstateconfig.yaml` file.
87+
The optional method of the {ztp} custom resources comprises 6 custom resources; you can configure static IPs in the `nmstateconfig.yaml` file.
8888

8989
+
9090
[source,yaml]

modules/agent-installer-configuring-fips-compliance.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ metadata:
2525
fips: True
2626
----
2727

28-
. Optional: If you are using the ZTP manifests, you must set the value of `fips` as `True` in the `Agent-install.openshift.io/install-config-overrides` field in the `agent-cluster-install.yaml` file:
28+
. Optional: If you are using the {ztp} manifests, you must set the value of `fips` as `True` in the `Agent-install.openshift.io/install-config-overrides` field in the `agent-cluster-install.yaml` file:
2929

3030
+
3131
.Sample agent-cluster-install.yaml file

modules/cnf-topology-aware-lifecycle-manager-autocreate-cgu-cr-ztp.adoc

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

55
:_content-type: PROCEDURE
66
[id="talo-precache-autocreated-cgu-for-ztp_{context}"]
7-
= About the auto-created ClusterGroupUpgrade CR for ZTP
7+
= About the auto-created ClusterGroupUpgrade CR for {ztp}
88

9-
{cgu-operator} has a controller called `ManagedClusterForCGU` that monitors the `Ready` state of the `ManagedCluster` CRs on the hub cluster and creates the `ClusterGroupUpgrade` CRs for ZTP (zero touch provisioning).
9+
{cgu-operator} has a controller called `ManagedClusterForCGU` that monitors the `Ready` state of the `ManagedCluster` CRs on the hub cluster and creates the `ClusterGroupUpgrade` CRs for {ztp-first}.
1010

11-
For any managed cluster in the `Ready` state without a `ztp-done` label applied, the `ManagedClusterForCGU` controller automatically creates a `ClusterGroupUpgrade` CR in the `ztp-install` namespace with its associated {rh-rhacm} policies that are created during the ZTP process. {cgu-operator} then remediates the set of configuration policies that are listed in the auto-created `ClusterGroupUpgrade` CR to push the configuration CRs to the managed cluster.
11+
For any managed cluster in the `Ready` state without a `ztp-done` label applied, the `ManagedClusterForCGU` controller automatically creates a `ClusterGroupUpgrade` CR in the `ztp-install` namespace with its associated {rh-rhacm} policies that are created during the {ztp} process. {cgu-operator} then remediates the set of configuration policies that are listed in the auto-created `ClusterGroupUpgrade` CR to push the configuration CRs to the managed cluster.
1212

1313
If there are no policies for the managed cluster at the time when the cluster becomes `Ready`, a `ClusterGroupUpgrade` CR with no policies is created. Upon completion of the `ClusterGroupUpgrade` the managed cluster is labeled as `ztp-done`. If there are policies that you want to apply for that managed cluster, manually create a `ClusterGroupUpgrade` as a day-2 operation.
1414

15-
.Example of an auto-created `ClusterGroupUpgrade` CR for ZTP
15+
.Example of an auto-created `ClusterGroupUpgrade` CR for {ztp}
1616

1717
[source,yaml]
1818
----

modules/cnf-topology-aware-lifecycle-manager-operator-and-platform-update.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ You can perform a platform and an Operator update at the same time.
1111
.Prerequisites
1212

1313
* Install the {cgu-operator-first}.
14-
* Update ZTP to the latest version.
15-
* Provision one or more managed clusters with ZTP.
14+
* Update {ztp-first} to the latest version.
15+
* Provision one or more managed clusters with {ztp}.
1616
* Log in as a user with `cluster-admin` privileges.
1717
* Create {rh-rhacm} policies in the hub cluster.
1818

modules/cnf-topology-aware-lifecycle-manager-operator-update.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ You can perform an Operator update with the {cgu-operator}.
1111
.Prerequisites
1212

1313
* Install the {cgu-operator-first}.
14-
* Update ZTP to the latest version.
15-
* Provision one or more managed clusters with ZTP.
14+
* Update {ztp-first} to the latest version.
15+
* Provision one or more managed clusters with {ztp}.
1616
* Mirror the desired index image, bundle images, and all Operator images referenced in the bundle images.
1717
* Log in as a user with `cluster-admin` privileges.
1818
* Create {rh-rhacm} policies in the hub cluster.
@@ -95,14 +95,14 @@ spec:
9595
source: certified-operators
9696
----
9797

98-
.. Remove the specified subscriptions channels in the common `PolicyGenTemplate` CR, if they exist. The default subscriptions channels from the ZTP image are used for the update.
98+
.. Remove the specified subscriptions channels in the common `PolicyGenTemplate` CR, if they exist. The default subscriptions channels from the {ztp} image are used for the update.
9999
+
100100
[NOTE]
101101
====
102-
The default channel for the Operators applied through ZTP {product-version} is `stable`, except for the `performance-addon-operator`. As of {product-title} 4.11, the `performance-addon-operator` functionality was moved to the `node-tuning-operator`. For the 4.10 release, the default channel for PAO is `v4.10`. You can also specify the default channels in the common `PolicyGenTemplate` CR.
102+
The default channel for the Operators applied through {ztp} {product-version} is `stable`, except for the `performance-addon-operator`. As of {product-title} 4.11, the `performance-addon-operator` functionality was moved to the `node-tuning-operator`. For the 4.10 release, the default channel for PAO is `v4.10`. You can also specify the default channels in the common `PolicyGenTemplate` CR.
103103
====
104104

105-
.. Push the `PolicyGenTemplate` CRs updates to the ZTP Git repository.
105+
.. Push the `PolicyGenTemplate` CRs updates to the {ztp} Git repository.
106106
+
107107
ArgoCD pulls the changes from the Git repository and generates the policies on the hub cluster.
108108

modules/cnf-topology-aware-lifecycle-manager-platform-update.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ You can perform a platform update with the {cgu-operator}.
1111
.Prerequisites
1212

1313
* Install the {cgu-operator-first}.
14-
* Update ZTP to the latest version.
15-
* Provision one or more managed clusters with ZTP.
14+
* Update {ztp-first} to the latest version.
15+
* Provision one or more managed clusters with {ztp}.
1616
* Mirror the desired image repository.
1717
* Log in as a user with `cluster-admin` privileges.
1818
* Create {rh-rhacm} policies in the hub cluster.
@@ -88,7 +88,7 @@ The `PolicyGenTemplate` CR generates two policies:
8888
8989
* The `du-upgrade-platform-upgrade` policy is used to perform platform upgrade.
9090
91-
.. Add the `du-upgrade.yaml` file contents to the `kustomization.yaml` file located in the ZTP Git repository for the `PolicyGenTemplate` CRs and push the changes to the Git repository.
91+
.. Add the `du-upgrade.yaml` file contents to the `kustomization.yaml` file located in the {ztp} Git repository for the `PolicyGenTemplate` CRs and push the changes to the Git repository.
9292
+
9393
ArgoCD pulls the changes from the Git repository and generates the policies on the hub cluster.
9494

0 commit comments

Comments
 (0)