[PULP-214] Added docs about on-demand content streaming caveats #6101
+70
−9
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
pedro-psb
changed the title
dralley
reviewed
Dec 3, 2024
|
|
||
| Unless a plugin has enabled either the 'on_demand' or 'streamed' values for the `policy` attribute | ||
| you will receive an error. Check that plugin's documentation also. | ||
|
|
||
| Example of the "Create Remote" endpoints for some plugins that supports that: |
There was a problem hiding this comment.
"these features" sounds better than "that"
dralley
reviewed
Dec 3, 2024
|
|
||
| * Given User A and User B both synced the same on-demand content from their separate remotes (there are two different sources for the same content). | ||
| * When User B request the content | ||
| * Then the credentials used for the download could be User's A. |
dralley
reviewed
Dec 3, 2024
| * When User B request the content | ||
| * Then the credentials used for the download could be User's A. | ||
|
|
||
| If a user don't want their registered Remotes to be indirectly used by other users, they should use a separate domain. |
dralley
reviewed
Dec 3, 2024
| In a worst case, the Content is shared across multiple Repositories and the Remote's removal | ||
| can invalidate all those repositories at once. | ||
|
|
||
| In either cases, proceed the deletion of a remote with great care. |
There was a problem hiding this comment.
In either case, proceed with the deletion of a remote with great care.
dralley
reviewed
Dec 3, 2024
| @@ -39,25 +41,82 @@ instance, syncing from a nightly repo would cause Pulp to store every nightly ev | |||
| is likely not valuable. Units created from this mode are | |||
There was a problem hiding this comment.
"Also download all metadata is likely not valuable" is nearly incomprehensible
There was a problem hiding this comment.
"Also download all metadata" and "is likely not valuable" are 17 lines apart 😅
dralley
reviewed
Dec 3, 2024
| ### External dependency and error handling | ||
|
|
||
| The content might become unavailable or corrupted on the remote server. | ||
| This makes it hard for Pulp to provide an accurate error messages. |
There was a problem hiding this comment.
replace with "provide an accurate error message" or "provide accurate error messages"
dralley
reviewed
Dec 3, 2024
| ### Implicit credential sharing within a domain | ||
|
|
||
| In the same domain, a request to a on-demand content may use any available Remotes associated with that content, | ||
| regardless of who created it. |
dralley
reviewed
Dec 3, 2024
|
|
||
| * Given User A and User B both synced the same on-demand content from their separate remotes (there are two different sources for the same content). | ||
| * When User B request the content | ||
| * Then the credentials used for the download could be User A's. |
There was a problem hiding this comment.
could potentially be User A's
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.
We have some problems we can't solve with our current design of how RemoteArtifact and on-demand works.
We are documenting known caveats and limitation to help avoiding surprises.
Closes #1975 #3212