You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Andrea Gottardo a8ee83e2c5
health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406)
Updates tailscale/tailscale#4136

This PR is the first round of work to move from encoding health warnings as strings and use structured data instead. The current health package revolves around the idea of Subsystems. Each subsystem can have (or not have) a Go error associated with it. The overall health of the backend is given by the concatenation of all these errors.

This PR polishes the concept of Warnable introduced by @bradfitz a few weeks ago. Each Warnable is a component of the backend (for instance, things like 'dns' or 'magicsock' are Warnables). Each Warnable has a unique identifying code. A Warnable is an entity we can warn the user about, by setting (or unsetting) a WarningState for it. Warnables have:

- an identifying Code, so that the GUI can track them as their WarningStates come and go
- a Title, which the GUIs can use to tell the user what component of the backend is broken
- a Text, which is a function that is called with a set of Args to generate a more detailed error message to explain the unhappy state

Additionally, this PR also begins to send Warnables and their WarningStates through LocalAPI to the clients, using ipn.Notify messages. An ipn.Notify is only issued when a warning is added or removed from the Tracker.

In a next PR, we'll get rid of subsystems entirely, and we'll start using structured warnings for all errors affecting the backend functionality.

Signed-off-by: Andrea Gottardo <andrea@gottardo.me>
3 months ago
.bencher bencher: add config to suppress failures on benchmark regressions. 3 years ago
.github derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
appc appc: log how many routes are being written 4 months ago
atomicfile various: add golangci-lint, fix issues (#7905) 1 year ago
chirp all: update copyright and license headers 2 years ago
client ipn/localapi,client/tailscale,cmd/derper: add WhoIs lookup by nodekey, use in derper 3 months ago
clientupdate ipn/ipnlocal,clientupdate: allow auto-updates in contaienrs (#12391) 4 months ago
cmd util/winutil: add UserProfile type for (un)loading user profiles 3 months ago
control health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406) 3 months ago
derp derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
disco disco: correct noun for nacl box type in disco docs 9 months ago
docs docs/k8s: fix subnet router manifests (#12305) 4 months ago
doctor net/{interfaces,netmon}, all: merge net/interfaces package into net/netmon 5 months ago
drive safesocket: add ConnectContext 3 months ago
envknob envknob: ensure f is not nil before using it 6 months ago
gokrazy gokrazy: update breakglass with now-upstreamed ec2 change 4 months ago
health health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406) 3 months ago
hostinfo hostinfo: use Distro field for distinguishing Windows Server builds 5 months ago
internal/tooldeps various: add golangci-lint, fix issues (#7905) 1 year ago
ipn health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406) 3 months ago
jsondb all: update copyright and license headers 2 years ago
k8s-operator cmd/k8s-operator,k8s-operator: allow proxies accept advertized routes. (#12388) 4 months ago
kube kube: fix typo (#12437) 3 months ago
licenses licenses: update license notices 4 months ago
log net/netns, net/dns/resolver, etc: make netmon required in most places 5 months ago
logpolicy safesocket: add ConnectContext 3 months ago
logtail all: use math/rand/v2 more 4 months ago
metrics all: use Go 1.22 range-over-int 5 months ago
net health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406) 3 months ago
omit cmd/tailscaled, ipn/conffile: support ec2 user-data config file 4 months ago
packages/deb go.mod: upgrade nfpm to v2 (#8786) 1 year ago
paths all: use Go 1.22 range-over-int 5 months ago
portlist all: use Go 1.22 range-over-int 5 months ago
posture xcode/iOS: support serial number collection via MDM on iOS (#11429) 3 months ago
prober cmd/derpprobe: support 'local' derpmap to get derp map via LocalAPI 4 months ago
proxymap wgengine, proxymap: split out port mapping from Engine to new type 1 year ago
publicapi api.md: direct TOC links to new publicapi docs location 4 months ago
release release/dist/qnap: omit .qpkg.codesigning files 5 months ago
safesocket safesocket: add ConnectContext 3 months ago
safeweb safeweb: handle mux pattern collisions more generally (#11801) 5 months ago
scripts derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
smallzstd all: use Go 1.22 range-over-int 5 months ago
ssh/tailssh ssh/tailssh: check IsSELinuxEnforcing in tailscaled process 3 months ago
syncs syncs: fix AtomicValue for interface kinds (#11943) 5 months ago
tailcfg xcode/iOS: support serial number collection via MDM on iOS (#11429) 3 months ago
taildrop all: use new AppendEncode methods available in Go 1.22 (#11079) 7 months ago
tempfork cmd/tailscale: add shell tab-completion 5 months ago
tka ipn/ipnlocal: discard node keys that have been rotated out 4 months ago
tool tool/gocross: add debug data to CGO builds 4 months ago
tsconst all: update copyright and license headers 2 years ago
tsd health, all: remove health.Global, finish plumbing health.Tracker 5 months ago
tsnet tsnet: add a new error when HTTPS enabled but MagicDNC Disabled (#12364) 4 months ago
tstest safesocket: add ConnectContext 3 months ago
tstime all: use math/rand/v2 more 4 months ago
tsweb derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
types ipn,wgengine: remove vestigial Prefs.AllowSingleHosts 4 months ago
util xcode/iOS: support serial number collection via MDM on iOS (#11429) 3 months ago
version version: add GitCommitTime to Meta 4 months ago
wf go.mod, all: move away from inet.af domain seized by Taliban 7 months ago
wgengine health: begin work to use structured health warnings instead of strings, pipe changes into ipn.Notify (#12406) 3 months ago
words words: add some fruit with scales (#8460) 4 months ago
.gitattributes .: add .gitattributes entry to use Go hunk-header driver 3 years ago
.gitignore ssh/tailssh: add integration test 5 months ago
.golangci.yml ci: run 'go vet' in golangci-lint; fix errors in tests 10 months ago
ALPINE.txt ALPINE.txt,Dockerfile{.base},build_docker.sh: bump alpine (#10543) 9 months ago
AUTHORS Move Linux client & common packages into a public repo. 5 years ago
CODEOWNERS CODEOWNERS: add the start of an owners file 1 year ago
CODE_OF_CONDUCT.md Add a code of conduct. 5 years ago
Dockerfile Dockerfile: use Go 1.22 8 months ago
Dockerfile.base ALPINE.txt,Dockerfile{.base},build_docker.sh: bump alpine (#10543) 9 months ago
LICENSE all: update tools that manage copyright headers 2 years ago
Makefile ssh/tailssh: fall back to using su when no TTY available on Linux 4 months ago
PATENTS Move Linux client & common packages into a public repo. 5 years ago
README.md go.mod, README.md: use Go 1.22 8 months ago
SECURITY.md Add a SECURITY.md for vulnerability reports. 5 years ago
VERSION.txt VERSION.txt: this is v1.69.0 (#12441) 3 months ago
api.md api.md: direct TOC links to new publicapi docs location 4 months ago
build_dist.sh cmd/tailscale: add shell tab-completion 5 months ago
build_docker.sh cmd/{k8s-nameserver,k8s-operator},k8s-operator: add a kube nameserver, make operator deploy it (#11919) 5 months ago
flake.lock flake.nix: build tailscale with go 1.22 7 months ago
flake.nix go.mod.sri: update SRI hash for go.mod changes 5 months ago
go.mod derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
go.mod.sri go.mod.sri: update SRI hash for go.mod changes 5 months ago
go.sum derp/xdp,cmd/xdpderper: initial skeleton (#12390) 3 months ago
go.toolchain.branch go.toolchain.rev: bump to Go 1.22.0 (#11055) 8 months ago
go.toolchain.rev go.toolchain.rev: update to go 1.22.4 (#12365) 4 months ago
gomod_test.go go.mod: add test that replace directives aren't added in oss 12 months ago
header.txt cmd/k8s-operator: operator can create subnetrouter (#9505) 9 months ago
pull-toolchain.sh pull-toolchain.sh: don't run update-flake.sh 2 years ago
shell.nix go.mod.sri: update SRI hash for go.mod changes 5 months ago
staticcheck.conf all: cleanup unused code, part 2 (#10670) 9 months ago
update-flake.sh Code Improvements (#11311) 7 months ago
version-embed.go version: return correct Meta.MajorMinorPatch in non-dev builds 2 years ago
version_test.go go.mod,wgengine/netstack: bump gvisor 8 months ago

README.md

Tailscale

https://tailscale.com

Private WireGuard® networks made easy

Overview

This repository contains the majority of Tailscale's open source code. Notably, it includes the tailscaled daemon and the tailscale CLI tool. The tailscaled daemon runs on Linux, Windows, macOS, and to varying degrees on FreeBSD and OpenBSD. The Tailscale iOS and Android apps use this repo's code, but this repo doesn't contain the mobile GUI code.

Other Tailscale repos of note:

For background on which parts of Tailscale are open source and why, see https://tailscale.com/opensource/.

Using

We serve packages for a variety of distros and platforms at https://pkgs.tailscale.com.

Other clients

The macOS, iOS, and Windows clients use the code in this repository but additionally include small GUI wrappers. The GUI wrappers on non-open source platforms are themselves not open source.

Building

We always require the latest Go release, currently Go 1.22. (While we build releases with our Go fork, its use is not required.)

go install tailscale.com/cmd/tailscale{,d}

If you're packaging Tailscale for distribution, use build_dist.sh instead, to burn commit IDs and version info into the binaries:

./build_dist.sh tailscale.com/cmd/tailscale
./build_dist.sh tailscale.com/cmd/tailscaled

If your distro has conventions that preclude the use of build_dist.sh, please do the equivalent of what it does in your distro's way, so that bug reports contain useful version information.

Bugs

Please file any issues about this code or the hosted service on the issue tracker.

Contributing

PRs welcome! But please file bugs. Commit messages should reference bugs.

We require Developer Certificate of Origin Signed-off-by lines in commits.

See git log for our commit message style. It's basically the same as Go's style.

About Us

Tailscale is primarily developed by the people at https://github.com/orgs/tailscale/people. For other contributors, see:

WireGuard is a registered trademark of Jason A. Donenfeld.