Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 4 additions & 22 deletions edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Use the following reference information to understand the {sno} configurations r
[role="_additional-resources"]
.Additional resources

* To deploy a single cluster by hand, see xref:../edge_computing/ztp-manual-install.adoc#ztp-manual-install[Manually installing a {sno} cluster with {ztp}].
* xref:../edge_computing/ztp-manual-install.adoc#ztp-manual-install[Manually installing a {sno} cluster with {ztp}]

* To deploy a fleet of clusters using {ztp-first}, see xref:../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-deploying-far-edge-sites[Deploying far edge sites with {ztp}].
* xref:../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-deploying-far-edge-sites[Deploying far edge sites with {ztp}]

include::modules/ztp-low-latency.adoc[leveloffset=+1]

Expand All @@ -30,17 +30,7 @@ include::modules/ztp-enabling-workload-partitioning-sno.adoc[leveloffset=+1]

* xref:../security/network_bound_disk_encryption/nbde-about-disk-encryption-technology.adoc#nbde-tpm-encryption_nbde-implementation[TPM encryption]

[id="ztp-sno-install-time-cluster-config"]
== Recommended cluster install manifests

The ZTP pipeline applies the following custom resources (CRs) during cluster installation. These configuration CRs ensure that the cluster meets the feature and performance requirements necessary for running a vDU application.

[NOTE]
====
When using the {ztp} plugin and `ClusterInstance` CRs for cluster deployment, the following `MachineConfig` CRs are included by default.
====

Use the `ClusterInstance` `extraManifestRefs` to alter the CRs that are included by default. For more information, see xref:../edge_computing/ztp-advanced-install-ztp.adoc#ztp-advanced-install-ztp[Advanced managed cluster configuration with ClusterInstance CRs].
include::modules/ztp-sno-du-recommended-cluster-install-manifests.adoc[leveloffset=+1]

include::modules/ztp-sno-du-configuring-the-container-mountspace.adoc[leveloffset=+2]

Expand All @@ -57,15 +47,7 @@ include::modules/ztp-sno-du-configuring-crun-container-runtime.adoc[leveloffset=
[role="_additional-resources"]
.Additional resources

[id="ztp-sno-post-install-time-cluster-config"]
== Recommended postinstallation cluster configurations

When the cluster installation is complete, the ZTP pipeline applies the following custom resources (CRs) that are required to run DU workloads.

[NOTE]
====
In {ztp} v4.10 and earlier, you configure UEFI secure boot with a `MachineConfig` CR. This is no longer required in {ztp} v4.11 and later. In v4.11, you configure UEFI secure boot for {sno} clusters by updating the `spec.nodes[].bootMode` field in the `ClusterInstance` CR that you use to install the cluster. For more information, see xref:../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-deploying-a-site_ztp-deploying-far-edge-sites[Deploying a managed cluster with ClusterInstance and {ztp}].
====
include::modules/ztp-sno-du-recommended-postinstallation-cluster-configurations.adoc[leveloffset=+1]

include::modules/ztp-sno-du-configuring-the-operators.adoc[leveloffset=+2]

Expand Down
3 changes: 2 additions & 1 deletion modules/ztp-du-host-firmware-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-du-configuring-host-firmware-requirements_{context}"]
= Configuring host firmware for low latency and high performance

[role="_abstract"]
Bare-metal hosts require the firmware to be configured before the host can be provisioned. The firmware configuration is dependent on the specific hardware and the particular requirements of your installation.

.Procedure
Expand Down Expand Up @@ -61,7 +62,7 @@ The exact firmware configuration depends on your specific hardware and network r
|Processor C6
|Disabled
|====

+
[NOTE]
====
Enable global SR-IOV and VT-d settings in the firmware for the host. These settings are relevant to bare-metal environments.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-enabling-workload-partitioning-sno.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-workload-partitioning-sno_{context}"]
= Workload partitioning in {sno} with {ztp}

[role="_abstract"]
Workload partitioning configures {product-title} services, cluster management workloads, and infrastructure pods to run on a reserved number of host CPUs.

To configure workload partitioning with {ztp-first}, you configure a `cpuPartitioningMode` field in the `ClusterInstance` custom resource (CR) that you use to install the cluster and you apply a `PerformanceProfile` CR that configures the `isolated` and `reserved` CPUs on the host.
Expand Down
2 changes: 2 additions & 0 deletions modules/ztp-install-sno-hardware-reqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
//
// * scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc

:_mod-docs-content-type: REFERENCE
[id="ztp-install-sno-hardware-reqs_{context}"]
= Recommended cluster host requirements for vDU application workloads

[role="_abstract"]
Running vDU application workloads requires a bare-metal host with sufficient resources to run {product-title} services and production workloads.

.Minimum resource requirements
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-low-latency.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-low-latency_{context}"]
= Running low latency applications on {product-title}

[role="_abstract"]
{product-title} enables low latency processing for applications running on commercial off-the-shelf (COTS) hardware by using several technologies and specialized hardware devices:

Real-time kernel for RHCOS:: Ensures workloads are handled with a high degree of process determinism.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-managed-cluster-network-prereqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-managed-cluster-network-prereqs_{context}"]
= Connectivity prerequisites for managed cluster networks

[role="_abstract"]
Before you can install and provision a managed cluster with the {ztp-first} pipeline, the managed cluster host must meet the following networking prerequisites:

* There must be bi-directional connectivity between the {ztp} container in the hub cluster and the Baseboard Management Controller (BMC) of the target bare-metal host.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-crun-container-runtime.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-crun-container-runtime_{context}"]
= Configuring crun as the default container runtime

[role="_abstract"]
The following `ContainerRuntimeConfig` custom resources (CRs) configure crun as the default OCI container runtime for control plane and worker nodes.
The crun container runtime is fast and lightweight and has a low memory footprint.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-logging-locally-and-forwarding_{context}"]
= Cluster logging and log forwarding

[role="_abstract"]
{sno-caps} clusters that run DU workloads require logging and log forwarding for debugging.
The following custom resources (CRs) are required.

Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-lvms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="lvms-configuring-lvms-on-sno_{context}"]
= {lvms}

