Skip to content

[v17] [teleport-update] Additional log message and UX cleanup #53197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sclevine merged 1 commit into from
Mar 19, 2025
Merged

[v17] [teleport-update] Additional log message and UX cleanup #53197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions lib/autoupdate/agent/setup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,12 @@ func (ns *Namespace) Setup(ctx context.Context, path string) error {
}
if present {
if err := oldTimer.Disable(ctx, true); err != nil {
ns.log.ErrorContext(ctx, "The deprecated teleport-ent-updater package is installed on this server, and it cannot be disabled due to an error. You must remove the teleport-ent-updater package after verifying that teleport-update is working.", errorKey, err)
ns.log.ErrorContext(ctx, "The deprecated teleport-ent-updater package is installed on this server, and it cannot be disabled due to an error.", errorKey, err)
ns.log.ErrorContext(ctx, "You must remove the teleport-ent-updater package after verifying that teleport-update is working.", errorKey, err)
} else {
ns.log.WarnContext(ctx, "The deprecated teleport-ent-updater package is installed on this server. This package has been disabled to prevent conflicts. Please remove the teleport-ent-updater package after verifying that teleport-update is working.")
ns.log.WarnContext(ctx, "The deprecated teleport-ent-updater package is installed on this server.")
ns.log.WarnContext(ctx, "The systemd timer included in this package has been disabled to prevent conflicts.", "timer", deprecatedTimerName)
ns.log.WarnContext(ctx, "Please remove the teleport-ent-updater package after verifying that teleport-update is working.")
}
}
}
Expand All @@ -269,7 +272,8 @@ func (ns *Namespace) Teardown(ctx context.Context) error {
Log: ns.log,
}
if err := svc.Disable(ctx, true); err != nil {
ns.log.WarnContext(ctx, "Unable to disable teleport-update systemd timer before removing.", errorKey, err)
ns.log.WarnContext(ctx, "Unable to disable teleport-update systemd timer before removing.")
ns.log.DebugContext(ctx, "Error disabling teleport-update systemd timer.", errorKey, err)
}
for _, p := range []string{
ns.updaterServiceFile,
Expand Down Expand Up @@ -305,9 +309,12 @@ func (ns *Namespace) Teardown(ctx context.Context) error {
}
if present {
if err := oldTimer.Enable(ctx, true); err != nil {
ns.log.ErrorContext(ctx, "The deprecated teleport-ent-updater package is installed on this server, and it cannot be re-enabled due to an error. Please fix the teleport-ent-updater package if you intend to use the deprecated updater.", errorKey, err)
ns.log.ErrorContext(ctx, "The deprecated teleport-ent-updater package is installed on this server, and it cannot be re-enabled due to an error.", errorKey, err)
ns.log.ErrorContext(ctx, "Please fix the systemd timer included in the teleport-ent-updater package if you intend to use the deprecated updater.")
} else {
ns.log.WarnContext(ctx, "The deprecated teleport-ent-updater package is installed on this server. This package has been re-enabled to ensure continued updates. To disable automatic updates entirely, please remove the teleport-ent-updater package.")
ns.log.WarnContext(ctx, "The deprecated teleport-ent-updater package is installed on this server.")
ns.log.WarnContext(ctx, "The systemd timer included in this package has been re-enabled to ensure continued updates.", "timer", deprecatedTimerName)
ns.log.WarnContext(ctx, "To disable updates entirely, please remove the teleport-ent-updater package.")
}
}
}
Expand Down
29 changes: 18 additions & 11 deletions lib/autoupdate/agent/updater.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,8 @@ type OverrideConfig struct {
ForceFlags autoupdate.InstallFlags
// AllowOverwrite of installed binaries.
AllowOverwrite bool
// AllowProxyConflict when proxies in teleport.yaml and update.yaml are mismatched.
AllowProxyConflict bool
}

