From c7293c82bf8428164a4458eb6c83aa96f557d22b Mon Sep 17 00:00:00 2001 From: Shane Lovern Date: Tue, 18 Feb 2025 17:18:23 +0000 Subject: [PATCH] TELCODOCS-2107 - CNF-13189 - Remove the internal API and sidecar support --- _topic_maps/_topic_map.yml | 4 -- ...f-about-ptp-and-clock-synchronization.adoc | 4 +- ...tp-fast-event-notifications-framework.adoc | 4 +- ...figuring-the-ptp-fast-event-publisher.adoc | 5 -- networking/ptp/configuring-ptp.adoc | 6 +- ...p-cloud-events-consumer-dev-reference.adoc | 58 ------------------- .../ptp/ptp-events-rest-api-reference.adoc | 34 ----------- snippets/ptp-event-config-api-v2.adoc | 7 +-- 8 files changed, 9 insertions(+), 113 deletions(-) delete mode 100644 networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc delete mode 100644 networking/ptp/ptp-events-rest-api-reference.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index d527f2f74d..7899713c1f 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1517,10 +1517,6 @@ Topics: File: ptp-cloud-events-consumer-dev-reference-v2 - Name: PTP events REST API v2 reference File: ptp-events-rest-api-reference-v2 - - Name: Developing PTP events consumer applications with the REST API v1 - File: ptp-cloud-events-consumer-dev-reference - - Name: PTP events REST API v1 reference - File: ptp-events-rest-api-reference - Name: CIDR range definitions File: cidr-range-definitions - Name: Multiple networks diff --git a/modules/cnf-about-ptp-and-clock-synchronization.adoc b/modules/cnf-about-ptp-and-clock-synchronization.adoc index 10e0561a2c..51b2f195a4 100644 --- a/modules/cnf-about-ptp-and-clock-synchronization.adoc +++ b/modules/cnf-about-ptp-and-clock-synchronization.adoc @@ -3,6 +3,7 @@ // * networking/ptp/about-ptp.adoc :_mod-docs-content-type: CONCEPT +:ptp-events-rest-api: v2 [id="cnf-about-ptp-and-clock-synchronization_{context}"] = About PTP and clock synchronization error events @@ -17,7 +18,8 @@ Event notifications are available to vRAN applications running on the same DU no 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 message bus. +The PTP Operator generates fast event notifications for every PTP-capable network interface. +The consumer application can subscribe to PTP events by using the PTP events REST API {ptp-events-rest-api}. [NOTE] ==== diff --git a/modules/cnf-about-ptp-fast-event-notifications-framework.adoc b/modules/cnf-about-ptp-fast-event-notifications-framework.adoc index 1d8c4fc48c..8e6cebef1d 100644 --- a/modules/cnf-about-ptp-fast-event-notifications-framework.adoc +++ b/modules/cnf-about-ptp-fast-event-notifications-framework.adoc @@ -11,7 +11,5 @@ Use the Precision Time Protocol (PTP) fast event REST API v2 to subscribe cluste [NOTE] ==== -The fast events notifications framework uses a REST API for communication. The PTP events REST API v1 and v2 are based on the _O-RAN O-Cloud Notification API Specification for Event Consumers 3.0_ that is available from link:https://orandownloadsweb.azurewebsites.net/specifications[O-RAN ALLIANCE Specifications]. - -Only the PTP events REST API v2 is O-RAN v3 compliant. +The fast events notifications framework uses a REST API for communication. The PTP events REST API v2 is based on the _O-RAN O-Cloud Notification API Specification for Event Consumers 3.0_ that is available from link:https://orandownloadsweb.azurewebsites.net/specifications[O-RAN ALLIANCE Specifications]. ==== diff --git a/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc b/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc index 35be5e1d50..967ff1fe39 100644 --- a/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc +++ b/modules/cnf-configuring-the-ptp-fast-event-publisher.adoc @@ -29,11 +29,6 @@ endif::[] ifeval::["{ptp-events-rest-api}" == "v2"] include::snippets/ptp-event-config-api-v2.adoc[] endif::[] -+ -[NOTE] -==== -In {product-title} 4.13 or later, you do not need to set the `spec.ptpEventConfig.transportHost` field in the `PtpOperatorConfig` resource when you use HTTP transport for PTP events. -==== .. Update the `PtpOperatorConfig` CR: + diff --git a/networking/ptp/configuring-ptp.adoc b/networking/ptp/configuring-ptp.adoc index 2bf457efda..de8b960e4e 100644 --- a/networking/ptp/configuring-ptp.adoc +++ b/networking/ptp/configuring-ptp.adoc @@ -30,7 +30,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual- [role="_additional-resources"] .Additional resources -* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] +* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference-v2.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] include::modules/nw-ptp-grandmaster-clock-configuration-reference.adoc[leveloffset=+2] @@ -56,7 +56,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-boundary-clock.adoc[lev * xref:../../networking/ptp/configuring-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp[Configuring FIFO priority scheduling for PTP hardware] -* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] +* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference-v2.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] include::modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc[leveloffset=+2] @@ -69,7 +69,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc[lev * xref:../../networking/ptp/configuring-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp[Configuring FIFO priority scheduling for PTP hardware] -* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] +* xref:../../networking/ptp/ptp-cloud-events-consumer-dev-reference-v2.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher] include::modules/nw-columbiaville-ptp-config-refererence.adoc[leveloffset=+2] diff --git a/networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc b/networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc deleted file mode 100644 index a429a3f3e2..0000000000 --- a/networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc +++ /dev/null @@ -1,58 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -:ptp-events-rest-api: v1 -[id="ptp-cloud-events-consumer-dev-reference-{ptp-events-rest-api}"] -= Developing PTP events consumer applications with the REST API {ptp-events-rest-api} -include::_attributes/common-attributes.adoc[] -:context: ptp-consumer - -toc::[] - -When developing consumer applications that make use of Precision Time Protocol (PTP) events on a bare-metal cluster node, you deploy your consumer application in a separate application pod. -The consumer application subscribes to PTP events by using the PTP events REST API {ptp-events-rest-api}. - -[NOTE] -==== -The following information provides general guidance for developing consumer applications that use PTP events. -A complete events consumer application example is outside the scope of this information. -==== - -:FeatureName: PTP events REST API v1 and events consumer application sidecar -include::snippets/deprecated-feature.adoc[] - -[role="_additional-resources"] -.Additional resources - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#ptp-events-rest-api-reference[PTP events REST API v1 reference] - -include::modules/cnf-about-ptp-fast-event-notifications-framework.adoc[leveloffset=+1] - -include::modules/cnf-about-ptp-events-consumer-sidecar-and-http-transport.adoc[leveloffset=+1] - -include::modules/cnf-configuring-the-ptp-fast-event-publisher.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* For a complete example CR that configures `linuxptp` services as an ordinary clock with PTP fast events, see xref:../../networking/ptp/configuring-ptp.adoc#configuring-linuxptp-services-as-ordinary-clock_configuring-ptp[Configuring linuxptp services as ordinary clock]. - -include::modules/ptp-events-consumer-application.adoc[leveloffset=+1] - -include::modules/ptp-reference-deployment-and-service-crs.adoc[leveloffset=+1] - -include::modules/ptp-subscribing-consumer-app-to-events.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#api-ocloud-notifications-v1-subscriptions_using-ptp-hardware-fast-events-framework-v1[api/ocloudNotifications/v1/subscriptions] - -include::modules/ptp-verifying-events-consumer-app-is-receiving-events.adoc[leveloffset=+1] - -include::modules/cnf-monitoring-fast-events-metrics.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc#accessing-metrics-as-a-developer[Accessing metrics as a developer] - -include::modules/nw-ptp-operator-metrics-reference.adoc[leveloffset=+1] diff --git a/networking/ptp/ptp-events-rest-api-reference.adoc b/networking/ptp/ptp-events-rest-api-reference.adoc deleted file mode 100644 index ca2f40c6b6..0000000000 --- a/networking/ptp/ptp-events-rest-api-reference.adoc +++ /dev/null @@ -1,34 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="ptp-events-rest-api-reference"] -= PTP events REST API v1 reference -include::_attributes/common-attributes.adoc[] -:context: using-ptp-hardware-fast-events-framework-v1 - -toc::[] - -Use the following Precision Time Protocol (PTP) fast event REST API v1 endpoints to subscribe the `cloud-event-consumer` application to PTP events posted by the `cloud-event-proxy` container at [x-]`http://localhost:8089/api/ocloudNotifications/v1/` in the application pod. - -:FeatureName: PTP events REST API v1 and events consumer application sidecar -include::snippets/deprecated-feature.adoc[] - -The following API endpoints are available: - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#api-ocloud-notifications-v1-subscriptions_{context}[`api/ocloudNotifications/v1/subscriptions`] -** `POST`: Creates a new subscription -** `GET`: Retrieves a list of subscriptions -** `DELETE`: Deletes all subscriptions - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#api-ocloud-notifications-v1-subscriptions-subscription_id_{context}[`api/ocloudNotifications/v1/subscriptions/{subscription_id}`] -** `GET`: Returns details for the specified subscription ID -** `DELETE`: Deletes the subscription associated with the specified subscription ID - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#api-ocloudnotifications-v1-health_{context}[`api/ocloudNotifications/v1/health`] -** `GET`: Returns the health status of `ocloudNotifications` API - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#api-ocloudnotifications-v1-publishers_{context}[`api/ocloudNotifications/v1/publishers`] -** `GET`: Returns a list of PTP event publishers for the cluster node - -* xref:../../networking/ptp/ptp-events-rest-api-reference.adoc#resource-address-current-state_{context}[`api/ocloudnotifications/v1/{resource_address}/CurrentState`] -** `GET`: Returns the current state of one the following event types: `sync-state`, `os-clock-sync-state`, `clock-class`, `lock-state`, or `gnss-sync-status` events - -include::modules/cnf-fast-event-notifications-api-reference.adoc[leveloffset=+1] diff --git a/snippets/ptp-event-config-api-v2.adoc b/snippets/ptp-event-config-api-v2.adoc index 0262852f7b..c7e6acdc24 100644 --- a/snippets/ptp-event-config-api-v2.adoc +++ b/snippets/ptp-event-config-api-v2.adoc @@ -10,9 +10,6 @@ spec: daemonNodeSelector: node-role.kubernetes.io/worker: "" ptpEventConfig: - apiVersion: "2.0" <1> - enableEventPublisher: true <2> + enableEventPublisher: true <1> ---- -<1> Enable the PTP events REST API v2 for the PTP event producer by setting the `ptpEventConfig.apiVersion` to "2.0". -The default value is "1.0". -<2> Enable PTP fast event notifications by setting `enableEventPublisher` to `true`. +<1> Enable PTP fast event notifications by setting `enableEventPublisher` to `true`.