You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update the section on mirroring images for OpenFaaS Pro into your own
regsitry to reflect the latest changes to the airfaas cli.
Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
Copy file name to clipboardExpand all lines: docs/openfaas-pro/airgap.md
+25-22Lines changed: 25 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
##Air Gap with Kubernetes
1
+
# Air Gap with Kubernetes
2
2
3
3
OpenFaaS Standard and OpenFaaS for Enterprises are licensed for use within an airgap when purchased on an annual basis via invoice.
4
4
5
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
6
7
-
###Mirror OpenFaaS images into your own registry
7
+
## Mirror OpenFaaS images into your own registry
8
8
9
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
10
@@ -15,38 +15,32 @@ faas-cli plugin get airfaas
15
15
Mirror all images for the given chart/index to a custom registry:
16
16
17
17
```bash
18
-
faas-cli airfaas download images \
19
-
openfaas/openfaas \
20
-
--registry-prefix ttl.sh
18
+
faas-cli airfaas mirror \
19
+
openfaas/openfaas \
20
+
--registry ttl.sh
21
21
```
22
22
23
23
Mirror the Kafka-connector's images:
24
24
25
25
```bash
26
-
faas-cli airfaas download images \
27
-
openfaas/kafka-connector \
28
-
--registry-prefix ttl.sh
26
+
faas-cli airfaas mirror \
27
+
openfaas/kafka-connector \
28
+
--registry ttl.sh
29
29
```
30
30
31
+
The `-f/--file` flag can be used to write a `values.yaml` file with the mirrored image names, which can be used as an overlay to your existing `values.yaml` file when deploying OpenFaaS.
31
32
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
33
34
Note: if you receive an access denied error from ghcr.io, it's most likely because you have an old, expired access token in your local Docker config or keychain. Run `docker logout ghcr.io` to clear the token and try again.
34
35
35
-
## Consume the mirrored images from your own registry
36
-
37
-
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.
### Consume the mirrored images from your own registry
43
37
44
38
There are two options for consuming the mirrored images:
45
39
46
40
1. Use the `registryPrefix` setting to add a prefixed string i.e. your registry to the image name across all images i.e. `registryPrefix: aws_account_id.dkr.ecr.us-west-2.amazonaws.com/openfaas`
47
-
2. Use the generated text produced by `airfaas` as an overlay to your existing `values.yaml` file.
41
+
2. Use the generated generated values.yaml file produced by running `arifaas mirror` with the `--file` flag as an overlay to your existing `values.yaml` file.
For certain registries such as AWS ECR, it's possible to use the ambient AWS IAM credentials to authenticate the registry without overriding the default `imagePullSecrets` setting.
63
57
64
-
### Option 2 - Use the generated text produced by `airfaas` as an overlay to your existing `values.yaml` file.
58
+
#### Option 2 - Use the generated values file produced by `airfaas` as an overlay to your existing `values.yaml` file.
59
+
60
+
Run `faas-cli airfaas mirror` with the `--file` flag to generate a values.yaml file with the mirrored image names e.g:
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.
91
94
@@ -95,4 +98,4 @@ Airfaas can perform an offline installation of OpenFaaS into an airgapped enviro
0 commit comments