Skip to content

Commit 46e65d1

Browse files
committed
Adding clarifications for PTP HA docs
1 parent 43720ab commit 46e65d1

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Create two `PtpConfig` custom resource (CR) objects that configure the NICs as T
1616

1717
[IMPORTANT]
1818
====
19-
When you create the `PtpConfig` CRs, ensure that the `phc2sysOpts` field is an empty string to prevent setting up the `phc2sys` processes on these two profiles.
19+
You set `phc2SysOpts` options once in the `PtpConfig` CR that configures HA.
20+
Set the `phc2sysOpts` field to an empty string in the `PtpConfig` CRs that configure the two NICs.
21+
This prevents individual `phc2sys` processes from being set up for the two profiles.
2022
====
2123

2224
The third `PtpConfig` CR configures a highly available system clock service.
@@ -25,6 +27,11 @@ The CR adds profiles for the `ptp4l` configurations under the `spec.profile.ptpS
2527
When a `ptp4l` failure occurs, the `phc2sys` service switches to the backup `ptp4l` configuration.
2628
When the primary profile becomes active again, the `phc2sys` service reverts to the original state.
2729

30+
[IMPORTANT]
31+
====
32+
Ensure that you set `spec.recommend.priority` to the same value for all three `PtpConfig` CRs that you use to configure HA.
33+
====
34+
2835
.Prerequisites
2936

3037
* Install the {oc-first}.
@@ -105,12 +112,17 @@ $ oc create -f ha-ptp-config-nic2.yaml
105112
. Create the `PtpConfig` CR that configures the HA system clock.
106113
For example:
107114

108-
.. Create the `ptp-config-for-ha.yaml` file:
115+
.. Create the `ptp-config-for-ha.yaml` file.
116+
Set `haProfiles` to match the `metadata.name` fields that are set in the `PtpConfig` CRs that configure the two NICs.
117+
For example: `haProfiles: ha-ptp-config-nic1,ha-ptp-config-nic2`
109118
+
110119
[source,yaml]
111120
----
112121
include::snippets/ztp_PtpConfigForHA.yaml[]
113122
----
123+
<1> Set the `ptp4lOpts` field to an empty string.
124+
If it is not empty, the `p4ptl` process starts with a critical error.
125+
114126
+
115127
[IMPORTANT]
116128
====

snippets/ztp_PtpConfigForHA.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
spec:
88
profile:
99
- name: "boundary-ha"
10-
ptp4lOpts: ""
10+
ptp4lOpts: "" # <1>
1111
phc2sysOpts: "-a -r -n 24"
1212
ptpSchedulingPolicy: SCHED_FIFO
1313
ptpSchedulingPriority: 10

0 commit comments

Comments
 (0)