Client AutoUpdate proto structure changes #47532

vapopov · 2024-10-12T01:07:05Z

In this PR reflected proposed changes from #47498

Version (from -> to):

kind: autoupdate_version
spec:
  tools_version: X.Y.Z

kind: autoupdate_version
spec:
  tools:
    target_version: X.Y.Z

Config (from -> to):

kind: autoupdate_config
spec:
  tools_autoupdate: on|off

kind: autoupdate_config
spec:
  tools:
    mode: enabled|disabled

tigrato · 2024-10-14T10:06:52Z

api/proto/teleport/autoupdate/v1/autoupdate.proto

+}
+
+// ToolsMode type for client tools enabling state.
+enum ToolsMode {


Suggested change

enum ToolsMode {

enum ToolsUpdateMode {

tigrato · 2024-10-14T10:08:08Z

api/proto/teleport/autoupdate/v1/autoupdate.proto

+
+// AutoUpdateVersionTools encodes the parameters for client tools auto updates.
+message AutoUpdateVersionTools {
+  // TargetVersion is the semantic version required for tools autoupdates.


Is this the target version we want you to upgrade to or is it the version required for you to be able to update to something else?

@vapopov what's the correct version here?

@tigrato TargetVersion is mandatory version for update, if mode is enabled so everyone who is connected to the cluster going to be updated to this version (except client tools executed with disabling env variable)

Can we rename it to:

// TargetVersion specifies the semantic version required for tools to establish a connection with the cluster.

The way it's written today is misleading and reads as the version required for auto updates and not the target auto update version

tigrato · 2024-10-14T10:09:44Z

api/proto/teleport/autoupdate/v1/autoupdate.proto

@@ -34,7 +34,26 @@ message AutoUpdateConfig {
 // AutoUpdateConfigSpec encodes the parameters of the autoupdate config object.
 message AutoUpdateConfigSpec {
  // ToolsAutoupdate encodes the feature flag to enable/disable tools autoupdates.
+  // Deprecated: use AutoUpdateConfigTools instead.


is this being used in prod? If no, we can reserve the field and continue

+1 let's reserve the fields and deprecate

tigrato · 2024-10-14T10:10:27Z

api/types/autoupdate/version.go

@@ -60,11 +60,13 @@ func ValidateAutoUpdateVersion(v *autoupdate.AutoUpdateVersion) error {
 		return trace.BadParameter("Spec is nil")
 	}

-	if v.Spec.ToolsVersion == "" {


you no longer validate v.Spec.ToolsVersion. Is it used in prod? Should we keep it if not used?

Actually we decided to rename before actual usage in prod, so this resource is not used previously

hugoShaka · 2024-10-16T18:57:04Z

api/proto/teleport/autoupdate/v1/autoupdate.proto

+message AutoUpdateConfigTools {
+  // Mode defines state of the client tools auto update.
+  ToolsUpdateMode mode = 1;
+}


Should this message be named AutoUpdateConficSpecTools? That's what we put in RFD 184 but I cvan change the RFD if needed.

since it's already in rfd, changing this one, and for version

api/proto/teleport/autoupdate/v1/autoupdate.proto

hugoShaka · 2024-10-16T20:34:30Z

api/proto/teleport/autoupdate/v1/autoupdate.proto

+  ToolsUpdateMode mode = 1;
+}
+
+// ToolsMode type for client tools enabling state.
+enum ToolsUpdateMode {
+  // TOOLS_UPDATE_MODE_UNSPECIFIED is undefined mode.
+  TOOLS_UPDATE_MODE_UNSPECIFIED = 0;
+  // TOOLS_UPDATE_MODE_ENABLED client tools auto update is enabled.
+  TOOLS_UPDATE_MODE_ENABLED = 1;
+  // TOOLS_UPDATE_MODE_DISABLED client tools auto update is disabled.
+  TOOLS_UPDATE_MODE_DISABLED = 2;


Can you make the mode a string instead of an enum? Sorry for the last minute change, I made a mistake in the RFD and this should have been a string.

There is nothing wrong technically with it being an enum (technically it's better as we have stricter content validation), however we use the protobuf messages to generate Kubernetes CRDs and Terraform Schemas. Seeing integers instead of strings is not user friendly as it's not clear that mode: 2 means "updates are disabled".

I will update RFD 184 to fix the protos.

* Update client autoupdate proto structure * Replace with reserved * Fix unit tests * Add more info in proto * Rename proto to be aligned RFD namings * Replace enum type for ToolsMode to string

* Expose client tools auto update for find endpoint (#46785) * Expose client tools auto update for find endpoint * Group auto update settings in find response Log error instead returning error Add tests auto update settings in find endpoint Add check for not implemented error * Add more test cases * Client AutoUpdate proto structure changes (#47532) * Update client autoupdate proto structure * Replace with reserved * Fix unit tests * Add more info in proto * Rename proto to be aligned RFD namings * Replace enum type for ToolsMode to string * Add packaging utility for client tools auto updates (#47060) * Add packaging utility for client tools auto updates * Add error handling for close functions * Move archive to existing utils package * Move archive helpers to integration/helper CR changes * CR changes * CR changes * CR changes Replace creating directory with extract path as argument * CR changes * Validate full size before un-archive Extract files to extractDir with ignore dir structure * Change compressing with relative paths Add test for cleanup and fix skip logic * CR changes * CR changes * Fix linter * Client tools auto update (#47466) * Add client tools auto update * Replace fork for posix platform for re-exec Move integration tests to client tools specific dir Use context cancellation with SIGTERM, SIGINT Remove cancelable tee reader with context replacement Renaming * Fix syscall path execution Fix archive cleanup if hash is not valid Limit the archive write bytes * Cover the case with single package for darwin platform after v17 * Move updater logic to tools package * Move context out from the library Base URL renaming * Add more context in comments * Changes in find endpoint * Replace test http server with `httptest` Replace hash for bytes matching Proper temp file close for archive download * Add more context to comments * Move feature flag to main package to be reused * Constant rename * Replace build tag with lib/modules to identify enterprise build * Replace fips tag with modules flag * Client auto updates integration for {tctl,tsh} (#47815) * Client auto updates integration for tctl/tsh * Add version validation Fix recursive version check for darwin platform Fix cleanup for multi-package support * Fix identifying tools removal from home directory * Replace ToolsMode with ToolsAutoUpdate * Reuse insecure flag for tests * Fix CheckRemote with login * Fix windows administrative access requirement Update must be able to be canceled, re-execute with latest version or last updated Show progress bar before request is made * Fix update cancellation for login action Address review comments * Add signal handler with stack context cancellation * Use copy instead of hard link for windows Fix progress bar if we can't receive size of package * Replace with list in order to support manual cancel * Download archive package to temp directory * Decrease timeout for client tools proxy call * Add audit logs for auto update resources (#48218) * Connect: Make sure tsh auto-updates are turned off (#49180) * Add dir for code shared between Node.js processes * Connect: Make sure tsh auto-updates are turned off * Pass TELEPORT_TOOLS_VERSION=off to tsh vnet-daemon * Disable client tools auto update disabled if there are no home dir (#49159) Move updater to general tools package * Move client auto update helper to lib package (#49247) --------- Co-authored-by: Rafał Cieślak <[email protected]>

* Expose client tools auto update for find endpoint (#46785) * Expose client tools auto update for find endpoint * Group auto update settings in find response Log error instead returning error Add tests auto update settings in find endpoint Add check for not implemented error * Add more test cases * Client AutoUpdate proto structure changes (#47532) * Update client autoupdate proto structure * Replace with reserved * Fix unit tests * Add more info in proto * Rename proto to be aligned RFD namings * Replace enum type for ToolsMode to string * Add packaging utility for client tools auto updates (#47060) * Add packaging utility for client tools auto updates * Add error handling for close functions * Move archive to existing utils package * Move archive helpers to integration/helper CR changes * CR changes * CR changes * CR changes Replace creating directory with extract path as argument * CR changes * Validate full size before un-archive Extract files to extractDir with ignore dir structure * Change compressing with relative paths Add test for cleanup and fix skip logic * CR changes * CR changes * Fix linter * Client tools auto update (#47466) * Add client tools auto update * Replace fork for posix platform for re-exec Move integration tests to client tools specific dir Use context cancellation with SIGTERM, SIGINT Remove cancelable tee reader with context replacement Renaming * Fix syscall path execution Fix archive cleanup if hash is not valid Limit the archive write bytes * Cover the case with single package for darwin platform after v17 * Move updater logic to tools package * Move context out from the library Base URL renaming * Add more context in comments * Changes in find endpoint * Replace test http server with `httptest` Replace hash for bytes matching Proper temp file close for archive download * Add more context to comments * Move feature flag to main package to be reused * Constant rename * Replace build tag with lib/modules to identify enterprise build * Replace fips tag with modules flag * Client auto updates integration for {tctl,tsh} (#47815) * Client auto updates integration for tctl/tsh * Add version validation Fix recursive version check for darwin platform Fix cleanup for multi-package support * Fix identifying tools removal from home directory * Replace ToolsMode with ToolsAutoUpdate * Reuse insecure flag for tests * Fix CheckRemote with login * Fix windows administrative access requirement Update must be able to be canceled, re-execute with latest version or last updated Show progress bar before request is made * Fix update cancellation for login action Address review comments * Add signal handler with stack context cancellation * Use copy instead of hard link for windows Fix progress bar if we can't receive size of package * Replace with list in order to support manual cancel * Download archive package to temp directory * Decrease timeout for client tools proxy call * Add audit logs for auto update resources (#48218) * Connect: Make sure tsh auto-updates are turned off * Add dir for code shared between Node.js processes * Connect: Make sure tsh auto-updates are turned off * Pass TELEPORT_TOOLS_VERSION=off to tsh vnet-daemon * Disable client tools auto update disabled if there are no home dir (#49159) Move updater to general tools package * Move client auto update helper to lib package (#49247) --------- Co-authored-by: Rafał Cieślak <[email protected]>

Update client autoupdate proto structure

401d2a3

vapopov added the no-changelog Indicates that a PR does not require a changelog entry label Oct 12, 2024

github-actions bot requested review from greedy52 and tigrato October 12, 2024 01:07

github-actions bot added the size/sm label Oct 12, 2024

vapopov requested review from sclevine, hugoShaka and rosstimothy October 12, 2024 01:10

tigrato reviewed Oct 14, 2024

View reviewed changes

vapopov added backport/branch/v14 backport/branch/v15 backport/branch/v16 labels Oct 15, 2024

Replace with reserved

b9449c9

vapopov force-pushed the vapopov/update-autoupdate-proto-structure branch from 1b4e023 to b9449c9 Compare October 15, 2024 20:33

vapopov added 2 commits October 15, 2024 18:14

Fix unit tests

324813e

Add more info in proto

ca422aa

hugoShaka reviewed Oct 16, 2024

View reviewed changes

api/proto/teleport/autoupdate/v1/autoupdate.proto Outdated Show resolved Hide resolved

Rename proto to be aligned RFD namings

1e3b6a4

hugoShaka reviewed Oct 16, 2024

View reviewed changes

Replace enum type for ToolsMode to string

4544f49

vapopov force-pushed the vapopov/update-autoupdate-proto-structure branch from 449f5a7 to 4544f49 Compare October 17, 2024 00:13

vapopov requested review from hugoShaka and tigrato October 17, 2024 00:27

vapopov removed backport/branch/v14 backport/branch/v15 backport/branch/v16 labels Oct 17, 2024

hugoShaka approved these changes Oct 17, 2024

View reviewed changes

tigrato approved these changes Oct 17, 2024

View reviewed changes

public-teleport-github-review-bot bot removed the request for review from sclevine October 17, 2024 14:07

public-teleport-github-review-bot bot removed the request for review from greedy52 October 17, 2024 14:07

vapopov added this pull request to the merge queue Oct 17, 2024

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

hugoShaka added this pull request to the merge queue Oct 17, 2024

Merged via the queue into master with commit 10fb784 Oct 17, 2024
43 checks passed

hugoShaka deleted the vapopov/update-autoupdate-proto-structure branch October 17, 2024 15:07

vapopov mentioned this pull request Oct 17, 2024

[v16] Expose client tools auto update for find endpoint #47213

Closed

vapopov mentioned this pull request Nov 8, 2024

[v16] Client tools autoupdates #48645

Merged

vapopov mentioned this pull request Nov 8, 2024

[v15] Client tools autoupdates #48648

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Client AutoUpdate proto structure changes #47532

Client AutoUpdate proto structure changes #47532

vapopov commented Oct 12, 2024 •

edited

Loading

tigrato Oct 14, 2024

tigrato Oct 14, 2024

tigrato Oct 16, 2024

vapopov Oct 16, 2024

tigrato Oct 16, 2024 •

edited

Loading

tigrato Oct 14, 2024

rosstimothy Oct 15, 2024

tigrato Oct 14, 2024

vapopov Oct 15, 2024

hugoShaka Oct 16, 2024

vapopov Oct 16, 2024 •

edited

Loading

hugoShaka Oct 16, 2024 •

edited

Loading

Client AutoUpdate proto structure changes #47532

Client AutoUpdate proto structure changes #47532

Conversation

vapopov commented Oct 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tigrato Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vapopov Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

hugoShaka Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

vapopov commented Oct 12, 2024 •

edited

Loading

tigrato Oct 16, 2024 •

edited

Loading

vapopov Oct 16, 2024 •

edited

Loading

hugoShaka Oct 16, 2024 •

edited

Loading