Initial airgap instructions

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>

Author: alexellis

docs/edge/airgap.md

@@ -0,0 +1,135 @@
+# Air-gapped OpenFaaS Edge
+
+OpenFaaS Edge can be installed within an air-gapped environment using images copied from a machine with Internet access, to one without it.
+
+## Download images for offline usage
+
+You can download, transfer and restore the images whichever way you prefer, however we maintain a dedicated, supported tool to do this for you called airfaas.
+
+### Download the OpenFaaS Edge images for offline access
+
+On a PC with Internet access, run the following command to download the images:
+
+```bash
+faas-cli plugin get airfaas
+```
+
+Now, download the images for OpenFaaS Edge from your docker-compose.yaml file:
+
+```bash
+faas-cli airfaas download images \
+  --yaml ./docker-compose.yaml \
+  --path ./images \
+  openfaas-edge
+```
+
+If you do not have a docker-compose.yaml file, you can install OpenFaaS Edge on a Linux host and then extract it from `/var/lib/faasd/docker-compose.yaml`.
+
+### Download your functions
+
+You can also download your functions using the same method.
+
+```bash
+faas-cli airfaas download images \
+  --yaml ./stack.yaml \
+  --path ./images \
+  functions
+```
+
+## Transfer the images
+
+Transfer the `./images` directory to the air-gapped machine using your preferred method. This could be a USB drive, SCP, rsync, or any other method you prefer.
+
+## Restore the images
+
+When running OpenFaaS Edge in an air-gap, you can restore the images to either a local registry or the containerd library.
+
+### Restore images to the containerd library
+
+The easiest way to test an air-gapped installation, is to bypass the need for a local registry, and to restore the images directly to the containerd library.
+
+Restore the OpenFaaS Edge images:
+
+```bash
+faas-cli airfaas restore \
+  --containerd \
+  --path ./images/openfaas-edge/images.json \
+  --namespace openfaas
+```
+
+If you need to restore any of your own functions, make sure you pass the `--namespace` flag, i.e.
+
+```bash
+faas-cli airfaas restore \
+  --containerd \
+  --path ./images/functions/images.json \
+  --namespace openfaas-fn
+```
+
+### Restore images to a local registry
+
+You can restore the images to a local registry using the following command:
+
+```bash
+faas-cli airfaas restore \
+  --path ./images/openfaas-edge/images.json
+```
+
+To update the original registry references i.e. `ghcr.io/openfaasltd` to your own i.e. `localhost:5000/openfaasltd`, you can use the `--prefix` flag.
+
+When using a self-signed certificate, use the `--insecure-registry` flag to skip TLS verification.
+
+Further examples are available via the `--help` flag.
+
+## Perform the installation
+
+### Debian-based systems
+
+If you're using an Operating System such as Ubuntu, you can export the installation bundle and copy it to the air-gapped machine, then perform the installation as normal.
+
+Download the installation package:
+
+```bash
+mkdir -p ./faasd-pro
+arkade oci install --path ./faasd-pro ghcr.io/openfaasltd/faasd-pro:latest
+```
+
+Then copy the `faasd-pro` directory to the air-gapped machine.
+
+Finally, download the installation script, copy it over:
+
+```bash
+curl -sLSf \
+    https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-edge.sh \
+    -o install-edge.sh
+```
+
+Then run the install-edge.sh script on the remote server:
+
+```bash
+chmod +x install-edge.sh
+sudo -E ./install-edge.sh
+```
+
+### RHEL-like systems
+
+For Operating Systems such as Oracle Linux, Alma Linux, and Rocky Linux you can use our official rpm package to install OpenFaaS Edge.
+
+Download it on a machine with Internet access, transfer it to the air-gapped machine, and install it using:
+
+```bash
+arkade oci install --path . ghcr.io/openfaasltd/faasd-pro-rpm:latest
+```
+
+Then copy all .rpm files to the air-gapped machine, and run:
+
+```bash
+dnf install openfaas-edge-*.rpm
+```
+
+Follow any additional prompts and instructions.
+
+It is possible to specify a different version of the package by changing the `latest` tag to a specific version, e.g. `v0.2.16`.
+
+Versions can be inspected using the crane tool and `crane ls ghcr.io/openfaasltd/faasd-pro-rpm`.
+