diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c68becc..70449bbb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,6 +66,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added experimental dnsmasq support. - Check for formal correct IP and MAC addresses for command line options and when reading in the configurations +- Added template to create genders database ## [4.4.0] 2023-01-18 diff --git a/etc/examples/genders.ww b/etc/examples/genders.ww new file mode 100755 index 00000000..6866c108 --- /dev/null +++ b/etc/examples/genders.ww @@ -0,0 +1,10 @@ +# This file is autogenerated by warewulf +# Host: {{.BuildHost}} +# Time: {{.BuildTime}} +# Source: {{.BuildSource}} +{{- range $node := $.AllNodes}} {{/* for each node */}} +{{ $node.Id.Get }} {{ range $i,$profile := $node.Profiles.GetSlice }} +{{- if $i }},{{end}} +{{- $profile }}{{ end }} +{{- range $key,$value := $node.Tags }},{{$value.Get}}{{ end }} +{{- end }} diff --git a/userdocs/contents/example-templates.rst b/userdocs/contents/example-templates.rst new file mode 100644 index 00000000..b04f176b --- /dev/null +++ b/userdocs/contents/example-templates.rst @@ -0,0 +1,25 @@ +================ +Useful templates +================ + +The examples directory contains some useful examples for day to day cluster admninstration. + +Genders +======= + +The file `genders.ww` can be placed as `/etc/genders.ww` which will create a genders database which containts all nodes with their profile as key. Also for every user defined 'key' the 'tah' will be added. + +.. Note: + +A arbitrary tag with a key can be added to a node with + +.. code-block:: bash + wwctl node set --tagadd key=value n01 + wwctl node set --tagadd key2='foo=baar' n01 + +will result in genders file with following line + + +.. code-block:: bash + n01: value,foo=baar +