📖 Clarify Auroraboot status in other OSes (#1139)

* 📖 Clarify Auroraboot status in other OSes Signed-off-by: Itxaka <itxaka.garcia@spectrocloud.com> * Update docs/content/en/docs/Reference/auroraboot.md Co-authored-by: Dimitris Karakasilis <jimmykarily@gmail.com> Signed-off-by: Itxaka <itxaka.garcia@spectrocloud.com> * Add auroraboot example on macOS Signed-off-by: Itxaka <itxaka.garcia@spectrocloud.com> --------- Signed-off-by: Itxaka <itxaka.garcia@spectrocloud.com> Co-authored-by: Dimitris Karakasilis <jimmykarily@gmail.com>
kairos-io · Mar 16, 2023 · 4c16261 · 4c16261
1 parent 8dd6a46
commit 4c16261
Showing 1 changed file with 27 additions and 1 deletion.
diff --git a/docs/content/en/docs/Reference/auroraboot.md b/docs/content/en/docs/Reference/auroraboot.md
@@ -37,6 +37,32 @@ AuroraBoot can be useful to:
 - `ProxyDHCP` supported by the `DHCP` network attempting to netboot (see also [pixiecore architecture](https://github.com/danderson/netboot/blob/master/pixiecore/README.booting.md#step-1-dhcpproxydhcp)).
    There should be an already running `DHCP` server on your network. AuroraBoot doesn't take over the `DHCP` server, neither require you to do any specific configuration, however a `DHCP` server which is compliant to `ProxyDHCP` requests should be present in the same network running **AuroraBoot** and the machines to boot.
 
+## MacOS
+
+Unfortunately for macOS systems we cannot run the netboot through docker as it's run inside a VM, as it can't see the host network.
+Building ISOs still works as long as you mount the container `/tmp` disk to a local dir so its exported there like so:
+
+```bash
+docker run --rm -ti -v ${PWD}:/tmp quay.io/kairos/auroraboot \ 
+                    --set "artifact_version=v1.5.1" \
+                    --set "release_version=v1.5.1" \
+                    --set "flavor=opensuse-leap" \
+                    --set "repository=kairos-io/kairos" \
+                    --set "disable_http_server=true" \
+                    --set "disable_netboot=true" \
+                    --cloud-config /config.yaml
+```
+
+This will build the ISO and put the generated artifacts in the current dir under the `${PWD}/iso` dir.
+
+For netboot, we recommend that you run the AuroraBoot binary directly by grabbing it from the [releases page](https://github.com/kairos-io/AuroraBoot/releases).
+This requires just one dependency that you can install via [brew](https://brew.sh/) with `brew install xorriso`
+
+## Windows
+
+Netboot in windows is not supported, only iso creation via the docker image.
+
+
 ## Overview
 
 To run AuroraBoot, simply use `docker` or the container engine of your choice (such as `podman`, ...). AuroraBoot images are published in [quay](https://quay.io/repository/kairos/auroraboot) and the source code is available [in GitHub](https://github.com/kairos-io/AuroraBoot).
@@ -129,7 +155,7 @@ To specify a cloud config, you can set it with `--cloud-config`. See the section
 
 Generic hardware based netbooting is out of scope for this document. 
 
-Nodes needs to be configured to boot over network, and after AuroraBoot is started should be ready to accept a connection, a typical output of a successfull run is:
+Nodes need to be configured to boot over network, and after AuroraBoot is started should be ready to accept a connection, a typical output of a successfull run is:
 
 ```bash                                                                                                                                                                      
 2023/02/08 14:27:30 DHCP: Offering to boot 08:00:27:54:1a:d1