Add client tools auto-update documentation #50835

vapopov · 2025-01-07T18:07:40Z

In this PR added client tools auto-update documentation

Related: https://github.com/gravitational/cloud/issues/10053

github-actions · 2025-01-07T18:08:33Z

Amplify deployment status

Branch	Commit	Job ID	Status	Preview	Updated (UTC)
vapopov/client-tools-autoupdate-docs	`b3acc1a`	13	✅SUCCEED	vapopov-client-tools-autoupdate-docs	2025-01-14 19:09:16

benarent · 2025-01-08T21:17:06Z

docs/pages/upgrading/client-tools-autoupdate.mdx

+
+This documentation explains how to keep Teleport client tools like `tsh` and `tctl` up-to-date.
+Updates can be automatic or self-managed, ensuring tools are secure, free from bugs,
+and compatible with your Teleport cluster.


I just tried this feature and it's very nice.

Can we add a note / section that outlines which version support this. e.g. if it's shipped with v15, v16, and v17. What's version I need to upgrade to get this feature.

Looks like it was back-ported to Teleport 15.4.24, I can't easily tell which other version it's in.

Answer:
17.0.1
16.4.10
15.4.24

ptgott

Left a few initial comments. I haven't read the entire PR yet.

docs/pages/upgrading/client-tools-autoupdate.mdx

ptgott · 2025-01-08T22:03:00Z

docs/pages/upgrading/client-tools-autoupdate.mdx

+
+### How It Works
+
+When you run `tsh login`, the tool will check if updates are enabled for your cluster.


What does "the tool" refer to here? Is there an update tool that is separate from the client tools it keeps up to date?

tool is a general term for tsh, tctl in this context, or potentially even tbot in the future

👍 We should specify this in this paragraph. Otherwise, it is not possible for a reader to infer this.

I've changed to the tsh tool, in scope of this example exactly tsh responsible for update

docs/pages/upgrading/client-tools-autoupdate.mdx

Code review changes

ptgott

While most sidebar sections are autogenerated, the Upgrading section is not. We'll need to update the sidebar configuration by adding an entry here:

teleport/docs/config.json

Lines 23 to 40 in b6e2bad

    
              { 
        
                "title": "Upgrading", 
        
                "slug": "/upgrading/upgrading/", 
        
                "entries": [ 
        
                  { 
        
                    "title": "Compatibility Overview", 
        
                    "slug": "/upgrading/overview/" 
        
                  }, 
        
                  { 
        
                    "title": "Set up Automatic Agent Updates", 
        
                    "slug": "/upgrading/automatic-agent-updates/" 
        
                  }, 
        
                  { 
        
                    "title": "Upgrading Reference", 
        
                    "slug": "/upgrading/upgrading-reference/" 
        
           } 
        
                ] 
        
              },

ptgott · 2025-01-13T19:23:20Z

docs/pages/upgrading/client-tools-autoupdate.mdx

+3. Validate the binary with a checksum.
+4. Re-execute using the updated version (with the same environment variables).
+
+#### Key features:


Is there a way to turn the Key features discussion into a couple of paragraphs? Right now, it looks a little jumbled, making it difficult to read:

docs/pages/upgrading/client-tools-autoupdate.mdx

docs/config.json

docs/pages/upgrading/client-tools-autoupdate.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

hugoShaka

Bot.

public-teleport-github-review-bot · 2025-01-15T19:53:58Z

@vapopov See the table below for backport results.

Branch	Result
branch/v15	Failed
branch/v16	Failed
branch/v17	Failed

* Add client tools auto-update docs * Add reference to index page * Fix linter prose style * Add section with tctl commands Code review changes * Reorganize sections Add documentation to navigation config Code review changes * Add `autoupdate` from command to cspell * Fix linter warning with relative link * Update docs/config.json Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/upgrading/client-tools-autoupdate.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Add client tools auto-update docs * Add reference to index page * Fix linter prose style * Add section with tctl commands Code review changes * Reorganize sections Add documentation to navigation config Code review changes * Add `autoupdate` from command to cspell * Fix linter warning with relative link * Update docs/config.json * Update docs/pages/upgrading/client-tools-autoupdate.mdx --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Add client tools auto-update docs * Add reference to index page * Fix linter prose style * Add section with tctl commands Code review changes * Reorganize sections Add documentation to navigation config Code review changes * Add `autoupdate` from command to cspell * Fix linter warning with relative link * Update docs/config.json Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/upgrading/client-tools-autoupdate.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

Add client tools auto-update docs

a2e7961

vapopov temporarily deployed to docs-amplify January 7, 2025 18:07 — with GitHub Actions Inactive

vapopov added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v15 backport/branch/v16 backport/branch/v17 labels Jan 7, 2025

Add reference to index page

d18cc10

vapopov temporarily deployed to docs-amplify January 7, 2025 18:41 — with GitHub Actions Inactive

vapopov requested review from ptgott, sclevine and hugoShaka January 7, 2025 19:10

Fix linter prose style

08c313f

