Skip to content

Commit 76f5362

Browse files
authored
Merge pull request #2768 from headlamp-k8s/docs-for-flatpak-external-tools
docs: Add section on running external tools in flatpak to installation
2 parents 766afe9 + 890cd3b commit 76f5362

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/installation/desktop/linux-installation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,19 @@ To upgrading Headlamp when it's installed via Flatpak, run:
3030
flatpak update io.kinvolk.Headlamp
3131
```
3232

33+
### Running External Tools
34+
35+
When using tools like `az`, `aws`, `gcloud`, etc. from e.g. kubeconfig user's
36+
exec, Flatpak will need to run these tools from outside the sandbox. For that
37+
to work, you need to grant the *talk-name* of *org.freedesktop.Flatpak*. To do
38+
this, use the [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal)
39+
application to change Headlamp's permissions, or run the following command
40+
(before running Headlamp):
41+
42+
```shell
43+
sudo flatpak override --talk-name=org.freedesktop.Flatpak io.kinvolk.Headlamp
44+
```
45+
3346
## AppImage
3447

3548
Headlamp can be used as an [AppImage](https://appimage.org/) by downloading and running it directly.

docs/platforms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ We test on MacOS, various flavours of Linux, and Windows. Headlamp runs in the b
4747
| MacOS (arm, x86) | ✔️ |
4848
| Ubuntu 20.04, 22.04, 22.10 | ✔️ |
4949
| Fedora | ✔️ |
50-
| Flatpak | ✔️ | When using external tools like `az`, `aws`, `gcloud`, etc., please run `sudo flatpak override --talk-name=org.freedesktop.Flatpak io.kinvolk.Headlamp` before running Headlamp, so those tools can be called from within the sandbox. |
50+
| Flatpak | ✔️ | See [running external tools from Headlamp](/docs/latest/installation/desktop/linux-installation#running-external-tools) if you need to use `az`, `aws`, `gcloud`, etc. in your kubeconfig |
5151

5252

5353
## CNCF and Kubernetes Integrations

0 commit comments

Comments
 (0)