Skip to content

Commit e0f7a9b

Browse files
committed
OSDOCS-5749: Rearchitecture based on PerfScale content audit
1 parent 0e8b8b8 commit e0f7a9b

File tree

51 files changed

+194
-180
lines changed

Some content is hidden

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

51 files changed

+194
-180
lines changed

_topic_maps/_topic_map.yml

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2594,7 +2594,17 @@ Dir: scalability_and_performance
25942594
Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu
25952595
Topics:
25962596
- Name: Recommended performance and scalability practices
2597-
File: recommended-host-practices
2597+
Dir: recommended-performance-scale-practices
2598+
Distros: openshift-origin,openshift-enterprise
2599+
Topics:
2600+
- Name: Recommended control plane practices
2601+
File: recommended-control-plane-practices
2602+
- Name: Recommended infrastructure practices
2603+
File: recommended-infrastructure-practices
2604+
- Name: Recommended etcd practices
2605+
File: recommended-etcd-practices
2606+
- Name: Planning your environment according to object maximums
2607+
File: planning-your-environment-according-to-object-maximums
25982608
Distros: openshift-origin,openshift-enterprise
25992609
- Name: Recommended host practices for IBM zSystems & IBM LinuxONE environments
26002610
File: ibm-z-recommended-host-practices
@@ -2608,23 +2618,18 @@ Topics:
26082618
- Name: Scheduling NUMA-aware workloads
26092619
File: cnf-numa-aware-scheduling
26102620
Distros: openshift-origin,openshift-enterprise
2611-
- Name: Scaling the Cluster Monitoring Operator
2612-
File: scaling-cluster-monitoring-operator
2621+
- Name: Scalability and performance optimization
2622+
Dir: optimization
26132623
Distros: openshift-origin,openshift-enterprise
2614-
- Name: Planning your environment according to object maximums
2615-
File: planning-your-environment-according-to-object-maximums
2616-
Distros: openshift-origin,openshift-enterprise
2617-
- Name: Optimizing storage
2618-
File: optimizing-storage
2619-
Distros: openshift-origin,openshift-enterprise
2620-
- Name: Optimizing routing
2621-
File: routing-optimization
2622-
Distros: openshift-origin,openshift-enterprise
2623-
- Name: Optimizing networking
2624-
File: optimizing-networking
2625-
Distros: openshift-origin,openshift-enterprise
2626-
- Name: Optimizing CPU usage
2627-
File: optimizing-cpu-usage
2624+
Topics:
2625+
- Name: Optimizing storage
2626+
File: optimizing-storage
2627+
- Name: Optimizing routing
2628+
File: routing-optimization
2629+
- Name: Optimizing networking
2630+
File: optimizing-networking
2631+
- Name: Optimizing CPU usage
2632+
File: optimizing-cpu-usage
26282633
- Name: Managing bare metal hosts
26292634
File: managing-bare-metal-hosts
26302635
Distros: openshift-origin,openshift-enterprise

architecture/control-plane.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ include::modules/etcd-overview.adoc[leveloffset=+1]
5656

5757
[role="_additional-resources"]
5858
.Additional resources
59-
* xref:../scalability_and_performance/recommended-host-practices.adoc#recommended-etcd-practices_recommended-host-practices[Recommended etcd practices]
59+
* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
6060
* xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd[Backing up etcd]
6161
6262
include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
@@ -72,4 +72,4 @@ include::modules/hosted-control-planes-version-support.adoc[leveloffset=+2]
7272

7373
[role="_additional-resources"]
7474
.Additional resources
75-
* For more information about the `HostedCluster` and `NodePool` resources, see the link:https://hypershift-docs.netlify.app/reference/api/[HyperShift API Reference].
75+
* For more information about the `HostedCluster` and `NodePool` resources, see the link:https://hypershift-docs.netlify.app/reference/api/[HyperShift API Reference].

getting_started/openshift-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
102102

