2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2026-09-04 12:07:56 +00:00
Files
xcat-core/docs
Daniel Hilst 3249298cbd fix(xcat-core): site.ntpbackend is not documented anywhere
makentp reads site.ntpbackend to select the NTP daemon, and setupntp takes the same value as
--backend, but no help text names the attribute. An admin who needs ntpd on a host that has
chrony has no way to find out the attribute exists. site.dhcpbackend, which selects the DHCP
implementation the same way, is documented in the site table help.

The site table description in xCAT::Schema now carries ntpbackend beside ntpservers, with its
valid values and the auto default. The makentp man page lists it with the other site attributes
the command honors, and names the setupntp --backend option that carries the value to the nodes.

ntp_backend_selection.t reads the site help from the loaded schema and the makentp pod. Five
assertions fail without this change.

Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
2026-09-03 14:41:32 -03:00
..
2024-02-13 03:01:02 +01:00

Welcome to the xCAT documentation

The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (.rst).

Building Docs

  • Clone this project

  • Install dependencies (See: https://pip.readthedocs.io/)

    pip install --user -r requirements.txt
    
  • Build the Docs

    cd xcat-core/docs
    make html
    
  • View the documentation by pointing a browser to: xcat-core/docs/build/html/index.html