mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OCPBUGS-44700: ContentX for the PTP and SCTP networking docs
This commit is contained in:
@@ -1305,19 +1305,19 @@ Topics:
|
||||
File: configuring-ipfailover
|
||||
- Name: Configuring system controls and interface attributes using the tuning plugin
|
||||
File: configure-syscontrols-interface-tuning-cni
|
||||
- Name: Using SCTP
|
||||
- Name: Using Stream Control Transmission Protocol
|
||||
File: using-sctp
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
- Name: Using PTP hardware
|
||||
- Name: Using Precision Time Protocol hardware
|
||||
Dir: ptp
|
||||
Topics:
|
||||
- Name: About PTP in OpenShift clusters
|
||||
- Name: About Precision Time Protocol in OpenShift cluster nodes
|
||||
File: about-ptp
|
||||
- Name: Configuring PTP hardware
|
||||
- Name: Configuring Precision Time Protocol devices
|
||||
File: configuring-ptp
|
||||
- Name: Using PTP events
|
||||
- Name: Using Precision Time Protocol events
|
||||
File: using-ptp-events
|
||||
- Name: Developing PTP events consumer applications
|
||||
- Name: Developing Precision Time Protocol events consumer applications
|
||||
File: ptp-cloud-events-consumer-dev-reference
|
||||
- Name: External DNS Operator
|
||||
Dir: external_dns_operator
|
||||
|
||||
@@ -4,7 +4,16 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="discover-ptp-devices_{context}"]
|
||||
= Discovering PTP capable network devices in your cluster
|
||||
= Discovering PTP-capable network devices in your cluster
|
||||
|
||||
Identify PTP-capable network devices that exist in your cluster so that you can configure them
|
||||
|
||||
|
||||
.Prerequisties
|
||||
|
||||
* You installed the PTP Operator.
|
||||
|
||||
.Procedure
|
||||
|
||||
* To return a complete list of PTP capable network devices in your cluster, run the following command:
|
||||
+
|
||||
|
||||
@@ -3,10 +3,9 @@
|
||||
// * networking/using-sctp.adoc
|
||||
|
||||
[id="nw-sctp-about_{context}"]
|
||||
= Support for Stream Control Transmission Protocol (SCTP) on {product-title}
|
||||
= Support for SCTP on {product-title}
|
||||
|
||||
As a cluster administrator, you can enable SCTP on the hosts in the cluster.
|
||||
On {op-system-first}, the SCTP module is disabled by default.
|
||||
As a cluster administrator, you can enable SCTP on the hosts in the cluster. On {op-system-first}, the SCTP module is disabled by default.
|
||||
|
||||
SCTP is a reliable message based protocol that runs on top of an IP network.
|
||||
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * networking/ptp/configuring-ptp.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="ptp-using-hardware-specific-nic-features_{context}"]
|
||||
= Using hardware-specific NIC features with the PTP Operator
|
||||
|
||||
NIC hardware with built-in PTP capabilities sometimes require device-specific configuration.
|
||||
You can use hardware-specific NIC features for supported hardware with the PTP Operator by configuring a plugin in the `PtpConfig` custom resource (CR).
|
||||
The `linuxptp-daemon` service uses the named parameters in the `plugin` stanza to start `linuxptp` processes (`ptp4l` and `phc2sys`) based on the specific hardware configuration.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
In {product-title} {product-version}, the Intel E810 NIC is supported with a `PtpConfig` plugin.
|
||||
====
|
||||
@@ -1,13 +1,12 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="about-ptp"]
|
||||
= About PTP in {product-title} cluster nodes
|
||||
= About Precision Time Protocol in OpenShift cluster nodes
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: about-ptp
|
||||
|
||||
toc::[]
|
||||
|
||||
Precision Time Protocol (PTP) is used to synchronize clocks in a network.
|
||||
When used in conjunction with hardware support, PTP is capable of sub-microsecond accuracy, and is more accurate than Network Time Protocol (NTP).
|
||||
Precision Time Protocol (PTP) is used to synchronize clocks in a network. When used in conjunction with hardware support, PTP is capable of sub-microsecond accuracy, and is more accurate than Network Time Protocol (NTP).
|
||||
|
||||
You can configure `linuxptp` services and use PTP-capable hardware in {product-title} cluster nodes.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="configuring-ptp"]
|
||||
= Configuring PTP devices
|
||||
= Configuring Precision Time Protocol devices
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: configuring-ptp
|
||||
|
||||
@@ -8,7 +8,14 @@ toc::[]
|
||||
|
||||
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 Precision Time Protocol (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.
|
||||
When installed, the PTP Operator searches your cluster for Precision Time Protocol (PTP) capable network devices on each node. The Operator creates and updates a `NodePtpDevice` custom resource (CR) object for each node that provides a compatible PTP-capable network device.
|
||||
|
||||
Network interface controller (NIC) hardware with built-in PTP capabilities sometimes require a device-specific configuration. You can use hardware-specific NIC features for supported hardware with the PTP Operator by configuring a plugin in the `PtpConfig` custom resource (CR). The `linuxptp-daemon` service uses the named parameters in the `plugin` stanza to start `linuxptp` processes, `ptp4l` and `phc2sys`, based on the specific hardware configuration.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
In {product-title} {product-version}, the Intel E810 NIC is supported with a `PtpConfig` plugin.
|
||||
====
|
||||
|
||||
include::modules/nw-ptp-installing-operator-cli.adoc[leveloffset=+1]
|
||||
|
||||
@@ -16,8 +23,6 @@ include::modules/nw-ptp-installing-operator-web-console.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/nw-ptp-device-discovery.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ptp-using-hardware-specific-nic-features.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual-nic.adoc[leveloffset=+1]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="ptp-cloud-events-consumer-dev-reference"]
|
||||
= Developing PTP events consumer applications
|
||||
= Developing Precision Time Protocol events consumer applications
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: ptp-consumer
|
||||
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-sctp"]
|
||||
= Using the Stream Control Transmission Protocol (SCTP) on a bare metal cluster
|
||||
= Using the Stream Control Transmission Protocol (SCTP)
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: using-sctp
|
||||
|
||||
toc::[]
|
||||
|
||||
As a cluster administrator, you can use the Stream Control Transmission Protocol (SCTP) on a cluster.
|
||||
As a cluster administrator, you can use the Stream Control Transmission Protocol (SCTP) on a bare-metal cluster.
|
||||
|
||||
include::modules/nw-sctp-about.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user