fix: host name should not be changed after install (#237)

Signed-off-by: Logan Blyth <[email protected]>

Author: mrbojangles3

docs/install-upgrade/config.md

@@ -92,7 +92,7 @@ spec:
 apiVersion: fabricator.githedgehog.com/v1beta1
 kind: ControlNode
 metadata:
-  name: control-1
+  name: control-1 # host name of control node, cannot be changed after install
   namespace: fab
 spec:
   bootstrap:
@@ -108,7 +108,7 @@ spec:
 apiVersion: fabricator.githedgehog.com/v1beta1
 kind: FabNode
 metadata:
-  name: gateway-1
+  name: gateway-1 # host name of gateway node, cannot be changed after install
   namespace: fab
 spec:
   roles:

docs/install-upgrade/install.md

@@ -51,8 +51,10 @@ command to see the available options. For example `hhfab init -h`.
 ### HHFAB commands to make a bootable image
 
 1. `hhfab init --wiring wiring-lab.yaml`
-1. The `init` command generates a `fab.yaml` file, edit the `fab.yaml` file for your needs
-    1. ensure the correct boot disk (e.g. `/dev/sda`) and control node NIC names are supplied
+1. The `init` command generates a `fab.yaml` file, edit the `fab.yaml` file for your needs, specifically:
+    1. Ensure the correct boot disk (e.g. `/dev/sda`) and control node NIC names are supplied
+    1. Ensure that the `name:` field under `kind: ControlNode` is the desired host name,
+       as this **cannot be changed** after installation
 1. `hhfab validate`
 1. `hhfab build --mode iso`
     1. An ISO is best suited to use with IPMI based virtual media. If desired an IMG file suitable for writing to a USB drive, can be created by passing the `--mode usb` option. ISO is the default.