From 038eb91191ef0c05a6c609f0d533492857522fa7 Mon Sep 17 00:00:00 2001 From: "Alex Ellis (OpenFaaS Ltd)" Date: Mon, 23 Sep 2024 14:11:45 +0100 Subject: [PATCH] Update script URL for edge Signed-off-by: Alex Ellis (OpenFaaS Ltd) --- README.md | 33 +++++++++++++++++++----- hack/{install-pro.sh => install-edge.sh} | 4 +++ 2 files changed, 30 insertions(+), 7 deletions(-) rename hack/{install-pro.sh => install-edge.sh} (95%) diff --git a/README.md b/README.md index 10a690be..9802ab1b 100644 --- a/README.md +++ b/README.md @@ -121,19 +121,38 @@ View sample pages, reviews and testimonials on Gumroad: ["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else) -### Deploy faasd-pro +### Deploy OpenFaaS Edge (commercial distribution of faasd) -faasd-pro is available for commercial licensing and for individuals to use via GitHub Sponsors on a 25USD/mo and higher tier. +OpenFaaS Edge is a commercial distribution of faasd, with enhancements and additional features from OpenFaaS Pro. The [OpenFaaS Pro EULA applies](https://github.com/openfaas/faas/blob/master/pro/EULA.md). -You get unlimited function deployments, private DNS support, airgap installations and can create multiple namespaces. +* Upgraded Cron Connector, JetStream Queue Worker and Classic Scale to Zero from OpenFaaS Standard +* No limit on number of functions +* Configure private DNS servers +* Airgap-friendly with installation bundled in an OCI image +* Multiple namespace support -```bash -curl -sLS https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-pro.sh -o install-pro.sh -chmod +x install-pro.sh +This version is intended for resale as part of a wider solution, and to be deployed both into industrial and on-premises environments. + +Individual [GitHub Sponsors of OpenFaaS](https://github.com/sponsors/openfaas) (25 USD / mo and higher) can use OpenFaaS Edge for personal use. -sudo -E ./install-pro.sh +You can install OpenFaaS Edge with the following script: + +```bash +curl -sLSf \ + https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-edge.sh \ + -o install-edge.sh && \ +chmod +x install-edge.sh +sudo -E ./install-edge.sh ``` +*For an offline installation* + +Copy the OCI bundle and the install-edge.sh script to the remote server. + +Then mirror the various images from docker-compose.yaml into your private registry, and update the references from i.e. `image: ghcr.io/openfaasltd/gateway` to the equivalents in your registry. + +If your system is unable to install apt, yum, or pacman packages, due to limited network access, then set the `SKIP_OS` environment to 1. The list of packages is available in the `install_required_packages` section of the script. + ### Deploy faasd CE faasd-ce supports 15 functions and needs a computer with a stable Internet connection to run. There are some restrictions on commercial use, but [individuals and certain small businesses can use it for free](EULA.md). diff --git a/hack/install-pro.sh b/hack/install-edge.sh similarity index 95% rename from hack/install-pro.sh rename to hack/install-edge.sh index 43788468..72e2d042 100644 --- a/hack/install-pro.sh +++ b/hack/install-edge.sh @@ -37,6 +37,10 @@ install_required_packages() { fi } +echo "OpenFaaS Edge (based upon faasd and OpenFaaS Standard)" +echo "" +echo "" + echo "1. Installing required OS packages, set SKIP_OS=1 to skip this step" echo ""