Skip to content

Commit 8b79f3e

Browse files
committed
TELCODOCS-1874: Fixing typos and adjust TOC
1 parent 0235583 commit 8b79f3e

7 files changed

+19
-32
lines changed

modules/telco-hub-cluster-topology.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: REFERENCE
22
[id="telco-hub-cluster-topology_{context}"]
3-
= Cluster topology
3+
= Hub cluster topology
44

55
In production environments, the {product-title} hub cluster must be highly available to maintain high availability of the management functions.
66

modules/telco-hub-memory-and-cpu-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Engineering considerations::
1212
--
1313
* Before deploying a telco hub cluster, ensure that your cluster host meets cluster requirements.
1414

15-
For more information about scaling the number of managed clusters, see "Hub cluster engineering considerations".
15+
For more information about scaling the number of managed clusters, see "Hub cluster scaling target".
1616
--

modules/telco-hub-networking.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: REFERENCE
22
[id="telco-hub-networking_{context}"]
3-
= Networking
3+
= Hub cluster networking
44

55
The reference hub cluster is designed to operate in a disconnected networking environment where direct access to the internet is not possible.
66
As with all {product-title} clusters, the hub cluster requires access to an image registry hosting all OpenShift and Day 2 {olm-first} images.
@@ -16,7 +16,7 @@ Limits and requirements::
1616
** `serviceNetwork`
1717
** `machineNetwork`
1818

19-
* Yout must configure the following IP addresses for the hub cluster:
19+
* You must configure the following IP addresses for the hub cluster:
2020
** `apiVIP`
2121
** `ingressVIP`
2222

modules/telco-hub-resource-utilization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: REFERENCE
22
[id="telco-hub-resource-utilization_{context}"]
3-
= Hubs cluster resource utilization
3+
= Hub cluster resource utilization
44

55
Resource utilization was measured for hub clusters in the following scenario:
66

modules/telco-hub-storage-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: CONCEPT
22
[id="telco-hub-storage-requirements_{context}"]
3-
= Storage requirements
3+
= Hub cluster storage requirements
44

55
The total amount of storage required by the management hub cluster is dependant on the storage requirements for each of the applications deployed on the cluster.
66
The main components that require storage through highly available `PersistentVolume` resources are described in the following sections.

modules/telco-hub-topology-aware-lifecycle-manager-talm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Description::
1414
* Progressive rollout of policy updates to fleets of clusters in user configurable batches.
1515
* Per-cluster actions add `ztp-done` labels or other user-configurable labels following configuration changes to managed clusters.
1616
17-
* {cgu-operator} supports optional pre-caching of {product_title}, {olm} Operator, and additional images to {sno} clusters before initiating an upgrade. The pre-caching feature is not applicable when using the recommended image-based upgrade method for upgrading {sno} clusters.
17+
* {cgu-operator} supports optional pre-caching of {product-title}, {olm} Operator, and additional images to {sno} clusters before initiating an upgrade. The pre-caching feature is not applicable when using the recommended image-based upgrade method for upgrading {sno} clusters.
1818
1919
** Specifying optional pre-caching configurations with `PreCachingConfig` CRs.
2020

