Merge pull request #69306 from openshift-cherrypick-robot/cherry-pick…

…-62621-to-enterprise-4.14 [enterprise-4.14] TELCODOCS-1004, TELCODOCS-1207 - CNF-6527/CNF-7078 PTP Operator HW plugin + GNSS monitoring/events
openshift · Dec 13, 2023 · cfb0c08 · cfb0c08
2 parents a7d2f93 + 63329b1
commit cfb0c08
Show file tree

Hide file tree

Showing 84 changed files with 794 additions and 339 deletions.
diff --git a/.vale/styles/Vocab/OpenShiftDocs/accept.txt b/.vale/styles/Vocab/OpenShiftDocs/accept.txt
@@ -1,20 +1,29 @@
 # Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
 # Add terms that have a corresponding incorrectly capitalized form to reject.txt.
-
+# URL slugs
+(.*/)+
+(?<!.*-)operator
 [Ff]ronthaul
 [Mm]idhaul
 [Pp]assthrough
+[Pp]ostinstall
+[Pp]reinstall
 [Rr]ealtime
+[Tt]elco
 Assisted Installer
 Control Plane Machine Set Operator
-custom resource
-custom resources
+custom resources?
+gpsd
+gpspipe
+linuxptp
 Mbps
+Mellanox
 MetalLB
+NICs?
 Operator
 Operators
-[Pp]reinstall
-[Pp]ostinstall
-NICs?
-Mellanox
+Operators?
+pmc
+ubxtool
 VFs?
+Westport
diff --git a/.vale/styles/Vocab/OpenShiftDocs/reject.txt b/.vale/styles/Vocab/OpenShiftDocs/reject.txt
@@ -1,6 +1,7 @@
 # Regex terms added to reject.txt are highlighted as errors by the Vale linter and override RedHat Vale rules.
 # Add terms that have a corresponding correctly capitalized form to accept.txt.
 
+(?<!.*-)operators
 [Dd]eployment [Cc]onfigs?
 [Dd]eployment [Cc]onfigurations?
 [Oo]peratorize
@@ -11,5 +12,4 @@ configuration maps?
 MachineSets
 machinesets?
 minions?
-operators?
-SNO
+SNO
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1239,9 +1239,16 @@ Topics:
   File: using-sctp
   Distros: openshift-enterprise,openshift-origin
 - Name: Using PTP hardware
-  File: using-ptp
-- Name: Developing PTP events consumer applications
-  File: ptp-cloud-events-consumer-dev-reference
+  Dir: ptp
+  Topics:
+  - Name: About PTP in OpenShift clusters
+    File: about-ptp
+  - Name: Configuring PTP hardware
+    File: configuring-ptp
+  - Name: Using PTP events
+    File: using-ptp-events
+  - Name: Developing PTP events consumer applications
+    File: ptp-cloud-events-consumer-dev-reference
 - Name: External DNS Operator
   Dir: external_dns_operator
   Topics:

diff --git a/authentication/sd-configuring-identity-providers.adoc b/authentication/sd-configuring-identity-providers.adoc
@@ -1,4 +1,4 @@
-:_content-type: ASSEMBLY
+:_mod-docs-content-type: ASSEMBLY
 [id="sd-configuring-identity-providers"]
 = Configuring identity providers
 include::_attributes/attributes-openshift-dedicated.adoc[]

diff --git a/images/319_OpenShift_PTP_bare-metal_OCP_nodes_1023_PTP.png b/images/319_OpenShift_PTP_bare-metal_OCP_nodes_1023_PTP.png
diff --git a/images/319_OpenShift_PTP_bare-metal_OCP_nodes_1123_PTP_network.png b/images/319_OpenShift_PTP_bare-metal_OCP_nodes_1123_PTP_network.png
diff --git a/modules/cnf-about-collecting-ptp-data.adoc b/modules/cnf-about-collecting-ptp-data.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/configuring-ptp.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-about-collecting-nro-data_{context}"]
-= Collecting Precision Time Protocol (PTP) Operator data
+= Collecting PTP Operator data
 
-You can use the `oc adm must-gather` CLI command to collect information about your cluster, including features and objects associated with Precision Time Protocol (PTP) Operator.
+You can use the `oc adm must-gather` command to collect information about your cluster, including features and objects associated with PTP Operator.
 
 .Prerequisites
 
@@ -23,4 +23,4 @@ You can use the `oc adm must-gather` CLI command to collect information about yo
 [source,terminal,subs="attributes+"]
 ----
 $ oc adm must-gather --image=registry.redhat.io/openshift4/ptp-must-gather-rhel8:v{product-version}
