Document about item action plugin ordering. #6719
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #6719 +/- ##
=======================================
Coverage 60.67% 60.67%
=======================================
Files 249 249
Lines 26476 26476
=======================================
Hits 16064 16064
Misses 9268 9268
Partials 1144 1144 |
draghuram
force-pushed
the
plugin-order-doc
branch
from
8867fe3
to
13cb39a
Compare
|
@sseago We discussed this doc change few weeks ago in the call and you suggested a change regarding plugins registered by the same binary. I made the change to include that case. Please take a look. |
sseago
previously approved these changes
Oct 3, 2023
| @@ -59,6 +59,11 @@ Velero supports the following kinds of plugins: | |||
| - **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster | |||
| - **Delete Item Action** - executes arbitrary logic based on individual items within a backup prior to deleting the backup | |||
|
|
|||
| Plugin binaries are discovered by recursively reading a directory in no particular order. Hence no guarantee is provided for the | |||
| order in which item action plugins are invoked. How ever, if a single binary implements multiple item action plugins, | |||
There was a problem hiding this comment.
s/How ever/However
There was a problem hiding this comment.
Thanks. Made the change.
| @@ -59,6 +59,11 @@ Velero supports the following kinds of plugins: | |||
| - **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster | |||
| - **Delete Item Action** - executes arbitrary logic based on individual items within a backup prior to deleting the backup | |||
|
|
|||
| Plugin binaries are discovered by recursively reading a directory in no particular order. Hence no guarantee is provided for the | |||
| order in which item action plugins are invoked. How ever, if a single binary implements multiple item action plugins, | |||
| they may be invoked in the order in which they are registered but it is best not depend on this | |||
There was a problem hiding this comment.
s/best not/best to not
Signed-off-by: Raghuram Devarakonda <draghuram@gmail.com>
draghuram
force-pushed
the
plugin-order-doc
branch
from
13cb39a
to
59a666c
Compare
shubham-pampattiwar
approved these changes
Oct 6, 2023
sseago
approved these changes
Oct 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for contributing to Velero!
Please add a summary of your change
Added clarification that item action plugins have no order. Please feel free to suggest changes.
Please indicate you've done the following:
/kind changelog-not-requiredas a comment on this pull request.site/content/docs/main.