scalability_and_performance/telco-hub-rds.adoc

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,24 @@ include::modules/telco-hub-telco-management-cluster-use-model.adoc[leveloffset=+
3434
** link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/about/index#multicluster-architecture[Multicluster architecture]
3535
** link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/about/index#observability-arch[Observability]
3636
37-
include::modules/telco-hub-engineering-considerations.adoc[leveloffset=+1]
37+
include::modules/telco-hub-scaling-targets.adoc[leveloffset=+1]
3838

39-
include::modules/telco-hub-scaling-targets.adoc[leveloffset=+2]
40-
41-
include::modules/telco-hub-resource-utilization.adoc[leveloffset=+2]
39+
include::modules/telco-hub-resource-utilization.adoc[leveloffset=+1]
4240

4341
[role="_additional-resources"]
4442
.Additional resources
4543

4644
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/governance/index#template-comparison-table[Comparison of hub cluster and managed cluster templates]
4745
48-
include::modules/telco-hub-cluster-topology.adoc[leveloffset=+2]
46+
include::modules/telco-hub-cluster-topology.adoc[leveloffset=+1]
4947

5048
[role="_additional-resources"]
5149
.Additional resources
5250

53-
* link:xref:../welcome/learn_more_about_openshift.adoc#architecture[{product-title} architecture]
54-
* link:xref:../post_installation_configuration/node-tasks.adoc#post-install-node-tasks[Postinstallation node tasks]
51+
* xref:../welcome/learn_more_about_openshift.adoc#architecture[{product-title} architecture]
52+
* xref:../post_installation_configuration/node-tasks.adoc#post-install-node-tasks[Postinstallation node tasks]
5553
56-
include::modules/telco-hub-networking.adoc[leveloffset=+2]
54+
include::modules/telco-hub-networking.adoc[leveloffset=+1]
5755

5856
[role="_additional-resources"]
5957
.Additional resources
@@ -67,31 +65,31 @@ include::modules/telco-hub-networking.adoc[leveloffset=+2]
6765
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/networking/index[Networking in {rh-rhacm}]
6866
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#mce-network-configuration[Network configuration in {rh-rhacm}]
6967
70-
include::modules/telco-hub-memory-and-cpu-requirements.adoc[leveloffset=+2]
68+
include::modules/telco-hub-memory-and-cpu-requirements.adoc[leveloffset=+1]
7169

7270
[role="_additional-resources"]
7371
.Additional resources
7472

7573
* xref:../scalability_and_performance/index.adoc#scalability-and-performance-overview[Scaling your {product-title} cluster and tuning performance in production environments]
7674
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/install/installing#sizing-your-cluster[Sizing your cluster]
7775
78-
include::modules/telco-hub-storage-requirements.adoc[leveloffset=+2]
76+
include::modules/telco-hub-storage-requirements.adoc[leveloffset=+1]
7977

80-
include::modules/telco-hub-assisted-service.adoc[leveloffset=+3]
78+
include::modules/telco-hub-assisted-service.adoc[leveloffset=+2]
8179

8280
[role="_additional-resources"]
8381
.Additional resources
8482

8583
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#enable-cim-disconnected[Enabling central infrastructure management in disconnected environments]
8684
87-
include::modules/telco-hub-acm-observability.adoc[leveloffset=+3]
85+
include::modules/telco-hub-acm-observability.adoc[leveloffset=+2]
8886

89-
include::modules/telco-hub-storage-considerations.adoc[leveloffset=+3]
87+
include::modules/telco-hub-storage-considerations.adoc[leveloffset=+2]
9088

9189
[role="_additional-resources"]
9290
.Additional resources
9391

94-
* link:xref:../storage/understanding-persistent-storage.adoc#persistent-storage-overview_understanding-persistent-storage[Persistent storage overview]
92+
* xref:../storage/understanding-persistent-storage.adoc#persistent-storage-overview_understanding-persistent-storage[Persistent storage overview]
9593
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.18/html/red_hat_openshift_data_foundation_architecture/index[{rh-storage} architecture]
9694
* xref:../storage/persistent_storage/persistent_storage_local/persistent-storage-local.adoc#persistent-storage-using-local-volume[Persistent storage using local volumes]
9795
* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
@@ -140,8 +138,6 @@ include::modules/telco-hub-observability.adoc[leveloffset=+1]
140138
141139
* For more information about CPU and memory requirements see: link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/observability/index#observability-pod-capacity-requests[Observability pod capacity requests]
142140
143-
For more information about custom metrics, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/observability/index#adding-custom-metrics[Adding custom metrics]
144-
145141
* For more information about custom dashboards, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/observability/index#using-grafana-dashboards[Using Grafana dashboards]
146142
147143
include::modules/telco-hub-managed-clusters-lifecycle-management.adoc[leveloffset=+1]
@@ -519,13 +515,4 @@ include::https://raw.githubusercontent.com/openshift-kni/telco-reference/release
519515
include::https://raw.githubusercontent.com/openshift-kni/telco-reference/release-4.19/telco-hub/install/openshift/install-config.yaml[]
520516
----
521517

522-
[id="telco-hub-mirroring-ref-crs_{context}"]
523-
=== Image mirroring reference YAML
524-
525-
[id="telco-hub-imageset-config-yaml"]
526-
.imageset-config.yaml
527-
[source,yaml]
528-
----
529-
include::https://raw.githubusercontent.com/openshift-kni/telco-reference/release-4.19/telco-hub/install/mirror-registry/imageset-config.yaml[]
530-
----
531518
:!telco-hub:

0 commit comments

Comments
 (0)