[role="_abstract"]
You can dynamically provision local storage on {sno} clusters with {lvms-first}.

[NOTE]
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-performance-addons.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-performance-addons_{context}"]
= Performance profile

[role="_abstract"]
{sno-caps} clusters that run DU workloads require a Node Tuning Operator performance profile to use real-time host capabilities and services.

[NOTE]
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-ptp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-ptp_{context}"]
= PTP

[role="_abstract"]
{sno-caps} clusters use Precision Time Protocol (PTP) for network time synchronization.
The following example `PtpConfig` CRs illustrate the required PTP configurations for ordinary clocks, boundary clocks, and grandmaster clocks.
The exact configuration you apply will depend on the node hardware and specific use case.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-sriov.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-sriov_{context}"]
= SR-IOV

[role="_abstract"]
Single root I/O virtualization (SR-IOV) is commonly used to enable fronthaul and midhaul networks. The following YAML example configures SR-IOV for a {sno} cluster.

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-the-container-mountspace_{context}"]
= Reduced platform management footprint

[role="_abstract"]
To reduce the overall management footprint of the platform, a `MachineConfig` custom resource (CR) is required that places all Kubernetes-specific mount points in a new namespace separate from the host operating system.
The following base64-encoded example `MachineConfig` CR illustrates this configuration.

Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-the-operators.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-the-operators_{context}"]
= Operators

[role="_abstract"]
{sno-caps} clusters that run DU workloads require the following Operators to be installed:

* Local Storage Operator
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-configuring-time-sync.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-configuring-time-sync_{context}"]
= Configuring cluster time synchronization

[role="_abstract"]
Run a one-time system time synchronization job for control plane or worker nodes.

.Recommended one time time-sync for control plane nodes (`99-sync-time-once-master.yaml`)
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-disabling-crio-wipe.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-disabling-crio-wipe_{context}"]
= Disable automatic CRI-O cache wipe

[role="_abstract"]
After an uncontrolled host shutdown or cluster reboot, CRI-O automatically deletes the entire CRI-O cache, causing all images to be pulled from the registry when the node reboots.
This can result in unacceptably slow recovery times or recovery failures.
To prevent this from happening in {sno} clusters that you install with {ztp}, disable the CRI-O delete cache feature during cluster installation.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-disabling-network-diagnostics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-disabling-network-diagnostics_{context}"]
= Network diagnostics

[role="_abstract"]
{sno-caps} clusters that run DU workloads require less inter-pod network connectivity checks to reduce the additional load created by these pods. The following custom resource (CR) disables these checks.

.Recommended network diagnostics configuration (`DisableSnoNetworkDiag.yaml`)
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-enabling-kdump.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-enabling-kdump_{context}"]
= Automatic kernel crash dumps with kdump

[role="_abstract"]
`kdump` is a Linux kernel feature that creates a kernel crash dump when the kernel crashes. `kdump` is enabled with the following `MachineConfig` CRs.

