Skip to content

Commit

Permalink
Apply suggestions from code review for ati-features.adoc
Browse files Browse the repository at this point in the history
Co-authored-by: Daria Vladykina <[email protected]>
  • Loading branch information
mchiappero and dariavladykina authored Jan 20, 2025
1 parent bfb5017 commit 96a5889
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions asciidoc/product/atip-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1362,9 +1362,9 @@ Many telco applications require strict phase and time synchronization with littl

The G.8275.1 profile has the following peculiarities:

* can run directly on Ethernet and requires full network support (adjacent nodes/switches must support PTP)
* the default domain setting is 24
* the dataset comparison is based on the G.8275.x algorithm and its `localPriority` values after `priority2`
* Runs directly on Ethernet and requires full network support (adjacent nodes/switches must support PTP).
* The default domain setting is 24.
* Dataset comparison is based on the G.8275.x algorithm and its `localPriority` values after `priority2`.

You can copy the following content to a file named `/etc/ptp4l-G.8275.1.conf`:

Expand Down Expand Up @@ -1397,8 +1397,8 @@ OPTIONS="-f /etc/ptp4l-G.8275.1.conf -i $IFNAME --message_tag ptp-8275.1"
More precisely:

- `-f` requires the file name of the configuration file to use; `/etc/ptp4l-G.8275.1.conf` in this case
- `-i` requires the name of the interface to use, replace `$IFNAME` with real interface name
- `--message_tag` allows to better identify the ptp4l output in the system logs and is optional
- `-i` requires the name of the interface to use, replace `$IFNAME` with a real interface name.
- `--message_tag` allows to better identify the ptp4l output in the system logs and is optional.

Once the above steps are complete, the `ptp4l` daemon can be (re)started:

Expand All @@ -1418,9 +1418,9 @@ You can now check the synchronization status by observing the logs with:

The G.8275.2 profile has the following peculiarities:

* can run on IP and does not require full network support (adjacent nodes/switches may not support PTP)
* the default domain setting is 44
* the dataset comparison is based on the G.8275.x algorithm and its `localPriority` values after `priority2`
* Runs on IP and does not require full network support (adjacent nodes/switches may not support PTP).
* The default domain setting is 44.
* Dataset comparison is based on the G.8275.x algorithm and its `localPriority` values after `priority2`.

You can copy the following content to a file named `/etc/ptp4l-G.8275.2.conf`:

Expand Down Expand Up @@ -1456,8 +1456,8 @@ unicast_master_table 1

The above configuration must be edited to include:

- `$PEER_IP_ADDRESS` - the IP address of the next PTP node to communicate to; that is, the master or boundary clock which will provide synchronization.
- `$IFNAME` - it will tell `ptp4l` what interface to use for PTP
- `$PEER_IP_ADDRESS` - the IP address of the next PTP node to communicate with, such as the master or boundary clock that will provide synchronization.
- `$IFNAME` - tells `ptp4l` what interface to use for PTP.

Once the file has been created, it must be referenced, along with the name of the interface to use for PTP, in `/etc/sysconfig/ptp4l` for the daemon to start correctly. This can be done by changing the `OPTIONS=` line to:

Expand All @@ -1468,8 +1468,8 @@ OPTIONS="-f /etc/ptp4l-G.8275.2.conf --message_tag ptp-8275.2"

More precisely:

- `-f` requires the file name of the configuration file to use; `/etc/ptp4l-G.8275.2.conf` in this case
- `--message_tag` allows to better identify the ptp4l output in the system logs and is optional
- `-f` requires the file name of the configuration file to use. In this case, it is `/etc/ptp4l-G.8275.2.conf`.
- `--message_tag` allows to better identify the ptp4l output in the system logs and is optional.

Once the above steps are complete, the `ptp4l` daemon can be (re)started:

Expand All @@ -1495,12 +1495,12 @@ Although not required, it is recommended that you fully complete the configurati
OPTIONS="-s $IFNAME -w"
----

Where `$IFNAME` is the name of the interface already set up in ptp4l that will be used as the source for the system clock. This is used, in practice, to identify the source PHC.
Where `$IFNAME` is the name of the interface already set up in ptp4l that will be used as the source for the system clock. In practice, this is used to identify the source PHC.

[#ptp-capi]
==== Cluster API integration

Whenever a cluster is deployed through a management cluster and directed provisioning, both the configuration file and the two configuration variables in `/etc/sysconfig` can be deployed on the host at provisioning time. Below is shown an excerpt of a cluster definition, focusing on a modified `RKE2ControlPlane` object that will deploy the same G.8275.1 configuration file on all hosts:
Whenever a cluster is deployed through a management cluster and directed provisioning, both the configuration file and the two configuration variables in `/etc/sysconfig` can be deployed on the host at provisioning time. Below is an excerpt from a cluster definition, focusing on a modified `RKE2ControlPlane` object that deploys the same G.8275.1 configuration file on all hosts:

[,yaml]
----
Expand Down Expand Up @@ -1625,4 +1625,4 @@ Besides other variables, the above definition must be completed with the interfa
* Alternative approaches are possible and will be covered in future releases.
====

At this point your hosts should have a working and running PTP stack and will start negotiating their PTP role.
At this point, your hosts should have a working and running PTP stack and will start negotiating their PTP role.

0 comments on commit 96a5889

Please sign in to comment.