func deref[T any](ptr *T) T {
Expand Down Expand Up @@ -355,8 +357,10 @@ func (u *Updater) Install(ctx context.Context, override OverrideConfig) error {
if cfg.Spec.Proxy == "" {
cfg.Spec.Proxy = u.DefaultProxyAddr
} else if u.DefaultProxyAddr != "" &&
!sameProxies(cfg.Spec.Proxy, u.DefaultProxyAddr) {
u.Log.WarnContext(ctx, "Proxy specified in update.yaml does not match teleport.yaml. Unexpected updates may occur.", "update_proxy", cfg.Spec.Proxy, "teleport_proxy", u.DefaultProxyAddr)
!sameProxies(cfg.Spec.Proxy, u.DefaultProxyAddr) &&
!override.AllowProxyConflict {
u.Log.ErrorContext(ctx, "Proxy specified in update.yaml does not match teleport.yaml.", "update_proxy", cfg.Spec.Proxy, "teleport_proxy", u.DefaultProxyAddr)
return trace.Errorf("refusing to install with conflicting proxy addresses, pass --allow-proxy-conflict to override")
}
if cfg.Spec.Path == "" {
cfg.Spec.Path = u.DefaultPathDir
Expand Down Expand Up @@ -390,8 +394,9 @@ func (u *Updater) Install(ctx context.Context, override OverrideConfig) error {

if err := u.update(ctx, cfg, target, override.AllowOverwrite, resp.AGPL); err != nil {
if errors.Is(err, ErrFilePresent) && !override.AllowOverwrite {
u.Log.WarnContext(ctx, "Use --overwrite to force removal of existing binaries installed via script.")
u.Log.WarnContext(ctx, "If a teleport rpm or deb package is installed, upgrade it to the latest version and retry. DO NOT USE --overwrite.")
u.Log.ErrorContext(ctx, "A non-packaged or outdated installation of Teleport was detected on this system.")
u.Log.ErrorContext(ctx, "Use --overwrite to force immediate removal of any existing binaries installed manually or via script.")
u.Log.ErrorContext(ctx, "Alternatively, if a Teleport RPM or DEB package is installed, upgrade it to the latest version and retry without --overwrite.")
}
return trace.Wrap(err)
}
Expand Down Expand Up @@ -471,11 +476,11 @@ func (u *Updater) Remove(ctx context.Context, force bool) error {
if errors.Is(err, ErrNoBinaries) {
if !force {
u.Log.ErrorContext(ctx, "No packaged installation of Teleport was found, and --force was not passed.")
u.Log.ErrorContext(ctx, "Refusing to remove Teleport from this system.")
u.Log.ErrorContext(ctx, "Refusing to remove Teleport from this system entirely without --force.")
return trace.Errorf("unable to remove Teleport completely without --force")
} else {
u.Log.WarnContext(ctx, "No packaged installation of Teleport was found, and --force was passed.")
u.Log.WarnContext(ctx, "Teleport will be removed from this system.")
u.Log.WarnContext(ctx, "No packaged installation of Teleport was found, but --force was passed.")
u.Log.WarnContext(ctx, "Teleport will be removed from this system entirely.")
}
return u.removeWithoutSystem(ctx, cfg)
}
Expand Down Expand Up @@ -645,10 +650,6 @@ func (u *Updater) Update(ctx context.Context, now bool) error {
if err := validateConfigSpec(&cfg.Spec, OverrideConfig{}); err != nil {
return trace.Wrap(err)
}
if u.DefaultProxyAddr != "" &&
!sameProxies(cfg.Spec.Proxy, u.DefaultProxyAddr) {
u.Log.WarnContext(ctx, "Proxy specified in update.yaml does not match teleport.yaml. Unexpected updates may occur.", "update_proxy", cfg.Spec.Proxy, "teleport_proxy", u.DefaultProxyAddr)
}

active := cfg.Status.Active
skip := deref(cfg.Status.Skip)
Expand All @@ -657,6 +658,12 @@ func (u *Updater) Update(ctx context.Context, now bool) error {
return nil
}

if u.DefaultProxyAddr != "" &&
!sameProxies(cfg.Spec.Proxy, u.DefaultProxyAddr) {
u.Log.WarnContext(ctx, "Proxy specified in update.yaml does not match teleport.yaml.", "update_proxy", cfg.Spec.Proxy, "teleport_proxy", u.DefaultProxyAddr)
u.Log.WarnContext(ctx, "Unexpected updates may occur.")
}

if cfg.Spec.Path == "" {
return trace.Errorf("failed to read destination path for binary links from %s", updateConfigName)
}
Expand Down
1 change: 1 addition & 0 deletions lib/autoupdate/agent/updater_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,6 +1708,7 @@ func TestUpdater_Install(t *testing.T) {
if tt.userCfg.Proxy == "" {
tt.userCfg.Proxy = strings.TrimPrefix(server.URL, "https://")
}
updater.DefaultProxyAddr = tt.userCfg.Proxy

var (
installedRevision Revision
Expand Down
4 changes: 4 additions & 0 deletions tool/teleport-update/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ func Run(args []string) int {
Short('b').Envar(common.BaseURLEnvVar).StringVar(&ccfg.BaseURL)
enableCmd.Flag("overwrite", "Allow existing installed Teleport binaries to be overwritten.").
Short('o').BoolVar(&ccfg.AllowOverwrite)
enableCmd.Flag("allow-proxy-conflict", "Allow proxy addresses in teleport.yaml and update.yaml to conflict.").
BoolVar(&ccfg.AllowProxyConflict)
enableCmd.Flag("force-version", "Force the provided version instead of using the version provided by the Teleport cluster.").
Hidden().Short('f').Envar(updateVersionEnvVar).StringVar(&ccfg.ForceVersion)
enableCmd.Flag("self-setup", "Use the current teleport-update binary to create systemd service config for managed updates.").
Expand All @@ -139,6 +141,8 @@ func Run(args []string) int {
Short('b').Envar(common.BaseURLEnvVar).StringVar(&ccfg.BaseURL)
pinCmd.Flag("overwrite", "Allow existing installed Teleport binaries to be overwritten.").
Short('o').BoolVar(&ccfg.AllowOverwrite)
pinCmd.Flag("allow-proxy-conflict", "Allow proxy addresses in teleport.yaml and update.yaml to conflict.").
BoolVar(&ccfg.AllowProxyConflict)
pinCmd.Flag("force-version", "Force the provided version instead of using the version provided by the Teleport cluster.").
Short('f').Envar(updateVersionEnvVar).StringVar(&ccfg.ForceVersion)
pinCmd.Flag("self-setup", "Use the current teleport-update binary to create systemd service config for managed updates.").
Expand Down
Loading