Skip to content

Commit a9715ee

Browse files
corneliusludmannroboquat
authored andcommitted
[installer] Add air-gap instructions
/werft no-preview
1 parent ce7f01c commit a9715ee

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

install/installer/docs/air-gap.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Installing Gitpod in an air-gap network with the Gitpod Installer
2+
3+
## Mirror Gitpod Images
4+
5+
You need a registry that is reachable in your network. Add the domain of your registry to the Gitpod config `gitpod.config.yaml` like this:
6+
```yaml
7+
repository: your-registry.example.com
8+
```
9+
10+
The command `gitpod-installer mirror list` gives you a list of all images needed by Gitpod. You can run the following code to pull the needed images and push them to your registry:
11+
12+
```
13+
for row in $(gitpod-installer mirror list --config gitpod.config.yaml | jq -c '.[]'); do
14+
original=$(echo $row | jq -r '.original')
15+
target=$(echo $row | jq -r '.target')
16+
17+
docker pull $original
18+
docker tag $original $target
19+
docker push $target
20+
done
21+
```
22+
23+
## Install Gitpod in Air-Gap Mode
24+
25+
To install Gitpod in an air-gap network, you need to configure the repository of the images needed by Gitpod (see previous step) and disable the `definitely-gp` feature. Add this to your Gitpod config:
26+
27+
```yaml
28+
repository: your-registry.example.com
29+
disableDefinitelyGp: true
30+
```
31+
32+
That's it. Run the following commands as usual and Gitpod fetches the images from your registry and does not need internet access to operate:
33+
34+
```
35+
gitpod-installer render --config gitpod.config.yaml > gitpod.yaml
36+
kubectl apply -f gitpod.yaml
37+
```

0 commit comments

Comments
 (0)