Skip to content

Commit b1b48cb

Browse files
committed
Add page on airfaas, remove page on federated gateway
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 9664f31 commit b1b48cb

File tree

4 files changed

+85
-13
lines changed

4 files changed

+85
-13
lines changed

docs/deployment/pro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Then add the Helm chart repo, update it and deploy the chart, running `helm repo
120120
```sh
121121
helm repo update
122122

123-
helm upgrade openfaas \
123+
helm upgrade --install openfaas \
124124
--install openfaas/openfaas \
125125
--namespace openfaas \
126126
-f ./values-custom.yaml

docs/openfaas-pro/airgap.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
## Airgapped OpenFaaS
2+
3+
OpenFaaS Standard and OpenFaaS for Enterprises are licensed for use within an airgap when purchased on an annual basis via invoice.
4+
5+
You can use your own choice of tooling to mirror images and bundle the Helm chart(s) required for your installations, or you can use our own purpose-built airfaas tool.
6+
7+
### Mirror OpenFaaS images into your own registry
8+
9+
If your organisation has a policy of mirroring all consumed images from vendors into a private registry, then `airfaas mirror` can help you with this, even if you don't install OpenFaaS into an airgapped environment.
10+
11+
```bash
12+
faas-cli plugin get airfaas
13+
```
14+
15+
Mirror all images for the given chart/index to a custom registry:
16+
17+
```bash
18+
airfaas download images \
19+
openfaas/openfaas \
20+
--registry-prefix ttl.sh
21+
```
22+
23+
Mirror the Kafka-connector's images:
24+
25+
```bash
26+
airfaas download images \
27+
openfaas/kafka-connector \
28+
--registry-prefix ttl.sh
29+
```
30+
31+
The `--url` flag can be used to specify a different Helm chart repository. The only requirement is that images are stored in the same format as OpenFaaS: i.e. `image:` or `componentName.image:`.
32+
33+
After the mirroring is complete, you'll receive output in the format of a values.yaml file, which you can add to your `helm upgrade --install` command.
34+
35+
```bash
36+
$ faas-cli airfaas mirror openfaas/openfaas --to https://aws_account_id.dkr.ecr.us-west-2.amazonaws.com/openfaas
37+
Mirrored 18 images in 3m7.242s
38+
```
39+
40+
Then copy the below to i.e. `values-mirror.yaml`:
41+
42+
```yaml
43+
gatewayPro:
44+
image: aws_account_id.dkr.ecr.us-west-2.amazonaws.com/openfaas/openfaasltd/gateway:0.4.27
45+
alertmanager:
46+
image: aws_account_id.dkr.ecr.us-west-2.amazonaws.com/openfaas/prom/alertmanager:v0.27.0
47+
autoscaler:
48+
image: aws_account_id.dkr.ecr.us-west-2.amazonaws.com/openfaas/openfaasltd/autoscaler:0.3.6
49+
```
50+
51+
Your final OpenFaaS Pro installation may look something like, where you use the standard `values-pro.yaml` file, your own settings in `values-staging.yaml`, then finally the mirrored images overlaid over that in `values-mirror.yaml`:
52+
53+
```bash
54+
helm upgrade --install openfaas \
55+
--install openfaas/openfaas \
56+
--namespace openfaas \
57+
-f values-pro.yaml \
58+
-f values-staging.yaml \
59+
-f values-mirror.yaml
60+
```
61+
62+
### Perform an offline installation
63+
64+
Airfaas can perform an offline installation of OpenFaaS into an airgapped environment. It will bundle the Helm chart(s) and images required for the installation, then restore the images into an offline registry, and install OpenFaaS using the Helm chart(s) from the local filesystem.
65+
66+
![Conceptual download process](https://www.openfaas.com/images/2024-04-airgap/download.png)
67+
> The download process
68+
69+
![Conceptual upload process](https://www.openfaas.com/images/2024-04-airgap/restore.png)
70+
> The upload / installation process
71+
72+
Follow the instructions in: [Deploy airgapped Serverless Functions with OpenFaaS](https://www.openfaas.com/blog/airgap-serverless-functions/)

docs/openfaas-pro/introduction.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Efficiency and redundancy:
1818
* [Scale idle functions to zero](/openfaas-pro/scale-to-zero) to save on compute costs, increase efficiency and lower your threat profile
1919
* [Retry failed invocations for functions](/openfaas-pro/retries) to handle issues with downstream APIs and back-pressure on concurrency-limited functions
2020
* CPU and RAM usage metrics for every function to measure usage and fine-tune limits
21-
* GitOps compatibility with the Function CustomResource, with Helm, ArgoCD and FluxCD.
21+
* [GitOps compatibility with the Function CustomResource, with Helm, ArgoCD and FluxCD](/openfaas-pro/function-crd)
2222

2323
[![Scaling that works for various types of functions](https://pbs.twimg.com/media/FJ9EBVdWQAM9DeW?format=jpg&name=medium)](/architecture/autoscaling/)
2424
> Scaling that works for various types of functions
@@ -38,7 +38,8 @@ The OpenFaaS dashboard integrates with CPU & RAM usage metrics, and container lo
3838
Event-driven programming and triggers:
3939

4040
* [Trigger functions via Kafka](/openfaas-pro/kafka-events) for event-driven functions and to integrate with your existing systems
41-
* [Trigger functions from AWS SQS](/openfaas-pro/sqs-events) to integrate with events from AWS.
41+
* [Trigger functions from AWS SQS](/openfaas-pro/sqs-events) to integrate with events from AWS services via a managed queue.
42+
* [Trigger functions from AWS SNS](/openfaas-pro/sns-events) to integrate with events from AWS managed services via pub/sub.
4243

4344
### Workload tuning
4445

@@ -50,14 +51,15 @@ To avoid errors when scaling up or down, you may need to tune your function's co
5051
* Custom TerminationGracePeriod for draining work for long running functions
5152
* Custom support for probing Istio endpoints during scale from zero
5253

53-
Read more: [OpenFaaS workloads](https://docs.openfaas.com/reference/workloads/) and [Custom Profiles](https://docs.openfaas.com/reference/profiles/#use-an-alternative-runtimeclass)
54+
Read more: [OpenFaaS workloads](/reference/workloads/) and [OpenFaaS Profiles](/reference/profiles/#use-an-alternative-runtimeclass)
5455

5556
### Enterprise security
5657

57-
* Identity and Access Management (IAM)
58-
* Single Sign On with OpenID Connect (OIDC)
58+
* [Airgapped/offline installations and image mirroring](/openfaas-pro/airgap)
59+
* [Identity and Access Management (IAM)](/openfaas-pro/iam/overview)
60+
* [Single Sign On with OpenID Connect (OIDC)](/openfaas-pro/sso/overview)
5961

60-
[Learn more about IAM for OpenFaaS](https://docs.openfaas.com/openfaas-pro/iam/overview/)
62+
[Learn more about IAM for OpenFaaS](/openfaas-pro/iam/overview)
6163

6264
### Platform building features
6365

@@ -112,10 +114,9 @@ Recently released:
112114
* GPU scheduling support for functions via Profiles i.e. `nvidia.com/gpu: 1` (Mar 2024)
113115

114116
Upcoming:
115-
117+
* Built-in function authentication with IAM for OpenFaaS (in preview)
116118
* Conversion to structured/JSON logging of OpenFaaS Pro components (ongoing - 80% complete)
117119
* Dynamic, dedicated Async queues for each function, including queued-based scaling (R&D phase)
118-
* Function authentication with IAM for OpenFaaS
119120
* Go SDK for the Function Builder API
120121
* Additional event triggers i.e. AMQP event trigger for RabbitMQ and Azure Service Bus and Google PubSub (added upon request)
121122

@@ -127,14 +128,12 @@ If you're already a customer, we welcome suggestions for the roadmap in [the Cus
127128

128129
!!! info "Do we need the Community Edition or Pro?"
129130

130-
OpenFaaS Community Edition (CE) is meant for open-source developers and initial exploration of functions, OpenFaaS Pro is meant for production.
131+
OpenFaaS Community Edition (CE) is licensed for open-source developers and initial exploration of functions, OpenFaaS Pro is licensed for production.
131132

132133
OpenFaaS Pro is a distribution of OpenFaaS with additional features and configurations that we believe customers need to operate a product or service in production.
133134

134135
As we tune OpenFaaS Pro for our existing customers, we improve it for everyone else at the same time - writing articles, tuning configuration and adding key features.
135136

136-
We see it as the start of a two-way relationship and an opportunity to collaborate directly with our team.
137-
138137
**Support**
139138

140139
All the items below are included in the standard self-service/license-only package, unless specifically stated as requiring an Enterprise Service Agreement.

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ nav:
161161
- Postgres events: ./openfaas-pro/postgres-events.md
162162
- AWS SQS events: ./openfaas-pro/sqs-events.md
163163
- AWS SNS events: ./openfaas-pro/sns-events.md
164-
- Federated Gateway: ./openfaas-pro/federated-gateway.md
164+
# - Federated Gateway: ./openfaas-pro/federated-gateway.md
165+
- Airgapped installation: ./openfaas-pro/airgap.md
165166
- Function Builder API: ./openfaas-pro/builder.md
166167
- Billing metrics: ./openfaas-pro/billing-metrics.md
167168
- Grafana dashboards: ./openfaas-pro/grafana-dashboards.md

0 commit comments

Comments
 (0)