From 95824ac2ec1d029a137e9c7eb4b1e93525722296 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 12 Jun 2022 13:12:43 +0000 Subject: [PATCH 1/5] MOve ephemeral inactivity config check to all the other config check --- cmd/headscale/cli/utils.go | 17 ----------------- config.go | 11 +++++++++++ 2 files changed, 11 insertions(+), 17 deletions(-) diff --git a/cmd/headscale/cli/utils.go b/cmd/headscale/cli/utils.go index f5c679c2..327c8c14 100644 --- a/cmd/headscale/cli/utils.go +++ b/cmd/headscale/cli/utils.go @@ -7,12 +7,10 @@ import ( "fmt" "os" "reflect" - "time" "github.com/juanfont/headscale" v1 "github.com/juanfont/headscale/gen/go/headscale/v1" "github.com/rs/zerolog/log" - "github.com/spf13/viper" "google.golang.org/grpc" "google.golang.org/grpc/credentials" "google.golang.org/grpc/credentials/insecure" @@ -29,21 +27,6 @@ func getHeadscaleApp() (*headscale.Headscale, error) { return nil, fmt.Errorf("failed to load configuration while creating headscale instance: %w", err) } - // Minimum inactivity time out is keepalive timeout (60s) plus a few seconds - // to avoid races - minInactivityTimeout, _ := time.ParseDuration("65s") - if viper.GetDuration("ephemeral_node_inactivity_timeout") <= minInactivityTimeout { - // TODO: Find a better way to return this text - //nolint - err := fmt.Errorf( - "ephemeral_node_inactivity_timeout (%s) is set too low, must be more than %s", - viper.GetString("ephemeral_node_inactivity_timeout"), - minInactivityTimeout, - ) - - return nil, err - } - app, err := headscale.NewHeadscale(cfg) if err != nil { return nil, err diff --git a/config.go b/config.go index 917b4734..0c600c20 100644 --- a/config.go +++ b/config.go @@ -202,6 +202,17 @@ func LoadConfig(path string, isFile bool) error { EnforcedClientAuth) } + // Minimum inactivity time out is keepalive timeout (60s) plus a few seconds + // to avoid races + minInactivityTimeout, _ := time.ParseDuration("65s") + if viper.GetDuration("ephemeral_node_inactivity_timeout") <= minInactivityTimeout { + errorText += fmt.Sprintf( + "Fatal config error: ephemeral_node_inactivity_timeout (%s) is set too low, must be more than %s", + viper.GetString("ephemeral_node_inactivity_timeout"), + minInactivityTimeout, + ) + } + if errorText != "" { //nolint return errors.New(strings.TrimSuffix(errorText, "\n")) From fd3a1c13e31586a7f4e38ec5d6209cfae6162df6 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 12 Jun 2022 13:12:53 +0000 Subject: [PATCH 2/5] Add a default to ephemeral_node_inactivity_timeout --- config.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/config.go b/config.go index 0c600c20..212fe154 100644 --- a/config.go +++ b/config.go @@ -160,6 +160,8 @@ func LoadConfig(path string, isFile bool) error { viper.SetDefault("logtail.enabled", false) viper.SetDefault("randomize_client_port", false) + viper.SetDefault("ephemeral_node_inactivity_timeout", "120s") + if err := viper.ReadInConfig(); err != nil { return fmt.Errorf("fatal error reading config file: %w", err) } From c95bce4aea6cdd104a5f0119cfaa80606850424f Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 12 Jun 2022 13:18:49 +0000 Subject: [PATCH 3/5] Update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c34e6f54..04af6306 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ - Use new ACL syntax [#618](https://github.com/juanfont/headscale/pull/618) - Add -c option to specify config file from command line [#285](https://github.com/juanfont/headscale/issues/285) [#612](https://github.com/juanfont/headscale/pull/601) - Add configuration option to allow Tailscale clients to use a random WireGuard port. [kb/1181/firewalls](https://tailscale.com/kb/1181/firewalls) [#624](https://github.com/juanfont/headscale/pull/624) +- Improve obtuse UX regarding missing configuration (`ephemeral_node_inactivity_timeout` not set) [#639](https://github.com/juanfont/headscale/pull/639) ## 0.15.0 (2022-03-20) From 76195bb3ac98dfdd38aea37ef6e11cb36542019d Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 12 Jun 2022 13:32:16 +0000 Subject: [PATCH 4/5] Add warn if configuration could not be found --- config.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/config.go b/config.go index 212fe154..332f79f7 100644 --- a/config.go +++ b/config.go @@ -163,9 +163,13 @@ func LoadConfig(path string, isFile bool) error { viper.SetDefault("ephemeral_node_inactivity_timeout", "120s") if err := viper.ReadInConfig(); err != nil { + log.Warn().Err(err).Msg("Failed to read configuration from disk") + return fmt.Errorf("fatal error reading config file: %w", err) } + log.Debug().Str("path", viper.ConfigFileUsed()).Msg("Read configuration from disk") + // Collect any validation errors and return them all at once var errorText string if (viper.GetString("tls_letsencrypt_hostname") != "") && From 86503289226265f719e98490d26d5f4110a9108f Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 12 Jun 2022 16:39:16 +0000 Subject: [PATCH 5/5] Remove debug output, it runs before we disable it --- config.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/config.go b/config.go index 332f79f7..9e71a750 100644 --- a/config.go +++ b/config.go @@ -168,8 +168,6 @@ func LoadConfig(path string, isFile bool) error { return fmt.Errorf("fatal error reading config file: %w", err) } - log.Debug().Str("path", viper.ConfigFileUsed()).Msg("Read configuration from disk") - // Collect any validation errors and return them all at once var errorText string if (viper.GetString("tls_letsencrypt_hostname") != "") &&