> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> TimeSyncConfig is a config document to configure time synchronization (NTP).

# TimeSyncConfig

```yaml theme={null}
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
```

```yaml theme={null}
apiVersion: v1alpha1
kind: TimeSyncConfig
# Specific PTP (Precision Time Protocol) configuration to sync the time over PTP devices.
ptp:
    # description: |
    devices:
        - /dev/ptp0
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`enabled`</td>
      <td>bool</td>
      <td>Indicates if the time synchronization is enabled for the machine.<br />Defaults to `true`.</td>

      <td />
    </tr>

    <tr>
      <td>`bootTimeout`</td>
      <td>Duration</td>
      <td>Specifies the timeout when the node time is considered to be in sync unlocking the boot sequence.<br />NTP sync will be still running in the background.<br />Defaults to "infinity" (waiting forever for time sync)</td>

      <td />
    </tr>

    <tr>
      <td>`ntp`</td>
      <td><a href="#ntp">NTPConfig</a></td>
      <td>Specifies NTP configuration to sync the time over network.<br />Mutually exclusive with PTP configuration.</td>

      <td />
    </tr>

    <tr>
      <td>`ptp`</td>
      <td><a href="#ptp">PTPConfig</a></td>
      <td>Specific PTP (Precision Time Protocol) configuration to sync the time over PTP devices.<br />Mutually exclusive with NTP configuration.</td>

      <td />
    </tr>
  </tbody>
</table>

## ntp

NTPConfig represents a NTP server configuration.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`servers`</td>
      <td>\[]string</td>
      <td>Specifies time (NTP) servers to use for setting the system time.<br />Defaults to `time.cloudflare.com`.</td>

      <td />
    </tr>
  </tbody>
</table>

## ptp

PTPConfig represents a PTP (Precision Time Protocol) configuration.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`devices`</td>
      <td>\[]string</td>
      <td>description:</td>
      <td><br /> A list of PTP devices to sync with (e.g. provided by the hypervisor).<br /><br /> A PTP device is typically represented as a character device file in the /dev directory,<br /> such as /dev/ptp0 or /dev/ptp\_kvm. These devices are used to synchronize the system time<br /> with an external time source that supports the Precision Time Protocol.<br /></td>

      <td />
    </tr>
  </tbody>
</table>