mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 18:18:55 +00:00

Files

Reactor Scram 3a67eacfbe refactor(linux-client): replace client-tunnel with headless-client which is the same thing (#4516 )

Unfortunately I had to keep `linux-client` to get the compatibility
tests to pass. #4578 aims to remove that package.

Please add to this list if you think of anything:

```[tasklist]
# Things that may break that CI/CD won't catch
- [ ] Github release artifacts
- [ ] Knowledge base 
- [ ] Docker images
- [ ] Docker containers
- [ ] Existing `linux-client` users
- [ ] Anything that downloads ghcr artifacts
- [ ] Nix (Not sure if it's built in CI. It had a merge conflict)
```

Refs #4515, and #3712, #3782

I think this is what Thomas and I agreed on in Slack / Github

---------

Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com>
Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

2024-04-10 22:01:55 +00:00

1.6 KiB

Raw Blame History

Linux client use cases

This document lists the most common use cases that we could test. Exhaustively tesing everything would be difficult. These cases at least exercise every feature once, although they don't exercise every combination of features.

Alpine Docker container, CLI only, resolv.conf DNS (Easy to test)
Exe only, Manual startup, CLI only, No DNS (Embedded / IoT)
Exe only, Manual startup, CLI only, resolv.conf DNS (Embedded / IoT)
Package manager installation, activated by NetworkManager, CLI only, NetworkManager DNS (To get NM working before committing to a GUI)
Package manager installation, runs as always-on systemd service unit, Tauri GUI, resolvectl DNS (A desktop that doesn't have NetworkManager)
Package manager installation, runs as systemd service unit, activated by NetworkManager, Tauri GUI and NetworkManager interfaces, NetworkManager DNS (The "Make me one with everything" option)

If we don't test a real package manager (e.g. apt, yum) we can consider a tarball artifact to be a "package" and untar it in CI to get the systemd and NetworkManager service files. cargo-deb does work well for Debian systems.

Code paths to be exercised

Install method

Exe only
Package manager (e.g. apt / yum) or equivalent manual install
Docker (Unsupported in prod, only for testing?)

Startup

Manual
Systemd service unit
D-Bus service activation by NetworkManager

Interface

CLI only
Tauri GUI
NetworkManager plugin

DNS control method

None
resolv.conf
resolvectl
NetworkManager (Ubuntu 20.04 Desktop and Debian 12 with XFCE both come with NM by default, so it's very popular)

1.6 KiB Raw Blame History