Back to Talos

TimeSyncConfig

website/content/v1.13/reference/configuration/network/timesyncconfig.md

1.13.02.2 KB
Original Source
<!-- markdownlint-disable -->

{{< highlight yaml >}} apiVersion: v1alpha1 kind: TimeSyncConfig

Specifies NTP configuration to sync the time over network.

ntp: # Specifies time (NTP) servers to use for setting the system time. servers: - pool.ntp.org {{< /highlight >}}

{{< highlight yaml >}} apiVersion: v1alpha1 kind: TimeSyncConfig

Specific PTP (Precision Time Protocol) configuration to sync the time over PTP devices.

ptp: # description: | devices: - /dev/ptp0 {{< /highlight >}}

FieldTypeDescriptionValue(s)
enabledboolIndicates if the time synchronization is enabled for the machine.
Defaults to true.
bootTimeoutDurationSpecifies the timeout when the node time is considered to be in sync unlocking the boot sequence.
NTP sync will be still running in the background.
Defaults to "infinity" (waiting forever for time sync)
ntp<a href="#TimeSyncConfig.ntp">NTPConfig</a>Specifies NTP configuration to sync the time over network.
Mutually exclusive with PTP configuration.
ptp<a href="#TimeSyncConfig.ptp">PTPConfig</a>Specific PTP (Precision Time Protocol) configuration to sync the time over PTP devices.
Mutually exclusive with NTP configuration.

ntp {#TimeSyncConfig.ntp}

NTPConfig represents a NTP server configuration.

FieldTypeDescriptionValue(s)
servers[]stringSpecifies time (NTP) servers to use for setting the system time.
Defaults to time.cloudflare.com.

ptp {#TimeSyncConfig.ptp}

PTPConfig represents a PTP (Precision Time Protocol) configuration.

FieldTypeDescriptionValue(s)
devices[]stringdescription:
A list of PTP devices to sync with (e.g. provided by the hypervisor).

A PTP device is typically represented as a character device file in the /dev directory,

such as /dev/ptp0 or /dev/ptp_kvm. These devices are used to synchronize the system time with an external time source that supports the Precision Time Protocol. | |