-----
+----
diff --git a/modules/cnf-about-ptp-and-clock-synchronization.adoc b/modules/cnf-about-ptp-and-clock-synchronization.adoc
@@ -1,14 +1,14 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/using-ptp-events.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="cnf-about-ptp-and-clock-synchronization_{context}"]
 = About PTP and clock synchronization error events
 
 Loss of PTP synchronization is a critical error for a RAN network. If synchronization is lost on a node, the radio might be shut down and the network Over the Air (OTA) traffic might be shifted to another node in the wireless network. Fast event notifications mitigate against workload errors by allowing cluster nodes to communicate PTP clock sync status to the vRAN application running in the DU.
 
-Event notifications are available to vRAN applications running on the same DU node. A publish-subscribe REST API passes events notifications to the messaging bus. Publish-subscribe messaging, or pub-sub messaging, is an asynchronous service-to-service communication architecture where any message published to a topic is immediately received by all of the subscribers to the topic.
+Event notifications are available to vRAN applications running on the same DU node. A publish/subscribe REST API passes events notifications to the messaging bus. Publish/subscribe messaging, or pub-sub messaging, is an asynchronous service-to-service communication architecture where any message published to a topic is immediately received by all of the subscribers to the topic.
 
 The PTP Operator generates fast event notifications for every PTP-capable network interface. You can access the events by using a `cloud-event-proxy` sidecar container over an HTTP or Advanced Message Queuing Protocol (AMQP) message bus.
 

diff --git a/modules/cnf-about-ptp-fast-event-notifications-framework.adoc b/modules/cnf-about-ptp-fast-event-notifications-framework.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/using-ptp-events.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="cnf-about-ptp-fast-event-notifications-framework_{context}"]

diff --git a/modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc b/modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/configuring-ptp.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-configuring-fifo-priority-scheduling-for-ptp_{context}"]
 = Configuring FIFO priority scheduling for PTP hardware
 
-In telco or other deployment configurations that require low latency performance, PTP daemon threads run in a constrained CPU footprint alongside the rest of the infrastructure components. By default, PTP threads run with the `SCHED_OTHER` policy. Under high load, these threads might not get the scheduling latency they require for error-free operation.
+In telco or other deployment types that require low latency performance, PTP daemon threads run in a constrained CPU footprint alongside the rest of the infrastructure components. By default, PTP threads run with the `SCHED_OTHER` policy. Under high load, these threads might not get the scheduling latency they require for error-free operation.
 
 To mitigate against potential scheduling latency errors, you can configure the PTP Operator `linuxptp` services to allow threads to run with a `SCHED_FIFO` policy. If `SCHED_FIFO` is set for a `PtpConfig` CR, then `ptp4l` and `phc2sys` will run in the parent container under `chrt` with a priority set by the `ptpSchedulingPriority` field of the `PtpConfig` CR.
 
@@ -76,5 +76,3 @@ $ oc -n openshift-ptp logs linuxptp-daemon-lgm55 -c linuxptp-daemon-container|gr
 ----
 I1216 19:24:57.091872 1600715 daemon.go:285] /bin/chrt -f 65 /usr/sbin/ptp4l -f /var/run/ptp4l.0.config -2  --summary_interval -4 -m
 ----
-
-
diff --git a/modules/cnf-configuring-log-filtering-for-linuxptp.adoc b/modules/cnf-configuring-log-filtering-for-linuxptp.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/configuring-ptp.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-configuring-log-filtering-for-linuxptp_{context}"]
 = Configuring log filtering for linuxptp services
 
-The `linuxptp` daemon generates logs that you can use for debugging purposes. In telco or other deployment configurations that feature a limited storage capacity, these logs can add to the storage demand.
+The `linuxptp` daemon generates logs that you can use for debugging purposes. In telco or other deployment types that feature a limited storage capacity, these logs can add to the storage demand.
 
 To reduce the number log messages, you can configure the `PtpConfig` custom resource (CR) to exclude log messages that report the `master offset` value. The `master offset` log message reports the difference between the current node's clock and the master clock in nanoseconds.
 
@@ -77,4 +77,4 @@ $ oc -n openshift-ptp logs <linux_daemon_container> -c linuxptp-daemon-container
 ----
 <1> <linux_daemon_container> is the name of the `linuxptp-daemon` pod, for example `linuxptp-daemon-gmv2n`.
 +
-When you configure the `logReduce` specification, this command does not report any instances of `master offset` in the logs of the `linuxptp` daemon.
+When you configure the `logReduce` specification, this command does not report any instances of `master offset` in the logs of the `linuxptp` daemon.
diff --git a/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc b/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * networking/using-ptp.adoc
+// * networking/ptp/using-ptp-events.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-configuring-the-ptp-fast-event-publisher_{context}"]