8.4. Configuring Linuxptp services

Procedure

1. Create the following PtpConfig CR, and then save the YAML in the <name>-ptp-config.yaml file. Replace <name> with the name for this configuration.

   apiVersion: ptp.openshift.io/v1
   kind: PtpConfig
   metadata:
     name: <name> 

   1

   
     namespace: openshift-ptp 

   2

   
   spec:
     profile: 

   3

   
     - name: "profile1" 

   4

   
       interface: "ens787f1" 

   5

   
       ptp4lOpts: "-s -2" 

   6

   
       phc2sysOpts: "-a -r" 

   7

   
     recommend: 

   8

   
     - profile: "profile1" 

   9

   
       priority: 10 

   10

   
       match: 

   11

   
       - nodeLabel: "node-role.kubernetes.io/worker" 

   12

   
         nodeName: "dev-worker-0" 

   13

   Copy to Clipboard Toggle word wrap

   1

   Specify a name for the PtpConfig CR.

   2

   Specify the namespace where the PTP Operator is installed.

   3

   Specify an array of one or more profile objects.

   4

   Specify the name of a profile object which is used to uniquely identify a profile object.

   5

   Specify the network interface name to use by the ptp4l service, for example ens787f1.

   6

   Specify system config options for the ptp4l service, for example -s -2. This should not include the interface name -i <interface> and service config file -f /etc/ptp4l.conf because these will be automatically appended.

   7

   Specify system config options for the phc2sys service, for example -a -r.

   8

   Specify an array of one or more recommend objects which define rules on how the profile should be applied to nodes.

   9

   Specify the profile object name defined in the profile section.

   10

   Specify the priority with an integer value between 0 and 99. A larger number gets lower priority, so a priority of 99 is lower than a priority of 10. If a node can be matched with multiple profiles according to rules defined in the match field, the profile with the higher priority will be applied to that node.

   11

   Specify match rules with nodeLabel or nodeName.

   12

   Specify nodeLabel with the key of node.Labels from the node object.

   13

   Specify nodeName with node.Name from the node object.

2. Create the CR by running the following command:

   $ oc create -f <filename> 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <filename> with the name of the file you created in the previous step.

3. Optional: Check that the PtpConfig profile is applied to nodes that match with nodeLabel or nodeName.

   $ oc get pods -n openshift-ptp -o wide

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                            READY   STATUS    RESTARTS   AGE   IP               NODE           NOMINATED NODE   READINESS GATES
   linuxptp-daemon-4xkbb           1/1     Running   0          43m   192.168.111.15   dev-worker-0   <none>           <none>
   linuxptp-daemon-tdspf           1/1     Running   0          43m   192.168.111.11   dev-master-0   <none>           <none>
   ptp-operator-657bbb64c8-2f8sj   1/1     Running   0          43m   10.128.0.116     dev-master-0   <none>           <none>
   
   $ oc logs linuxptp-daemon-4xkbb -n openshift-ptp
   I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile
   I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to:
   I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------
   I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: profile1 

   1

   
   I1115 09:41:17.117616 4143292 daemon.go:102] Interface: ens787f1    

   2

   
   I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -s -2       

   3

   
   I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r     

   4

   
   I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------
   I1115 09:41:18.117934 4143292 daemon.go:186] Starting phc2sys...
   I1115 09:41:18.117985 4143292 daemon.go:187] phc2sys cmd: &{Path:/usr/sbin/phc2sys Args:[/usr/sbin/phc2sys -a -r] Env:[] Dir: Stdin:<nil> Stdout:<nil> Stderr:<nil> ExtraFiles:[] SysProcAttr:<nil> Process:<nil> ProcessState:<nil> ctx:<nil> lookPathErr:<nil> finished:false childFiles:[] closeAfterStart:[] closeAfterWait:[] goroutine:[] errch:<nil> waitDone:<nil>}
   I1115 09:41:19.118175 4143292 daemon.go:186] Starting ptp4l...
   I1115 09:41:19.118209 4143292 daemon.go:187] ptp4l cmd: &{Path:/usr/sbin/ptp4l Args:[/usr/sbin/ptp4l -m -f /etc/ptp4l.conf -i ens787f1 -s -2] Env:[] Dir: Stdin:<nil> Stdout:<nil> Stderr:<nil> ExtraFiles:[] SysProcAttr:<nil> Process:<nil> ProcessState:<nil> ctx:<nil> lookPathErr:<nil> finished:false childFiles:[] closeAfterStart:[] closeAfterWait:[] goroutine:[] errch:<nil> waitDone:<nil>}
   ptp4l[102189.864]: selected /dev/ptp5 as PTP clock
   ptp4l[102189.886]: port 1: INITIALIZING to LISTENING on INIT_COMPLETE
   ptp4l[102189.886]: port 0: INITIALIZING to LISTENING on INIT_COMPLETE

   Copy to Clipboard Toggle word wrap

   1

   Profile Name is the name that is applied to node dev-worker-0.

   2

   Interface is the PTP device specified in the profile1 interface field. The ptp4l service runs on this interface.

   3

   Ptp4lOpts are the ptp4l sysconfig options specified in profile1 Ptp4lOpts field.

   4

   Phc2sysOpts are the phc2sys sysconfig options specified in profile1 Phc2sysOpts field.