copr-be: better document pools.yaml.expand.sh

roles/copr/backend/templates/resalloc/pools.yaml.expand.sh

@@ -1,6 +1,10 @@
 #! /bin/bash
 
-# Helper script to expand pools.yaml jinja.
+# Helper script to expand the pools.yaml.j2 file locally (on your box, not on
+# Batcave), before you push the pools.yaml.j2 changes.  How to use:
+#   1. execute this script for the first time to initiate $outdir
+#   2. change the template
+#   3. re-execute the script, and check `git show` in $outdir
 
 pfx=pools-yaml-expander
 pbook=/tmp/playbook-$pfx.yaml

roles/copr/backend/templates/resalloc/pools.yaml.j2

@@ -2,14 +2,15 @@
 #
 # Notes for Resalloc configuration file:
 #
-# - You do NOT need to restart resalloc server after changing this file, it
-#   automatically reloads this configuration file.
-#
 {% if False %}
 # - This is rather a complex Jinja template.  Feel free to use the helper
 #   script to expand locally before you commit any change to this file:
 #   ./roles/copr/backend/templates/resalloc/pools.yaml.expand.sh
+#
 {% endif %}
+# - You do NOT need to restart resalloc server after changing this file, it
+#   automatically reloads this configuration file.
+#
 # - higher priority pools are used first
 #   default priority is 0
 #   reserved instances in cloud has > 0