103103
* **xref:../applications/pruning-objects.adoc#pruning-objects[Prune and reclaim resources]**: Reclaim space by pruning unneeded Operators, groups, deployments, builds, images, registries, and cron jobs.
104104

105-
* **xref:../scalability_and_performance/scaling-cluster-monitoring-operator.adoc#scaling-cluster-monitoring-operator[Scale] and xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[tune] clusters**: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment.
105+
* **xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#scaling-cluster-monitoring-operator[Scale] and xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[tune] clusters**: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment.
106106

107107
* **xref:../updating/updating-restricted-network-cluster/restricted-network-update-osus.adoc#update-service-overview_updating-restricted-network-cluster-osus[Understanding the OpenShift Update Service]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in disconnected environments.
108108

getting_started/openshift-web-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ include::modules/getting-started-web-console-examining-pod.adoc[leveloffset=+2]
4646
include::modules/getting-started-web-console-scaling-app.adoc[leveloffset=+2]
4747
[role="_additional-resources"]
4848
.Additional resources
49-
* xref:../scalability_and_performance/recommended-host-practices.adoc#recommended-scale-practices_cluster-scaling[Recommended practices for scaling the cluster]
49+
* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#recommended-scale-practices_cluster-scaling[Recommended practices for scaling the cluster]
5050
* xref:../nodes/pods/nodes-pods-autoscaling.adoc#nodes-pods-autoscaling-about_nodes-pods-autoscaling[Understanding horizontal pod autoscalers]
5151
* xref:../nodes/pods/nodes-pods-vertical-autoscaler.adoc#nodes-pods-vertical-autoscaler-about_nodes-pods-vertical-autoscaler[About the Vertical Pod Autoscaler Operator]
5252

installing/installing_azure/installing-azure-account.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::modules/installation-azure-limits.adoc[leveloffset=+1]
2323
[role="_additional-resources"]
2424
.Additional resources
2525

26-
* xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
26+
* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
2727
2828
include::modules/installation-azure-network-config.adoc[leveloffset=+1]
2929

@@ -49,4 +49,4 @@ include::modules/installation-azure-regions.adoc[leveloffset=+1]
4949
* Install an {product-title} cluster on Azure. You can
5050
xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[install a customized cluster]
5151
or
52-
xref:../../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[quickly install a cluster] with default options.
52+
xref:../../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[quickly install a cluster] with default options.

installing/installing_azure/installing-azure-user-infra.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ include::modules/installation-azure-limits.adoc[leveloffset=+2]
4747
[role="_additional-resources"]
4848
.Additional resources
4949

50-
* xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
50+
* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]
5151

5252
include::modules/installation-azure-network-config.adoc[leveloffset=+2]
5353

installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ include::modules/installation-azure-limits.adoc[leveloffset=+1]
1818
[role="_additional-resources"]
1919
.Additional resources
2020

21-
* xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
21+
* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
2222
2323
include::modules/installation-azure-stack-hub-network-config.adoc[leveloffset=+1]
2424

installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ include::modules/installation-azure-limits.adoc[leveloffset=+2]
4646
[role="_additional-resources"]
4747
.Additional resources
4848

49-
* xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
49+
* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
5050

5151
include::modules/installation-azure-stack-hub-network-config.adoc[leveloffset=+2]
5252

installing/installing_openstack/installing-openstack-installer-custom.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In {product-title} version {product-version}, you can install a customized clust
1414
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1515
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
1616
* You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix].
17-
* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
17+
* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
1818
* You have the metadata service enabled in {rh-openstack}.
1919

2020
include::modules/installation-osp-default-deployment.adoc[leveloffset=+1]

installing/installing_openstack/installing-openstack-installer-kuryr.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In {product-title} version {product-version}, you can install a customized clust
1717
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1818
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
1919
* You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix].
20-
* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
20+
* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage].
2121

2222
include::modules/installation-osp-about-kuryr.adoc[leveloffset=+1]
2323
include::modules/installation-osp-default-kuryr-deployment.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)