Documentation fixes
This commit is contained in:
Brian Clemens
@@ -54,7 +54,7 @@ Once the worker node has received all the required files, the kernel will boot,
|
||||
1. System Overlay
|
||||
1. Runtime Overlay
|
||||
|
||||
::: note
|
||||
:::note
|
||||
The Runtime Overlay may be resent to the worker node in the future or at regular intervals.
|
||||
:::
|
||||
|
||||
|
||||
@@ -5,31 +5,38 @@ title: wwctl container
|
||||
|
||||
Starting with version 4, Warewulf uses containers to build the bootable VNFS images for nodes to boot. These commands will help you import, management, and transform containers into bootable Warewulf VNFS images.
|
||||
|
||||
build
|
||||
~~~~~
|
||||
## build
|
||||
This command will build a bootable VNFS image from an imported container image.
|
||||
|
||||
-a, --all (re)Build all VNFS images for all nodes
|
||||
-f, --force Force rebuild, even if it isn't necessary
|
||||
--setdefault Set this container for the default profile
|
||||
### -a, --all
|
||||
(re)Build all VNFS images for all nodes
|
||||
|
||||
delete
|
||||
~~~~~~
|
||||
### -f, --force
|
||||
Force rebuild, even if it isn't necessary
|
||||
|
||||
### --setdefault
|
||||
Set this container for the default profile
|
||||
|
||||
## delete
|
||||
This command will delete a container that has been imported into Warewulf.
|
||||
|
||||
exec
|
||||
~~~~
|
||||
## exec
|
||||
This command will allow you to run any command inside of a given warewulf container. This is commonly used with an interactive shell such as ``/bin/bash`` to run a virtual environment within the container.
|
||||
|
||||
import
|
||||
~~~~~~
|
||||
## import
|
||||
This command will pull and import a container into Warewulf so it can be used as a source to create a bootable VNFS image.
|
||||
|
||||
-f, --force Force overwrite of an existing container
|
||||
-u, --update Update and overwrite an existing container
|
||||
-b, --build Build container when after pulling
|
||||
--setdefault Set this container for the default profile
|
||||
### -f, --force
|
||||
Force overwrite of an existing container
|
||||
|
||||
list, ls
|
||||
~~~~~~~~
|
||||
### -u, --update
|
||||
Update and overwrite an existing container
|
||||
|
||||
### -b, --build
|
||||
Build container when after pulling
|
||||
|
||||
### --setdefault
|
||||
Set this container for the default profile
|
||||
|
||||
## list, ls
|
||||
This command will show you the containers that are imported into Warewulf.
|
||||
|
||||
@@ -5,19 +5,25 @@ title: wwctl controller
|
||||
|
||||
Management of group settings and power management
|
||||
|
||||
add
|
||||
~~~
|
||||
## add
|
||||
|
||||
delete
|
||||
~~~~~~
|
||||
## delete
|
||||
|
||||
list
|
||||
~~~~
|
||||
-a, --all Show all node configurations
|
||||
## list
|
||||
|
||||
set
|
||||
~~~
|
||||
-a, --all Set all controllers
|
||||
-I, --ipaddr Set the controller's IP address
|
||||
-F, --fqdn Set the controller's FQDN
|
||||
-C, --comment Comments describing this controller
|
||||
### -a, --all
|
||||
Show all node configurations
|
||||
|
||||
## set
|
||||
|
||||
### -a, --all
|
||||
Set all controllers
|
||||
|
||||
### -I, --ipaddr
|
||||
Set the controller's IP address
|
||||
|
||||
### -F, --fqdn
|
||||
Set the controller's FQDN
|
||||
|
||||
### -C, --comment
|
||||
Comments describing this controller
|
||||
|
||||
@@ -5,15 +5,20 @@ title: wwctl kernel
|
||||
|
||||
This command is for management of Warewulf Kernels to be used for bootstrapping nodes.
|
||||
|
||||
import
|
||||
~~~~~~
|
||||
## import
|
||||
This will import a Kernel version from the control node into Warewulf for nodes to be configured to boot on.
|
||||
|
||||
-a, --all Build all overlays (runtime and system)
|
||||
-n, --node Build overlay for a particular node(s)
|
||||
-r, --root Import kernel from root (chroot) directory
|
||||
--setdefault Set this kernel for the default profile
|
||||
### -a, --all
|
||||
Build all overlays (runtime and system)
|
||||
|
||||
list, ls
|
||||
~~~~~~~~
|
||||
### -n, --node
|
||||
Build overlay for a particular node(s)
|
||||
|
||||
### -r, --root
|
||||
Import kernel from root (chroot) directory
|
||||
|
||||
### --setdefault
|
||||
Set this kernel for the default profile
|
||||
|
||||
## list, ls
|
||||
This command will list the kernels that have been imported into Warewulf.
|
||||
|
||||
@@ -5,75 +5,155 @@ title: wwctl node
|
||||
|
||||
Management of node settings
|
||||
|
||||
add
|
||||
~~~
|
||||
## add
|
||||
This command will add a new node to Warewulf.
|
||||
|
||||
-g, --group Group to add nodes to
|
||||
-c, --controller Controller to add nodes to
|
||||
-N, --netdevDefine the network device to configure
|
||||
-I, --ipaddrSet the node's network device IP address
|
||||
-M, --netmaskSet the node's network device netmask
|
||||
-G, --gatewaySet the node's network device gateway
|
||||
-H, --hwaddrSet the node's network device HW address
|
||||
--discoverable Make this node discoverable
|
||||
### -g, --group
|
||||
Group to add nodes to
|
||||
|
||||
console
|
||||
~~~~~~~
|
||||
### -c, --controller
|
||||
Controller to add nodes to
|
||||
|
||||
### -N, --netdevDefine
|
||||
the network device to configure
|
||||
|
||||
### -I, --ipaddrSet
|
||||
the node's network device IP address
|
||||
|
||||
### -M, --netmaskSet
|
||||
the node's network device netmask
|
||||
|
||||
### -G, --gatewaySet
|
||||
the node's network device gateway
|
||||
|
||||
### -H, --hwaddrSet
|
||||
the node's network device HW address
|
||||
|
||||
### --discoverable
|
||||
Make this node discoverable
|
||||
|
||||
## console
|
||||
Start IPMI console for a singe node.
|
||||
|
||||
delete
|
||||
~~~~~~
|
||||
## delete
|
||||
This command will remove a node from the Warewulf node configuration.
|
||||
|
||||
-f, --force Force node delete
|
||||
-g, --group Set group to delete nodes from
|
||||
-c, --controller Controller to add nodes to
|
||||
### -f, --force
|
||||
Force node delete
|
||||
|
||||
list
|
||||
~~~~
|
||||
### -g, --group
|
||||
Set group to delete nodes from
|
||||
|
||||
### -c, --controller
|
||||
Controller to add nodes to
|
||||
|
||||
## list
|
||||
This command will show you configured nodes.
|
||||
|
||||
-n, --net Show node network configurations
|
||||
-i, --ipmi Show node IPMI configurations
|
||||
-a, --all Show all node configurations
|
||||
-l, --long Show long or wide format
|
||||
### -n, --net
|
||||
Show node network configurations
|
||||
|
||||
sensors
|
||||
~~~~~~~
|
||||
### -i, --ipmi
|
||||
Show node IPMI configurations
|
||||
|
||||
### -a, --all
|
||||
Show all node configurations
|
||||
|
||||
### -l, --long
|
||||
Show long or wide format
|
||||
|
||||
## sensors
|
||||
Show IPMI sensors for a single node.
|
||||
-F, --full show detailed output
|
||||
|
||||
set
|
||||
~~~
|
||||
### -F, --full
|
||||
show detailed output
|
||||
|
||||
## set
|
||||
This command will allow you to set configuration properties for nodes.
|
||||
|
||||
--comment Set a comment for this node
|
||||
-C, --container Set the container (VNFS) for this node
|
||||
-K, --kernel Set Kernel version for nodes
|
||||
-A, --kernelargs Set Kernel argument for nodes
|
||||
-c, --cluster Set the node's cluster group
|
||||
-P, --ipxe Set the node's iPXE template name
|
||||
-i, --init Define the init process to boot the container
|
||||
--root Define the rootfs
|
||||
-R, --runtime Set the node's runtime overlay
|
||||
-S, --system Set the node's system overlay
|
||||
--ipmi Set the node's IPMI IP address
|
||||
--ipminetmask Set the node's IPMI netmask
|
||||
--ipmigateway Set the node's IPMI gateway
|
||||
--ipmiuser Set the node's IPMI username
|
||||
--ipmipass Set the node's IPMI password
|
||||
-p, --addprofile Add Profile(s) to node
|
||||
-r, --delprofile Remove Profile(s) to node
|
||||
-N, --netdev Define the network device to configure
|
||||
-I, --ipaddr Set the node's network device IP address
|
||||
-M, --netmask Set the node's network device netmask
|
||||
-G, --gateway Set the node's network device gateway
|
||||
-H, --hwaddr Set the node's network device HW address
|
||||
--netdel Delete the node's network device
|
||||
--netdefault Set this network to be default
|
||||
-a, --all Set all nodes
|
||||
-y, --yes Set 'yes' to all questions asked
|
||||
-f, --force Force configuration (even on error)
|
||||
--discoverable Make this node discoverable
|
||||
--undiscoverable Remove the discoverable flag
|
||||
### --comment
|
||||
Set a comment for this node
|
||||
|
||||
### -C, --container
|
||||
Set the container (VNFS) for this node
|
||||
|
||||
### -K, --kernel
|
||||
Set Kernel version for nodes
|
||||
|
||||
### -A, --kernelargs
|
||||
Set Kernel argument for nodes
|
||||
|
||||
### -c, --cluster
|
||||
Set the node's cluster group
|
||||
|
||||
### -P, --ipxe
|
||||
Set the node's iPXE template name
|
||||
|
||||
### -i, --init
|
||||
Define the init process to boot the container
|
||||
|
||||
### --root
|
||||
Define the rootfs
|
||||
|
||||
### -R, --runtime
|
||||
Set the node's runtime overlay
|
||||
|
||||
### -S, --system
|
||||
Set the node's system overlay
|
||||
|
||||
### --ipmi
|
||||
Set the node's IPMI IP address
|
||||
|
||||
### --ipminetmask
|
||||
Set the node's IPMI netmask
|
||||
|
||||
### --ipmigateway
|
||||
Set the node's IPMI gateway
|
||||
|
||||
### --ipmiuser
|
||||
Set the node's IPMI username
|
||||
|
||||
### --ipmipass
|
||||
Set the node's IPMI password
|
||||
|
||||
### -p, --addprofile
|
||||
Add Profile(s) to node
|
||||
|
||||
### -r, --delprofile
|
||||
Remove Profile(s) to node
|
||||
|
||||
### -N, --netdev
|
||||
Define the network device to configure
|
||||
|
||||
### -I, --ipaddr
|
||||
Set the node's network device IP address
|
||||
|
||||
### -M, --netmask
|
||||
Set the node's network device netmask
|
||||
|
||||
### -G, --gateway
|
||||
Set the node's network device gateway
|
||||
|
||||
### -H, --hwaddr
|
||||
Set the node's network device HW address
|
||||
|
||||
### --netdel
|
||||
Delete the node's network device
|
||||
|
||||
### --netdefault
|
||||
Set this network to be default
|
||||
|
||||
### -a, --all
|
||||
Set all nodes
|
||||
|
||||
### -y, --yes
|
||||
Set 'yes' to all questions asked
|
||||
|
||||
### -f, --force
|
||||
Force configuration (even on error)
|
||||
|
||||
### --discoverable
|
||||
Make this node discoverable
|
||||
|
||||
### --undiscoverable
|
||||
Remove the discoverable flag
|
||||
|
||||
@@ -5,72 +5,104 @@ title: wwctl overlay
|
||||
|
||||
Management interface for Warewulf overlays
|
||||
|
||||
build
|
||||
~~~~~
|
||||
### build
|
||||
This command will build a system or runtime overlay.
|
||||
|
||||
-s, --system Show System Overlays as well
|
||||
-a, --all Build all overlays (runtime and system)
|
||||
### -s, --system
|
||||
Show System Overlays as well
|
||||
|
||||
chmod
|
||||
~~~~~
|
||||
### -a, --all
|
||||
Build all overlays (runtime and system)
|
||||
|
||||
### chmod
|
||||
This command will allow you to change the permissions of a file within an overlay.
|
||||
|
||||
-s, --system Show System Overlays as well
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show System Overlays as well
|
||||
|
||||
create
|
||||
~~~~~~
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### create
|
||||
This command will create a new empty overlay.
|
||||
|
||||
-s, --system Show System Overlays as well
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show System Overlays as well
|
||||
|
||||
delete
|
||||
~~~~~~
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### delete
|
||||
This command will delete files within an overlay or an entire overlay if no files are given to remove (use with caution).
|
||||
|
||||
-s, --system Show system overlays instead of runtime
|
||||
-f, --force Force deletion of a non-empty overlay
|
||||
-p, --parents Remove empty parent directories
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show system overlays instead of runtime
|
||||
|
||||
edit
|
||||
~~~~
|
||||
### -f, --force
|
||||
Force deletion of a non-empty overlay
|
||||
|
||||
### -p, --parents
|
||||
Remove empty parent directories
|
||||
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### edit
|
||||
This command will allow you to edit or create a new file within a given overlay. Note: when creating files ending in a '.ww' suffix this will always be parsed as a Warewulf template file, and the suffix will be removed automatically
|
||||
|
||||
-s, --system Show system overlays instead of runtime
|
||||
-f, --files List files contained within a given overlay
|
||||
-p, --parents Create any necessary parent directories
|
||||
-m, --mode Permission mode for directory
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show system overlays instead of runtime
|
||||
|
||||
import
|
||||
~~~~~~
|
||||
### -f, --files
|
||||
List files contained within a given overlay
|
||||
|
||||
### -p, --parents
|
||||
Create any necessary parent directories
|
||||
|
||||
### -m, --mode
|
||||
Permission mode for directory
|
||||
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### import
|
||||
This command will import a file into a given Warewulf overlay.
|
||||
|
||||
-s, --system Show system overlays instead of runtime
|
||||
-m, --mode Permission mode for directory
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show system overlays instead of runtime
|
||||
|
||||
list
|
||||
~~~~
|
||||
### -m, --mode
|
||||
Permission mode for directory
|
||||
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### list
|
||||
This command will show you information about Warewulf overlays and the files contained within.
|
||||
|
||||
-s, --system Show system overlays instead of runtime
|
||||
-a, --all List the contents of overlays
|
||||
-l, --long List 'long' of all overlay contents
|
||||
### -s, --system
|
||||
Show system overlays instead of runtime
|
||||
|
||||
mkdir
|
||||
~~~~~
|
||||
### -a, --all
|
||||
List the contents of overlays
|
||||
|
||||
### -l, --long
|
||||
List 'long' of all overlay contents
|
||||
|
||||
### mkdir
|
||||
This command will allow you to create a new file within a given Warewulf overlay.
|
||||
|
||||
-s, --system Show System Overlays as well
|
||||
-m, --mode Permission mode for directory
|
||||
-n, --noupdate Don't update overlays
|
||||
### -s, --system
|
||||
Show System Overlays as well
|
||||
|
||||
show
|
||||
~~~~
|
||||
### -m, --mode
|
||||
Permission mode for directory
|
||||
|
||||
### -n, --noupdate
|
||||
Don't update overlays
|
||||
|
||||
### show
|
||||
This command will output the contents of a file within a given
|
||||
|
||||
-s, --system Show System Overlays as well
|
||||
### -s, --system
|
||||
Show System Overlays as well
|
||||
|
||||
@@ -5,18 +5,14 @@ title: wwctl power
|
||||
|
||||
This command can control the power state of nodes.
|
||||
|
||||
cycle
|
||||
~~~~~
|
||||
## cycle
|
||||
This command will cycle the power for a given set of nodes.
|
||||
|
||||
off
|
||||
~~~
|
||||
## off
|
||||
This command will shutdown the power to a given set of nodes.
|
||||
|
||||
on
|
||||
~~
|
||||
## on
|
||||
This command will power on a given set of nodes.
|
||||
|
||||
status
|
||||
~~~~~~
|
||||
## status
|
||||
Show power status for the given node(s)
|
||||
|
||||
@@ -5,42 +5,83 @@ title: wwctl profile
|
||||
|
||||
Management of node profile settings
|
||||
|
||||
add
|
||||
~~~
|
||||
## add
|
||||
This command will add a new node profile.
|
||||
|
||||
delete
|
||||
~~~~~~
|
||||
## delete
|
||||
This command will delete a node profile.
|
||||
|
||||
list
|
||||
~~~~
|
||||
## list
|
||||
This command will list and show the profile configurations.
|
||||
|
||||
set
|
||||
~~~
|
||||
## set
|
||||
This command will allow you to set configuration properties for node profiles.
|
||||
|
||||
--comment Set a comment for this node
|
||||
-C, --container Set the container (VNFS) for this node
|
||||
-K, --kernel Set Kernel version for nodes
|
||||
-A, --kernelargs Set Kernel argument for nodes
|
||||
-c, --cluster Set the node's cluster group
|
||||
-P, --ipxe Set the node's iPXE template name
|
||||
-i, --init Define the init process to boot the container
|
||||
--root Define the rootfs
|
||||
-R, --runtime Set the node's runtime overlay
|
||||
-S, --system Set the node's system overlay
|
||||
--ipminetmask Set the node's IPMI netmask
|
||||
--ipmigateway Set the node's IPMI gateway
|
||||
--ipmiuser Set the node's IPMI username
|
||||
--ipmipass Set the node's IPMI password
|
||||
-N, --netdev Define the network device to configure
|
||||
-I, --ipaddr Set the node's network device IP address
|
||||
-M, --netmask Set the node's network device netmask
|
||||
-G, --gateway Set the node's network device gateway
|
||||
-H, --hwaddr Set the node's network device HW address
|
||||
--netdel Delete the node's network device
|
||||
--netdefault Set this network to be default
|
||||
-a, --all Set all profiles
|
||||
-f, --force Force configuration (even on error)
|
||||
### --comment
|
||||
Set a comment for this node
|
||||
|
||||
### -C, --container
|
||||
Set the container (VNFS) for this node
|
||||
|
||||
### -K, --kernel
|
||||
Set Kernel version for nodes
|
||||
|
||||
### -A, --kernelargs
|
||||
Set Kernel argument for nodes
|
||||
|
||||
### -c, --cluster
|
||||
Set the node's cluster group
|
||||
|
||||
### -P, --ipxe
|
||||
Set the node's iPXE template name
|
||||
|
||||
### -i, --init
|
||||
Define the init process to boot the container
|
||||
|
||||
### --root
|
||||
Define the rootfs
|
||||
|
||||
### -R, --runtime
|
||||
Set the node's runtime overlay
|
||||
|
||||
### -S, --system
|
||||
Set the node's system overlay
|
||||
|
||||
### --ipminetmask
|
||||
Set the node's IPMI netmask
|
||||
|
||||
### --ipmigateway
|
||||
Set the node's IPMI gateway
|
||||
|
||||
### --ipmiuser
|
||||
Set the node's IPMI username
|
||||
|
||||
### --ipmipass
|
||||
Set the node's IPMI password
|
||||
|
||||
### -N, --netdev
|
||||
Define the network device to configure
|
||||
|
||||
### -I, --ipaddr
|
||||
Set the node's network device IP address
|
||||
|
||||
### -M, --netmask
|
||||
Set the node's network device netmask
|
||||
|
||||
### -G, --gateway
|
||||
Set the node's network device gateway
|
||||
|
||||
### -H, --hwaddr
|
||||
Set the node's network device HW address
|
||||
|
||||
### --netdel
|
||||
Delete the node's network device
|
||||
|
||||
### --netdefault
|
||||
Set this network to be default
|
||||
|
||||
### -a, --all
|
||||
Set all profiles
|
||||
|
||||
### -f, --force
|
||||
Force configuration (even on error)
|
||||
|
||||
@@ -5,16 +5,14 @@ title: wwctl server
|
||||
|
||||
This command will allow you to control the Warewulf daemon process.
|
||||
|
||||
start
|
||||
~~~~~
|
||||
## start
|
||||
Start Warewulf server
|
||||
|
||||
-f, --foreground Run daemon process in the foreground
|
||||
### -f, --foreground
|
||||
Run daemon process in the foreground
|
||||
|
||||
status
|
||||
~~~~~~
|
||||
## status
|
||||
Warewulf server status
|
||||
|
||||
stop
|
||||
~~~~
|
||||
## stop
|
||||
Stop Warewulf server
|
||||
|
||||
Reference in New Issue
Block a user