From 9a5d1ec422f49f1211315934fe9a86b5686d6232 Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Thu, 30 Jan 2025 04:11:00 -0700 Subject: [PATCH] Document commas in kernel arguments - Closes: #1679 Signed-off-by: Jonathon Anderson --- CHANGELOG.md | 4 ++++ userdocs/contents/nodeconfig.rst | 14 +++++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8da3db3d..4ca0bedc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## v4.6.0, unreleased +### Added + +- Document defining kernel args that include commas. #1679 + ### Fixed - Fix default nodes.conf to use the new kernel command line list format. #1670 diff --git a/userdocs/contents/nodeconfig.rst b/userdocs/contents/nodeconfig.rst index ba2fc3ac..adaf8e64 100644 --- a/userdocs/contents/nodeconfig.rst +++ b/userdocs/contents/nodeconfig.rst @@ -128,7 +128,7 @@ see a list of all configuration attributes, use the command ``wwctl node set --help``. Configuring the Node's Image -============================ +---------------------------- .. code-block:: console @@ -294,6 +294,18 @@ nodes are sorted lexically, first by cluster, then by ID.) Once a node has been discovered its "discoverable" flag is automatically cleared. +Setting list values +=================== + +Some node fields, such as overlays and kernel args, accept a list of values. +These may be specified as a comma-separated list or as multiple arguments. + +To include an explicit comma in the value, enclose the value in inner-quotes. + +.. code-block:: console + + # wwctl profile set default --kernelargs 'quiet,crashkernel=no,nosplash' --kernelargs='"console=ttyS0,115200"' + Un-setting Node Attributes ==========================