From 6cfd028ee2c7bb593169c48ee3c943f64c727990 Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Wed, 24 Aug 2022 05:12:06 -0600 Subject: [PATCH] Initial commit: nodes.conf manpage Signed-off-by: Jonathon Anderson --- docs/man/man5/nodes.conf.5 | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/man/man5/nodes.conf.5 diff --git a/docs/man/man5/nodes.conf.5 b/docs/man/man5/nodes.conf.5 new file mode 100644 index 00000000..7bd965d2 --- /dev/null +++ b/docs/man/man5/nodes.conf.5 @@ -0,0 +1,22 @@ +.TH "NODES.CONF" "5" + +.SH NAME + +nodes.conf \- warewulf node configuration database + +.SH DESCRIPTION +.LP + +\fBnodes.conf\fP is the primary database file for all compute nodes +(and node profiles). It is a flat text YAML configuration file that is +managed by \fBwwctl(1)\fP. + +While manual editing of the \fBnodes.conf\fP file is possible and can +be useful, the internal structure of the file is subject to change +without notice between Warewulf versions. The recommended and only +supported mechanism for updating \fBnodes.conf\fP is via +\fBwwctl(1)\fP. + +.SH SEE ALSO + +\fBwwctl(1)\fP, \fBwwctl-nodes(1)\fP, \fBwwctl-profile(1)\fP