mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
87 lines
3.6 KiB
Plaintext
87 lines
3.6 KiB
Plaintext
:_content-type: ASSEMBLY
|
|
[id="using-ptp"]
|
|
= Using PTP hardware
|
|
include::modules/common-attributes.adoc[]
|
|
:context: using-ptp
|
|
|
|
toc::[]
|
|
|
|
:FeatureName: Precision Time Protocol (PTP) hardware with single NIC configured as boundary clock
|
|
include::snippets/technology-preview.adoc[leveloffset=+1]
|
|
|
|
[id="about-using-ptp-hardware"]
|
|
== About PTP hardware
|
|
|
|
You can configure `linuxptp` services and use PTP-capable hardware in {product-title} cluster nodes.
|
|
|
|
[NOTE]
|
|
====
|
|
The PTP Operator works with PTP-capable devices on clusters provisioned only on bare-metal infrastructure.
|
|
====
|
|
|
|
You can use the {product-title} console or OpenShift CLI (`oc`) to install PTP by deploying the PTP Operator. The PTP Operator creates and manages the `linuxptp` services and provides the following features:
|
|
|
|
* Discovery of the PTP-capable devices in the cluster.
|
|
|
|
* Management of the configuration of `linuxptp` services.
|
|
|
|
* Notification of PTP clock events that negatively affect the performance and reliability of your application with the PTP Operator `cloud-event-proxy` sidecar.
|
|
|
|
include::modules/nw-ptp-introduction.adoc[leveloffset=+1]
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Before enabling PTP, ensure that NTP is disabled for the required nodes. You can disable the chrony time service (`chronyd`) using a `MachineConfig` custom resource. For more information, see xref:../post_installation_configuration/machine-configuration-tasks.adoc#cnf-disable-chronyd_post-install-machine-configuration-tasks[Disabling chrony time service].
|
|
====
|
|
|
|
include::modules/nw-ptp-installing-operator-cli.adoc[leveloffset=+1]
|
|
|
|
include::modules/nw-ptp-installing-operator-web-console.adoc[leveloffset=+1]
|
|
|
|
== Configuring PTP devices
|
|
|
|
The PTP Operator adds the `NodePtpDevice.ptp.openshift.io` custom resource definition (CRD) to {product-title}.
|
|
|
|
When installed, the PTP Operator searches your cluster for PTP-capable network devices on each node. It creates and updates a `NodePtpDevice` custom resource (CR) object for each node that provides a compatible PTP-capable network device.
|
|
|
|
include::modules/nw-ptp-device-discovery.adoc[leveloffset=+2]
|
|
|
|
include::modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc[leveloffset=+2]
|
|
|
|
include::modules/nw-ptp-configuring-linuxptp-services-as-boundary-clock.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-configuring-cvl-nic-as-oc.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-troubleshooting-common-ptp-operator-issues.adoc[leveloffset=+1]
|
|
|
|
== PTP hardware fast event notifications framework
|
|
|
|
:FeatureName: PTP events with ordinary clock
|
|
include::snippets/technology-preview.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-about-ptp-and-clock-synchronization.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-about-ptp-fast-event-notifications-framework.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-installing-amq-interconnect-messaging-bus.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-configuring-the-ptp-fast-event-publisher.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* For a complete example CR that configures `linuxptp` services with PTP fast events, see xref:../networking/using-ptp.adoc#configuring-linuxptp-services-as-ordinary-clock_using-ptp[Configuring linuxptp services as ordinary clock].
|
|
|
|
include::modules/cnf-fast-event-notifications-api-refererence.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-monitoring-fast-events-metrics-using-cli.adoc[leveloffset=+2]
|
|
|
|
include::modules/cnf-ptp-fast-event-metrics-in-prometheus.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../monitoring/managing-metrics.adoc[Managing metrics]
|