Skip to content

Enhance plugin interface with timeout #3355

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
Open
phuongatemc wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Enhance plugin interface with timeout #3355

phuongatemc wants to merge 4 commits into from

Conversation

@phuongatemc
Copy link
Contributor

@phuongatemc phuongatemc commented Jan 26, 2021

Adding context object to the functions of the Velero plugin. This context object can be used to set timeout for the operation by the caller. To ensure backward compatibility and avoid forcing all plugin vendor upgrade their code in lock-step, a new interface would be created to wrap around the existing interface and new functions would be created with additional parameter ctx context.Context as the first parameter. The plugin vendor can decide to implement new function (with context) or keep using existing one.

@jenting jenting added the Area/Design Design Documents label Jan 28, 2021
@dsu-igeek dsu-igeek added the kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes label Jan 28, 2021
dsu-igeek
dsu-igeek reviewed Feb 2, 2021
View reviewed changes
Copy link
Contributor

@dsu-igeek dsu-igeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's list out the APIs that will get contexts here. I think the list is

BackupItemAction.Execute
DeleteItemAction.Execute

ObjectStore.PutObject
ObjectStore.ObjectExists
ObjectStore.GetObject
ObjectStore.ListCommonPrefixes
ObjectStore.ListObjects
ObjectStore.DeleteObject

RestoreItemAction.Execute

VolumeSnapshotter.CreateVolumeFromSnapshot

VolumeSnapshotter.GetVolumeInfo
VolumeSnapshotter.CreateSnapshot
VolumeSnapshotter.DeleteSnapshot

@phuongatemc
Copy link
Contributor Author

phuongatemc commented Feb 2, 2021

Let's list out the APIs that will get contexts here. I think the list is

BackupItemAction.Execute
DeleteItemAction.Execute

ObjectStore.PutObject
ObjectStore.ObjectExists
ObjectStore.GetObject
ObjectStore.ListCommonPrefixes
ObjectStore.ListObjects
ObjectStore.DeleteObject

RestoreItemAction.Execute

VolumeSnapshotter.CreateVolumeFromSnapshot

VolumeSnapshotter.GetVolumeInfo
VolumeSnapshotter.CreateSnapshot
VolumeSnapshotter.DeleteSnapshot

Do you want me to add this list to the design doc itself?

@github-actions github-actions bot requested a review from dsu-igeek February 9, 2021 16:37
@phuongatemc
Copy link
Contributor Author

phuongatemc commented Feb 9, 2021

@dsu-igeek I have added the list of new functions.

@nrb
Copy link
Contributor

nrb commented Mar 11, 2021

This is blocked on #3285

@nrb nrb added the Blocked label Mar 11, 2021
@nrb nrb mentioned this pull request Mar 11, 2021
Open
@carlisia carlisia removed the request for review from nrb April 5, 2021 14:58
@brito-rafa brito-rafa mentioned this pull request Dec 6, 2021
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zubron zubron Awaiting requested review from zubron

1 more reviewer

@dsu-igeek dsu-igeek dsu-igeek left review comments

Reviewers whose approvals may not affect merge requirements

At least 2 approving reviews are required to merge this pull request.

Assignees

@phuongatemc phuongatemc

Labels

Area/Design Design Documents Blocked kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@phuongatemc @nrb @dsu-igeek @jenting