Files
teleport/lib/automaticupgrades/config.go
T
Hugo Shaka c20095e9d6 Align semver libs (#52795)
* Convert autoupdate version handling to coreos/go-semver

* get the right version in installer endpoint + get rid of x/mod/semver

* depguard x/mod/semver

* Add nolint rules for existing x/mod/semver usages

* Add depguard explanation
2025-03-19 18:03:35 +00:00

107 lines
3.5 KiB
Go

/*
* Teleport
* Copyright (C) 2023 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package automaticupgrades
import (
"context"
"log/slog"
"os"
"os/exec"
"strconv"
"github.com/coreos/go-semver/semver"
"github.com/gravitational/teleport/lib/automaticupgrades/version"
)
const (
// EnvUpgrader environment variable specifies the external upgrader type
// Ex: unit, kube
EnvUpgrader = "TELEPORT_EXT_UPGRADER"
// EnvUpgraderVersion environment variable specifies the external upgrader version
// Ex: v14.3.6
EnvUpgraderVersion = "TELEPORT_EXT_UPGRADER_VERSION"
// automaticUpgradesEnvar defines the env var to lookup when deciding whether to enable AutomaticUpgrades feature.
automaticUpgradesEnvar = "TELEPORT_AUTOMATIC_UPGRADES"
// automaticUpgradesChannelEnvar defines a customer automatic upgrades version release channel.
automaticUpgradesChannelEnvar = "TELEPORT_AUTOMATIC_UPGRADES_CHANNEL"
// teleportUpgradeScript defines the default teleport-upgrade script path
teleportUpgradeScript = "/usr/sbin/teleport-upgrade"
)
// IsEnabled reads the TELEPORT_AUTOMATIC_UPGRADES and returns whether Automatic Upgrades are enabled or disabled.
// An error is logged (warning) if the variable is present but its value could not be converted into a boolean.
// Acceptable values for TELEPORT_AUTOMATIC_UPGRADES are:
// 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False
func IsEnabled() bool {
autoUpgradesEnv := os.Getenv(automaticUpgradesEnvar)
if autoUpgradesEnv == "" {
return false
}
automaticUpgrades, err := strconv.ParseBool(autoUpgradesEnv)
if err != nil {
slog.WarnContext(context.Background(), "unexpected value for TELEPORT_AUTOMATIC_UPGRADES environment variable", "error", err)
return false
}
return automaticUpgrades
}
// GetChannel returns the TELEPORT_AUTOMATIC_UPGRADES_CHANNEL value.
// Example of an acceptable value for TELEPORT_AUTOMATIC_UPGRADES_CHANNEL is:
// https://updates.releases.teleport.dev/v1/stable/cloud
func GetChannel() string {
return os.Getenv(automaticUpgradesChannelEnvar)
}
// GetUpgraderVersion returns the teleport upgrader version
func GetUpgraderVersion(ctx context.Context) *semver.Version {
if os.Getenv(EnvUpgrader) == "unit" {
out, err := exec.CommandContext(ctx, teleportUpgradeScript, "version").Output()
if err != nil {
slog.DebugContext(ctx, "Failed to exec /usr/sbin/teleport-upgrade version command", "error", err)
return nil
}
ver, err := version.EnsureSemver(string(out))
if err != nil {
slog.DebugContext(ctx, "Unexpected teleport-upgrade version", "error", err)
return nil
}
return ver
}
env := os.Getenv(EnvUpgraderVersion)
if env == "" {
return nil
}
ver, err := version.EnsureSemver(env)
if err != nil {
slog.WarnContext(ctx, "Unexpected updater version in env var",
"error", err,
"env_name", os.Getenv(EnvUpgraderVersion),
"env_value", env)
return nil
}
return ver
}