mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
4f4134b000
Currently, the relationship between gateways, sites and resources is modeled in an ad-hoc fashion within `tunnel_test`. The correct relationship is: - The portal knows about all sites. - A resource can only be added for an existing site. - One or more gateways belong to a single site. To express this relationship in `tunnel_test`, we first sample between 1 and 3 sites. Then we sample between 1 and 3 gateways and assign them a site each. When adding new resources, we sample a site that the resource belongs to. Upon a connection intent, we sample a gateway from all gateways that belong to the site that the resource is defined in. In addition, this patch-set removes multi-site resources from the `tunnel_test`. As far as connlib's routing logic is concerned, we route packets to a resource on a selected gateway. How the portal selected the site of the gateway doesn't matter to connlib and thus doesn't need to be covered in these tests.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null