Skip to content

Commit 371e041

Browse files
authored
Merge pull request openshift#88823 from slovern/TELCODOCS-2107
TELCODOCS-2107 - CNF-13189 - Remove the internal API and sidecar support
2 parents d7cd95e + f95a25f commit 371e041

8 files changed

+9
-113
lines changed

_topic_maps/_topic_map.yml

-4
Original file line numberDiff line numberDiff line change
@@ -1518,10 +1518,6 @@ Topics:
15181518
File: ptp-cloud-events-consumer-dev-reference-v2
15191519
- Name: PTP events REST API v2 reference
15201520
File: ptp-events-rest-api-reference-v2
1521-
- Name: Developing PTP events consumer applications with the REST API v1
1522-
File: ptp-cloud-events-consumer-dev-reference
1523-
- Name: PTP events REST API v1 reference
1524-
File: ptp-events-rest-api-reference
15251521
- Name: CIDR range definitions
15261522
File: cidr-range-definitions
15271523
- Name: Multiple networks

modules/cnf-about-ptp-and-clock-synchronization.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// * networking/ptp/about-ptp.adoc
44

55
:_mod-docs-content-type: CONCEPT
6+
:ptp-events-rest-api: v2
67
[id="cnf-about-ptp-and-clock-synchronization_{context}"]
78
= About PTP and clock synchronization error events
89

@@ -17,7 +18,8 @@ Event notifications are available to vRAN applications running on the same DU no
1718
A publish/subscribe REST API passes events notifications to the messaging bus.
1819
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.
1920

20-
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.
21+
The PTP Operator generates fast event notifications for every PTP-capable network interface.
22+
The consumer application can subscribe to PTP events by using the PTP events REST API {ptp-events-rest-api}.
2123

2224
[NOTE]
2325
====

modules/cnf-about-ptp-fast-event-notifications-framework.adoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,5 @@ Use the Precision Time Protocol (PTP) fast event REST API v2 to subscribe cluste
1111
1212
[NOTE]
1313
====
14-
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].
15-
16-
Only the PTP events REST API v2 is O-RAN v3 compliant.
14+
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].
1715
====

modules/cnf-configuring-the-ptp-fast-event-publisher.adoc

-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ endif::[]
2929
ifeval::["{ptp-events-rest-api}" == "v2"]
3030
include::snippets/ptp-event-config-api-v2.adoc[]
3131
endif::[]
32-
+
33-
[NOTE]
34-
====
35-
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.
36-
====
3732
3833
.. Update the `PtpOperatorConfig` CR:
3934
+

networking/ptp/configuring-ptp.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual-
3030
[role="_additional-resources"]
3131
.Additional resources
3232

33-
* 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]
33+
* 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]
3434
3535
include::modules/nw-ptp-grandmaster-clock-configuration-reference.adoc[leveloffset=+2]
3636

@@ -56,7 +56,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-boundary-clock.adoc[lev
5656

5757
* xref:../../networking/ptp/configuring-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp[Configuring FIFO priority scheduling for PTP hardware]
5858
59-
* 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]
59+
* 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]
6060
6161
include::modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc[leveloffset=+2]
6262

@@ -69,7 +69,7 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc[lev
6969

7070
* xref:../../networking/ptp/configuring-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp[Configuring FIFO priority scheduling for PTP hardware]
7171
72-
* 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]
72+
* 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]
7373
7474
include::modules/nw-columbiaville-ptp-config-refererence.adoc[leveloffset=+2]
7575

networking/ptp/ptp-cloud-events-consumer-dev-reference.adoc

-58
This file was deleted.

networking/ptp/ptp-events-rest-api-reference.adoc

-34
This file was deleted.

snippets/ptp-event-config-api-v2.adoc

+2-5
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ spec:
1010
daemonNodeSelector:
1111
node-role.kubernetes.io/worker: ""
1212
ptpEventConfig:
13-
apiVersion: "2.0" <1>
14-
enableEventPublisher: true <2>
13+
enableEventPublisher: true <1>
1514
----
16-
<1> Enable the PTP events REST API v2 for the PTP event producer by setting the `ptpEventConfig.apiVersion` to "2.0".
17-
The default value is "1.0".
18-
<2> Enable PTP fast event notifications by setting `enableEventPublisher` to `true`.
15+
<1> Enable PTP fast event notifications by setting `enableEventPublisher` to `true`.

0 commit comments

Comments
 (0)