.Recommended control plane node kdump configuration (`06-kdump-master.yaml`)
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-enabling-sctp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-enabling-sctp_{context}"]
= SCTP

[role="_abstract"]
Stream Control Transmission Protocol (SCTP) is a key protocol used in RAN applications. This `MachineConfig` object adds the SCTP kernel module to the node to enable this protocol.

.Recommended control plane node SCTP configuration (`03-sctp-machine-config-master.yaml`)
Expand Down
17 changes: 17 additions & 0 deletions modules/ztp-sno-du-recommended-cluster-install-manifests.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Module included in the following assemblies:
//
// * edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc

:_mod-docs-content-type: CONCEPT
[id="ztp-sno-install-time-cluster-config_{context}"]
= Recommended cluster install manifests

[role="_abstract"]
The ZTP pipeline applies the following custom resources (CRs) during cluster installation. These configuration CRs ensure that the cluster meets the feature and performance requirements necessary for running a vDU application.

[NOTE]
====
When using the {ztp} plugin and `ClusterInstance` CRs for cluster deployment, the following `MachineConfig` CRs are included by default.
====

Use the `ClusterInstance` `extraManifestRefs` to alter the CRs that are included by default. For more information, see xref:../edge_computing/ztp-advanced-install-ztp.adoc#ztp-advanced-install-ztp[Advanced managed cluster configuration with ClusterInstance CRs].
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc

:_mod-docs-content-type: CONCEPT
[id="ztp-sno-post-install-time-cluster-config_{context}"]
= Recommended postinstallation cluster configurations

[role="_abstract"]
When the cluster installation is complete, the ZTP pipeline applies the following custom resources (CRs) that are required to run DU workloads.

[NOTE]
====
In {ztp} v4.10 and earlier, you configure UEFI secure boot with a `MachineConfig` CR. This is no longer required in {ztp} v4.11 and later. In v4.11, you configure UEFI secure boot for {sno} clusters by updating the `spec.nodes[].bootMode` field in the `ClusterInstance` CR that you use to install the cluster. For more information, see xref:../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-deploying-a-site_ztp-deploying-far-edge-sites[Deploying a managed cluster with ClusterInstance and {ztp}].
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

====
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-reducing-resource-usage-with-cluster-monitoring_{context}"]
= Alertmanager

[role="_abstract"]
{sno-caps} clusters that run DU workloads require reduced CPU resources consumed by the {product-title} monitoring components. The following `ConfigMap` custom resource (CR) disables Alertmanager.

.Recommended cluster monitoring configuration (`ReduceMonitoringFootprint.yaml`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-reducing-resource-usage-with-olm-pprof_{context}"]
= Operator Lifecycle Manager

[role="_abstract"]
{sno-caps} clusters that run distributed unit workloads require consistent access to CPU resources. Operator Lifecycle Manager (OLM) collects performance data from Operators at regular intervals, resulting in an increase in CPU utilisation. The following `ConfigMap` custom resource (CR) disables the collection of Operator performance data by OLM.

.Recommended cluster OLM configuration (`ReduceOLMFootprint.yaml`)
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-removing-the-console-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-removing-the-console-operator_{context}"]
= Console Operator

[role="_abstract"]
Use the cluster capabilities feature to prevent the Console Operator from being installed.
When the node is centrally managed it is not needed.
Removing the Operator provides additional space and capacity for application workloads.
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-setting-rcu-normal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-setting-rcu-normal_{context}"]
= Setting rcu_normal

[role="_abstract"]
The following `MachineConfig` CR configures the system to set `rcu_normal` to 1 after the system has finished startup. This improves kernel latency for vDU applications.

.Recommended configuration for disabling `rcu_expedited` after the node has finished startup (`08-set-rcu-normal-master.yaml`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-subscribing-to-the-operators-needed-for-platform-configuration_{context}"]
= Operator subscriptions

[role="_abstract"]
{sno-caps} clusters that run DU workloads require the following `Subscription` CRs. The subscription provides the location to download the following Operators:

* Local Storage Operator
Expand Down
1 change: 1 addition & 0 deletions modules/ztp-sno-du-tuning-the-performance-patch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ztp-sno-du-tuning-the-performance-patch_{context}"]
= Extended Tuned profile

[role="_abstract"]
{sno-caps} clusters that run DU workloads require additional performance tuning configurations necessary for high-performance workloads. The following example `Tuned` CR extends the `Tuned` profile:

.Recommended extended `Tuned` profile configuration (`TunedPerformancePatch.yaml`)
Expand Down