Add readyz socket endpoint to tbot for use by teleport-update by sclevine · Pull Request #60477 · gravitational/teleport

sclevine · 2025-10-22T17:47:47Z

This PR instruments tbot for compatibility with teleport-update.

In #60478, teleport-update will be updated to create a tbot.service file and manage tbot updates automatically, including restarting tbot.

This PR adds the following features to tbot to accomplish this:

Passing --diag-socket-for-updater /path/to/debug.socket will create a new /readyz endpoint that teleport-update can monitor for readiness. If tbot is unready after an update, teleport-update will revert it.
The /readyz endpoint now contains the process PID. teleport-update can use this to verify that the tbot responding on the socket is the target version of tbot.
tbot's systemd service now passes --pid-file. Before, the systemd service was configured to look for a PID file that was never created (bug fix).

All three features are implemented by teleport already.

changelog: instrument tbot to better support teleport-update

RFD: #47126
Goal (internal): https://github.com/gravitational/cloud/issues/14225

strideynet · 2025-10-23T09:09:59Z

lib/tbot/tbot.go

 		)
 	}

+	if b.cfg.DiagSocketForUpdater != "" {


@boxofrad - do you foresee any issues with multiple replicas of the diagnostics service running ? From our current architecture, I don't see any problems but figured you would know with more certainty.

I think it should be fine!

boxofrad

Looks great, nice job!

lib/tbot/internal/diagnostics/service.go

sclevine · 2025-10-23T17:55:12Z

I realized that the new --pid-file and hidden --diag-socket-for-updater flags should probably be added to the shared list of flags for the other start commands as well. The first flag is generally useful, and the second could be useful if you drop-in a systemd override to use one of the other start commands.

github-actions · 2025-10-23T19:03:42Z

Amplify deployment status

Branch	Commit	Job ID	Status	Preview	Updated (UTC)
sclevine/autoupdates-tbot-readyz	`38cfa2e`	6	✅SUCCEED	sclevine-autoupdates-tbot-readyz	2025-10-28 22:39:45

strideynet

LGTM - thank you for taking this on.

lib/tbot/internal/diagnostics/service.go

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

#61190) * PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

#61189) * PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

@strideynet

* PID and readyz changes for tbot * remove teleport-update changes * tidy * tidy * godoc * linting, typos * lint * shared cli args + cli tests * lint * missing . * flag docs * pid example * Apply suggestion from @strideynet Co-authored-by: Noah Stride <noah.stride@goteleport.com> * windows fix * windows fix for merge queue * missing errors on windows --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>

sclevine mentioned this pull request Oct 22, 2025

[teleport-update] Add support for tbot Managed Updates #60478

Merged

sclevine marked this pull request as ready for review October 22, 2025 20:08

sclevine requested review from r0mant, rosstimothy, russjones and zmb3 as code owners October 22, 2025 20:08

sclevine requested review from hugoShaka and strideynet October 22, 2025 20:08

github-actions bot added machine-id size/md labels Oct 22, 2025

github-actions bot requested review from boxofrad and timothyb89 October 22, 2025 20:09

strideynet reviewed Oct 23, 2025

View reviewed changes

boxofrad approved these changes Oct 23, 2025

View reviewed changes

lib/tbot/internal/diagnostics/service.go Outdated Show resolved Hide resolved

lib/tbot/internal/diagnostics/service.go Outdated Show resolved Hide resolved

sclevine requested a review from strideynet October 23, 2025 17:02

sclevine temporarily deployed to docs-amplify October 23, 2025 18:52 — with GitHub Actions Inactive

sclevine temporarily deployed to docs-amplify October 23, 2025 19:39 — with GitHub Actions Inactive

strideynet approved these changes Oct 28, 2025

View reviewed changes

lib/tbot/internal/diagnostics/service.go Outdated Show resolved Hide resolved

sclevine temporarily deployed to docs-amplify October 28, 2025 17:04 — with GitHub Actions Inactive

sclevine enabled auto-merge October 28, 2025 17:05

sclevine added 8 commits October 28, 2025 13:53

PID and readyz changes for tbot

b8a0ee2

remove teleport-update changes

b7eef79

tidy

1511655

tidy

f676054

godoc

115821c

linting, typos

463308a

lint

a9db468

shared cli args + cli tests

9dce615

sclevine temporarily deployed to docs-amplify October 28, 2025 17:54 — with GitHub Actions Inactive

sclevine added this pull request to the merge queue Oct 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 28, 2025

sclevine added this pull request to the merge queue Oct 28, 2025

windows fix

bb717f5

sclevine removed this pull request from the merge queue due to a manual request Oct 28, 2025

windows fix for merge queue

80cc6f5

sclevine temporarily deployed to docs-amplify October 28, 2025 21:26 — with GitHub Actions Inactive

sclevine enabled auto-merge October 28, 2025 21:26

sclevine added this pull request to the merge queue Oct 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 28, 2025

missing errors on windows

38cfa2e

sclevine temporarily deployed to docs-amplify October 28, 2025 22:37 — with GitHub Actions Inactive

sclevine enabled auto-merge October 28, 2025 22:37

sclevine added this pull request to the merge queue Oct 28, 2025

Merged via the queue into master with commit df59ebe Oct 28, 2025
41 checks passed

sclevine deleted the sclevine/autoupdates-tbot-readyz branch October 28, 2025 23:20

sclevine added backport/branch/v17 backport/branch/v18 labels Nov 10, 2025

This was referenced Nov 10, 2025

[v18] Add readyz socket endpoint to tbot for use by teleport-update (#60477) #61189

Merged

[v17] Add readyz socket endpoint to tbot for use by teleport-update (#60477) #61190

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add readyz socket endpoint to tbot for use by teleport-update#60477

Add readyz socket endpoint to tbot for use by teleport-update#60477
sclevine merged 16 commits intomasterfrom
sclevine/autoupdates-tbot-readyz

sclevine commented Oct 22, 2025 •

edited

Loading

Uh oh!

strideynet Oct 23, 2025

Uh oh!

boxofrad Oct 23, 2025

Uh oh!

boxofrad left a comment

Uh oh!

Uh oh!

Uh oh!

sclevine commented Oct 23, 2025

Uh oh!

github-actions bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

strideynet left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

sclevine commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

strideynet Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

boxofrad Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

boxofrad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sclevine commented Oct 23, 2025

Uh oh!

github-actions bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

strideynet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sclevine commented Oct 22, 2025 •

edited

Loading

github-actions bot commented Oct 23, 2025 •

edited

Loading