Skip to content

Commit d7812d9

Browse files
committed
TELCODOCS-1340 documenting ptp must-gather
1 parent a6fe077 commit d7812d9

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/using-ptp.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="cnf-about-collecting-nro-data_{context}"]
7+
= Collecting Precision Time Protocol (PTP) Operator data
8+
9+
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.
10+
11+
.Prerequisites
12+
13+
* You have access to the cluster as a user with the `cluster-admin` role.
14+
15+
* You have installed the {oc-first}.
16+
17+
* You have installed the PTP Operator.
18+
19+
.Procedure
20+
21+
* To collect PTP Operator data with `must-gather`, you must specify the PTP Operator `must-gather` image.
22+
+
23+
[source,terminal,subs="attributes+"]
24+
----
25+
$ oc adm must-gather --image=registry.redhat.io/openshift4/ptp-must-gather-rhel8:v{product-version}
26+
----

modules/gathering-data-specific-features.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ endif::openshift-dedicated[]
6666
|`registry.redhat.io/numaresources/numaresources-must-gather-rhel9:v<installed-version-nro>`
6767
|Data collection for the NUMA Resources Operator (NRO).
6868

69+
|`registry.redhat.io/openshift4/ptp-must-gather-rhel8:v<installed-version-ptp>`
70+
|Data collection for the PTP Operator.
71+
6972
|`registry.redhat.io/workload-availability/node-maintenance-must-gather-rhel8:v<installed-version-NMO>`
7073
|Data collection for the Node Maintenance Operator (NMO).
7174

networking/using-ptp.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ include::modules/cnf-configuring-log-filtering-for-linuxptp.adoc[leveloffset=+2]
8989

9090
include::modules/cnf-troubleshooting-common-ptp-operator-issues.adoc[leveloffset=+1]
9191

92+
include::modules/cnf-about-collecting-ptp-data.adoc[leveloffset=+2]
93+
9294
== PTP hardware fast event notifications framework
9395

9496
Cloud native applications such as virtual RAN (vRAN) require access to notifications about hardware timing events that are critical to the functioning of the overall network.

0 commit comments

Comments
 (0)