Changelog
This release is mainly a code reorganisation and refactoring, significantly improving the maintainability of the codebase. This should allow us to improve further and make it easier for the maintainers to keep on top of the project.
Please remember to always back up your database between versions
Here is a short summary of the broad topics of changes:
Code has been organised into modules, reducing use of global variables/objects, isolating concerns and “putting the right things in the logical place”.
The new policy and mapper package, containing the ACL/Policy logic and the logic for creating the data served to clients (the network “map”) has been rewritten and improved. This change has allowed us to finish SSH support and add additional tests throughout the code to ensure correctness.
The “poller”, or streaming logic has been rewritten and instead of keeping track of the latest updates, checking at a fixed interval, it now uses go channels, implemented in our new notifier package and it allows us to send updates to connected clients immediately. This should both improve performance and potential latency before a client picks up an update.
Headscale now supports sending “delta” updates, thanks to the new mapper and poller logic, allowing us to only inform nodes about new nodes, changed nodes and removed nodes. Previously we sent the entire state of the network every time an update was due.
While we have a pretty good test harness for validating our changes, we have rewritten over 10000 lines of code and bugs are expected. We need help testing this release. In addition, while we think the performance should in general be better, there might be regressions in parts of the platform, particularly where we prioritised correctness over speed.
There are also several bugfixes that has been encountered and fixed as part of implementing these changes, particularly
after improving the test harness as part of adopting #1460.
BREAKING
- Code reorganisation, a lot of code has moved, please review the following PRs accordingly #1473
- API: Machine is now Node #1553
Changes
- Make the OIDC callback page better #1484
- SSH support #1487
- State management has been improved #1492
- Use error group handling to ensure tests actually pass #1535 based on #1460
- Fix hang on SIGTERM #1492 taken from #1480
- Send logs to stderr by default #1524
Commits
- 56cf4b0 Add github stale action (#1559)
- 084d1d5 Add initial test for mapresponse
- 53a9e28 Add missing return in shutdown
- 36c9b5c Adjust the template for the OIDC callback login page
- 9c425a1 Finish SSH
- 6567af7 Fix IP Address Order Bug
- c72401a Fix IPv6 in ACLs
- fb203a2 Format code
- 1766e6b General fixups discovered by checking errors
- b4a4d0f Handle errors in integration test setups
- bce8427 Map route into machine
- 3bef63b Remove LastSuccessfulUpdate from Machine
- f9f6e15 Remove complicated testcase obsoleated by tailNode test
- 387aa03 Remove database from Mapper
- 725bbd7 Remove variables and leftovers of pregenerated ACL content
- 0030af3 Rename Machine to Node (#1553)
- 66ff1fc Replace the timestamp based state system
- c957f89 Return simple responses immediatly
- e3acc95 Send logs to stderr, rather than stdout
- 64c0a65 Set online status in lite requests (#1555)
- feb1536 Split code into modules
- 4b65cf4 Split up MapResponse
- 3b0749a Update packetfilter when peers change
- 7edc953 Update tsic.go
- 4c12c02 Upgrade go and debian in headscale docker
- b27e8ab add 0.23.0 changelog entry (#1557)
- b7c6e0e add annoying linter to golangci
- 78268d7 add debug option to save all map responses
- 665a3cc add generic logerr func to shorten code
- f73172f add less/jq to hs debug container
- 9ccf87c add lock around saving ts clients
- 9c5301e add maprequest to all mapper calls
- 84fbca9 add note about db backup to changelog (#1560)
- 591ff8d add pprof endpoint
- 13fe4ec add script to run integration tests
- 47255d2 add script to run integration tests
- e0ba325 additional debug logging, use mapper pointer
- 14e29a7 create DB struct
- a1a3ff4 disable online map by default for now
- 699655a docs(README): update contributors
- 6cd0f77 docs(README): update contributors (#1558)
- 593b3ad filter out peers without endpoints
- d36336a fix lint
- 13a7285 fix lint
- 12a04f9 fix relogin test, pass accept route flag
- 056d3a8 format with prettier 3.0
- ca4a48a gitignore infolder tailscale
- 2434d76 give ci more tollerance for timeouts
- 096ac31 handle route updates correctly
- 217ccd6 improve debug logging, rw lock for notifier
- f8a58aa introduce a version subset we must test against
- f7f472a introduce mapper package
- eff529f introduce rw lock for db, ish...
- db6cf4a make GenerateFilterRules take machine and peers
- 161243c make generateFilterRules take machine and peers
- 2675ff4 make parse destination string into a func
- 155cc07 migrate last acl tests away from database
- 2289a2a move Config definitions into types
- 432e975 move MapResponse peer logic into function and reuse
- 8c4c4c8 move derp.go to derp module
- 80ea87c move derp_server to derp server module
- c1218ad move reminder of dns funcs to util
- e55fe06 only send lite map responses when omitpeers
- 88ca250 only send relevant filterrules to nodes
- 14f8c1b order path
- 2d87085 rearrange channel closing defers
- a8079a2 rearrange poll, lock, notify
- e2c08db reduce filter rules at the end, so we filter nodes correctly
- 717abe8 remove "stripEmailDomain" argument
- 5bad48a remove DB dependency of tailNode conversion, add test
- 01b85e5 remove readonly case for mapresponse, dont think it is used (#1556)
- fcdc7a6 remove redundant tests
- e90a669 remove retries for pings in tsic
- 19dc0ac rename acl "get" funcs to "expand" for consistency
- 0562260 rename handler files
- 63caf9a update flake, fix prettier lint
- 3577027 upgrade tailscale
- 23a3adf use cmp.Diff instead of reflect.DeepEqual
- fe75b71 use nix caching and docker caching in CI