vapopov temporarily deployed to docs-amplify January 7, 2025 19:14 — with GitHub Actions Inactive

vapopov marked this pull request as ready for review January 7, 2025 19:14

github-actions bot added documentation size/md labels Jan 7, 2025

github-actions bot requested review from mmcallister, r0mant, xinding33 and zmb3 January 7, 2025 19:15

benarent reviewed Jan 8, 2025

View reviewed changes

benarent approved these changes Jan 8, 2025

View reviewed changes

ptgott reviewed Jan 8, 2025

View reviewed changes

Add section with tctl commands

2ba8a9f

Code review changes

vapopov temporarily deployed to docs-amplify January 10, 2025 00:12 — with GitHub Actions Inactive

sclevine approved these changes Jan 10, 2025

View reviewed changes

ptgott reviewed Jan 13, 2025

View reviewed changes

vapopov temporarily deployed to docs-amplify January 13, 2025 20:39 — with GitHub Actions Inactive

vapopov temporarily deployed to docs-amplify January 13, 2025 23:11 — with GitHub Actions Inactive

vapopov force-pushed the vapopov/client-tools-autoupdate-docs branch from 523d319 to cd98458 Compare January 13, 2025 23:12

vapopov temporarily deployed to docs-amplify January 13, 2025 23:12 — with GitHub Actions Inactive

Fix linter warning with relative link

46ae04e

vapopov force-pushed the vapopov/client-tools-autoupdate-docs branch from cd98458 to 46ae04e Compare January 14, 2025 16:53

vapopov temporarily deployed to docs-amplify January 14, 2025 16:53 — with GitHub Actions Inactive

ptgott approved these changes Jan 14, 2025

View reviewed changes

docs/config.json Outdated Show resolved Hide resolved

docs/pages/upgrading/client-tools-autoupdate.mdx Outdated Show resolved Hide resolved

Update docs/config.json

d93c380

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

vapopov temporarily deployed to docs-amplify January 14, 2025 18:59 — with GitHub Actions Inactive

Update docs/pages/upgrading/client-tools-autoupdate.mdx

b3acc1a

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

vapopov temporarily deployed to docs-amplify January 14, 2025 18:59 — with GitHub Actions Inactive

vapopov enabled auto-merge January 14, 2025 19:04

hugoShaka approved these changes Jan 15, 2025

View reviewed changes

public-teleport-github-review-bot bot removed request for r0mant, mmcallister, zmb3 and xinding33 January 15, 2025 19:40

vapopov added this pull request to the merge queue Jan 15, 2025

Merged via the queue into master with commit f6ca515 Jan 15, 2025
42 checks passed

vapopov deleted the vapopov/client-tools-autoupdate-docs branch January 15, 2025 19:51

This was referenced Jan 15, 2025

[v15] Add client tools auto-update documentation #51089

Open

[v16] Add client tools auto-update documentation #51090

Open

[v17] Add client tools auto-update documentation #51091

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add client tools auto-update documentation #50835

Add client tools auto-update documentation #50835

vapopov commented Jan 7, 2025

github-actions bot commented Jan 7, 2025 •

edited

Loading

benarent Jan 8, 2025

benarent Jan 8, 2025 •

edited

Loading

ptgott left a comment

ptgott Jan 8, 2025

vapopov Jan 8, 2025

ptgott Jan 9, 2025

vapopov Jan 10, 2025

ptgott left a comment

ptgott Jan 13, 2025

hugoShaka left a comment

public-teleport-github-review-bot bot commented Jan 15, 2025


		### How It Works

		When you run `tsh login`, the tool will check if updates are enabled for your cluster.

	{
	"title": "Upgrading",
	"slug": "/upgrading/upgrading/",
	"entries": [
	{
	"title": "Compatibility Overview",
	"slug": "/upgrading/overview/"
	},
	{
	"title": "Set up Automatic Agent Updates",
	"slug": "/upgrading/automatic-agent-updates/"
	},
	{
	"title": "Upgrading Reference",
	"slug": "/upgrading/upgrading-reference/"
	}
	]
	},

Add client tools auto-update documentation #50835

Add client tools auto-update documentation #50835

Conversation

vapopov commented Jan 7, 2025

github-actions bot commented Jan 7, 2025 • edited Loading

benarent Jan 8, 2025

Choose a reason for hiding this comment

benarent Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

ptgott left a comment

Choose a reason for hiding this comment

ptgott Jan 8, 2025

Choose a reason for hiding this comment

vapopov Jan 8, 2025

Choose a reason for hiding this comment

ptgott Jan 9, 2025

Choose a reason for hiding this comment

vapopov Jan 10, 2025

Choose a reason for hiding this comment

ptgott left a comment

Choose a reason for hiding this comment

ptgott Jan 13, 2025

Choose a reason for hiding this comment

hugoShaka left a comment

Choose a reason for hiding this comment

public-teleport-github-review-bot bot commented Jan 15, 2025

github-actions bot commented Jan 7, 2025 •

edited

Loading

benarent Jan 8, 2025 •

edited

Loading