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

Jump to bottom

Fix PluginV1 fields backward compatibility #41944

Merged

smallinsky merged 3 commits into master from smallinsky/fix_plugin_fields_backward_compability

May 27, 2024

Contributor

smallinsky commented May 23, 2024 •

edited

Loading

What

Fix feature UnmarshalPlugin compatibility

Extending plugin struct

When a new plugin or new field is added to the PluginV1 struct:

--- a/api/proto/teleport/legacy/types/types.proto
+++ b/api/proto/teleport/legacy/types/types.proto
@@ -5934,6 +5934,8 @@ message PluginOktaSettings {
+
+  bool EnableFeatureX = 5;
 }

the UnmarshalPlugin will marshal proto to the following JSON object:

{
  "kind": "plugin",
  "version": "v1",
   "spec": {
    "okta": {
       "enableFeatureX": true
    }
  },
  }
}

and the plugin will be successfully installed.

Downgrading Teleport Version

When Teleport is downgraded, the marshal function will fail with an unknown field error, producing a lot of periodic noise, and will not start the plugin, breaking backward compatibility.

This will also occurs when a new plugin type is added to PluginSpecV1

To fix that the AllowUnknownFields: true needs to be set.


          Fix PluginV1 fields backward compability

dc3c0d2

smallinsky requested review from r0mant and tcsc

May 23, 2024 13:21

github-actions bot requested review from ibeckermayer and probakowski

May 23, 2024 13:21

github-actions bot added the size/sm label

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

6 similar comments

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

github-actions bot commented May 23, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

smallinsky added no-changelog backport/branch/v14 backport/branch/v15 labels

rosstimothy approved these changes

View reviewed changes

r0mant approved these changes

View reviewed changes

Collaborator

r0mant left a comment

Can you add a test for this?

public-teleport-github-review-bot bot removed request for tcsc, probakowski and ibeckermayer

May 23, 2024 14:42

smallinsky force-pushed the smallinsky/fix_plugin_fields_backward_compability branch 3 times, most recently from d60052e to dd7f0d0 Compare

May 23, 2024 17:14


          Update

bdb5920

smallinsky force-pushed the smallinsky/fix_plugin_fields_backward_compability branch from dd7f0d0 to bdb5920 Compare

May 23, 2024 17:16

smallinsky added this pull request to the merge queue

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


          Merge branch 'master' into smallinsky/fix_plugin_fields_backward_comp…

6fdd518

…ability

smallinsky added this pull request to the merge queue

Merged via the queue into master with commit f28c4aa

38 checks passed

smallinsky deleted the smallinsky/fix_plugin_fields_backward_compability branch

May 27, 2024 09:27

public-teleport-github-review-bot bot commented May 27, 2024

@smallinsky See the table below for backport results.

Branch	Result
branch/v14	Create PR
branch/v15	Create PR

smallinsky mentioned this pull request

[v15] Fix PluginV1 fields backward compatibility #42050

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/branch/v14 backport/branch/v15 no-changelog size/sm