Initial PTP documentation for ATIP #542
Conversation
|
The CAPI section is still WIP; I will also update the commit message soon. But you can have a look at the wording in the meantime. Thanks! |
mchiappero
requested review from
alknopfler,
dariavladykina,
hardys and
fsundermeyer
asciidoc/product/atip-features.adoc
Outdated
|
|
||
| Replace `p1p1` with name of the interface to be used for PTP. | ||
|
|
||
| The following sections will provide guidance on how to install and configure PTP on SUSE Edge specifically, but familiarity with basic PTP concepts is expected. For a brief overview of PTP and the implementation included in ATIP, refer to https://documentation.suse.com/sles/15-SP5/html/SLES-all/cha-tuning-ptp.html[]. |
There was a problem hiding this comment.
We should probably refer to the latest 15-SP6 SLES docs here
There was a problem hiding this comment.
You can use https://documentation.suse.com/sles/html/SLES-all/cha-tuning-ptp.html --it will always redirect to the latest version.
asciidoc/product/atip-features.adoc
Outdated
| The `linuxptp` package included in ATIP does not enable `ptp4l` and `phc2sys` by default. If having them enabled at provisioning time is your preference, list them in the `systemd` section, as in the above example. This can be helpful if their system specific configuration files are also deployed at provisioning time through the directed network provisioning flow (see <<ptp-capi>>). | ||
| ==== | ||
|
|
||
| You can now follow the usual process to build the image as per the https://github.com/suse-edge/edge-image-builder/blob/release-1.0/docs/building-images.md[EIB Documentation] and use it to deploy your cluster. If you are new to EIB start from xref:../components/edge-image-builder.adoc#components-eib[] instead. |
There was a problem hiding this comment.
Again I think we should prefer the product docs where possible, we have coverage of EIB usage in the ATIP docs and also the EIB quickstart we could link to
There was a problem hiding this comment.
I have never noticed eib was in the quickstart section, I have linked from the components/upstream for this reason. Should we drop the last link, leave it as is or change it to the top of the quickstart guide?
There was a problem hiding this comment.
I guess the most relevant link is the ATIP section on building the image e.g https://documentation.suse.com/suse-edge/3.1/html/edge/atip-automated-provisioning.html#id-image-creation-2 ?
There was a problem hiding this comment.
I'd be inclined to refer to the EIB one, the ATIP is a duplicate (which must be updated accordingly BTW)... but either way is fine.
There was a problem hiding this comment.
Also, for internal links (pointing to some section of the Edge doc itself), please do not use http links or xrefs. Rather use the ID of the target section for linking:
If you are new to EIB start from <<components-eib>> instead.
or, if you want to add a custom link text:
If you are new to EIB start with the <<components-eib,Edge Image Builder Introduction>> instead.
There was a problem hiding this comment.
I'm a bit confused here, I have found some documentation stating the opposite. What is the reason for preferring one over the other?
mchiappero
force-pushed
the
ptp-doc
branch
3 times, most recently
from
71000c8 to
348cc01
Compare
|
It requires further work, there are other possibilities that have not been covered, but I think this could be it for now. If it looks good enough to you, I'd merge and do more updates later. |
asciidoc/product/atip-features.adoc
Outdated
| nodeName: "localhost.localdomain" | ||
| ---- | ||
|
|
||
| Besides other variables, the above definition must be completed with the interface name and with the other Cluster API objects, as described in xref:atip-automated-provisioning.adoc#single-node. |
There was a problem hiding this comment.
Is this link going to work?
There was a problem hiding this comment.
Good catch - no it doesn't - perhaps we can just replace it with <<atip-automated-provisioning>> ?
There was a problem hiding this comment.
The filename was wrong, but it doesn't work still. I am unable to understand why the others do but this one doesn't. Will likely switch to this format.
There was a problem hiding this comment.
I can't make it work. It's not a problem with the macro itself, there were two identical IDs in the referenced file, but it doesn't work anyway. I'd push and come back to it later.
There was a problem hiding this comment.
@mchiappero I tested and the format I mentioned works, it just doesn't link to the specific section - can we just go with that for now?
Add a couple of anchors to enable references from other files. Signed-off-by: Marco Chiappero <[email protected]>
|
|
||
| Both daemons are required for the system synchronization to fully work and must be correctly configured according to your setup, as covered in <<ptp-telco-config>>. | ||
|
|
||
| The easiest and best way to integrate PTP in your downstream cluster is to add the `linuxptp` package under `packageList` in the Edge Image Builder (EIB) definition file. This way the PTP control plane software will be installed automatically during the cluster provisioning. See the xref:../quickstart/eib.adoc#eib-configuring-rpm-packages[EIB documentation] for more information on installing packages. |
There was a problem hiding this comment.
| The easiest and best way to integrate PTP in your downstream cluster is to add the `linuxptp` package under `packageList` in the Edge Image Builder (EIB) definition file. This way the PTP control plane software will be installed automatically during the cluster provisioning. See the xref:../quickstart/eib.adoc#eib-configuring-rpm-packages[EIB documentation] for more information on installing packages. | |
| The easiest and best way to integrate PTP in your downstream cluster is to add the `linuxptp` package under `packageList` in the Edge Image Builder (EIB) definition file. This way the PTP control plane software will be installed automatically during the cluster provisioning. See the <<eib-configuring-rpm-packages,EIB documentation>> for more information on installing packages. |
Introduce an overview of how to install and configure PTP in ATIP with telco specific PTP profiles. This documentation is expected to be expanded over time, but this commit provides guidance on: - software installation - software configuration - mentions to PTP and "directed network provisioning" Acked-by: Daria Vladykina <[email protected]> Acked-by: Frank Sundermeyer <[email protected]> Signed-off-by: Marco Chiappero <[email protected]>
Add PTP to the least of features and to the tech-preview list. Signed-off-by: Marco Chiappero <[email protected]>
|
Thanks @mchiappero I'd suggest we merge this now so we can cut the release branch, then iterate on any remaining changes via follow-up PRs |
|
By the way, thank you all for your input! |
No description provided.