docs/doc/source/system_configuration/kubernetes/instance-specific-considerations-d9d9509c79dd.rst

Instance Specific Considerations

ptp4l

Default global parameters

• tx_timestamp_timeout 20
• summary_interval 6
• clock_servo linreg
• network_transport L2
• time_stamping hardware
• delay_mechanism E2E
• boundary_clock_jbod 1
• uds_address /var/run/ptp4l-<instance name>

Default interface parameters

None

Required user-supplied parameters

domainNumber <number>

Other requirements

An interface with a port must be assigned to the ptp4l instance in order for it to start.

Note

It is recommended to configure one ptp4l instance per . Some designs have a single shared between all the ports on the , while others may have one per port. Refer to the documentation to determine if a has multiple . Configuring a ptp4l instance with multiple interfaces, each with its own results in degraded timing accuracy or other undesirable behaviors. This means that a given ptp4l instance should only be configured with interfaces that are on the same and share a .

phc2sys

Default global parameters

cmdline_opts '-a -r -R 2 -u 600'

Default interface parameters

None

Required user-supplied parameters

domainNumber <number>

This should match with the associated ptp4l instance.

uds_address <path>

This value needs to be the same as the uds_address for the ptp4l instance that phc2sys is tracking.

Other requirements

The cmdline_opts are defaulted to support interaction with ptp4l. If phc2sys is instead being used with ts2phc, this parameter will have to be updated. See ptp-instance-examples-517dce312f56 for more information.

Note

The cmdline_opts parameter overrides all default command line flags for the service. This means that when setting cmdline_opts, the full list of desired flags should be set.

ts2phc

Default global parameters

• ts2phc.pulsewidth 100000000
• leapfile /usr/share/zoneinfo/leap-seconds.list
• cmdline_opts '-s nmea'

Default interface parameters

ts2phc.extts_polarity rising

Required interface parameters

• ts2phc.pin_index = 1
• ts2phc.channel = 1

Required user-supplied parameters

This value is the path to the GNSS serial port that is connected, it will be named differently on each system.

ts2phc.nmea_serialport=/dev/gnss0

Other requirements

An interface with a port must be assigned to the ts2phc instance in order for time to be synced from GNSS to the .

clock

Default global parameters

There are no supported global parameters for clock type.

Default interface parameters

None

Required user-supplied parameters

None

Other requirements

The clock type instance is a special instance used for configuring the control parameters of the Westport Channel, Logan Beach, E825 (GNR-D) and E830 (Connorsville) clock interface parameters.

These parameters can be applied to the interface of a clock instance parameters:

• sma1 input/output
• sma2 input/output
• u.fl1 output
• u.fl2 input
• synce_rclka enabled
• synce_rclkb enabled
• sdp0
  • output - configure SDP0 pin as output and assign to channel 1
• sdp1
  • input - configure SDP1 pin as input and assign to channel 1
• sdp2
  • output - configure SDP2 pin as output and assign to channel 2
• sdp3
  • input - configure SDP3 pin as input and assign to channel 2
• period_sdp0
  • 1pps - enable 1PPS output on SDP0 pin
  • 1khz - enable 1 KHz output on SDP0 pin
  • 10mhz - enable 10 MHz output on SDP0 pin
• period_sdp2
  • 1pps - enable 1PPS output on SDP2 pin
  • 1khz - enable 1 KHz output on SDP2 pin
  • 10mhz - enable 10 MHz output on SDP2 pin
• tspll_cfg:
  • osc_156.25 - use the 156.25 MHz oscillator clock signal as input reference clock for the
  • timeref_156.25 - use the 156.25 MHz clock signal (TIME_REF) as input reference clock for the .
• tx_clk
  • enet - use the 25 MHz oscillator clock signal as reference clock for the port
  • synce - use the 156.25 MHz clock signal as reference clock for the port.
  • eref0 - use the 156.25 MHz oscillator clock signal as reference clock for the port

gnss-monitor

Default global parameters

• satellite_count 5
• signal_quality_db 30
• cmdline_opts ''

Default interface parameters

None

Required user-supplied parameters

devices <space separated gnss devices to be monitored>

Other requirements

gnss-monitor represents an instance of gpsd. cmdline_opts and devices are used on the gpsd service instantiation. Check man gpsd for detail options. -D 7 is used for setting loglevel.

Only one instance of gnss-monitor is allowed per host. Collectd communicates with gpsd to monitor the configured devices and raise/clear alarms based on the configured threshold parameters satellite_count and signal_quality_db.