Story #4341
closed
As a user, I have comprehensive docs on mirroring, sync modes, and how they interact together
100%
Description
The "mirroring" docs page is currently empty. We need to fill this out with descriptions of what "mirror=True" and "mirror=False" do, and what the default sync mode is. This needs to be well explained to users, with particular emphasis given to the fact that a mirror=True sync on top of a repository with multiple different types of content will be extremely destructive, because mirror syncs don't respect content type boundaries.
https://docs.pulpproject.org/en/3.0/nightly/workflows/mirroring.html
This extends also to the interactions between immediate mode and lazy sync modes, and additive sync. There are "gotchas", like if you first perform a lazy sync and then perform an immediate, additive sync, no artifacts will be downloaded or associated with the existing content units. This is because there are no "new" units and whether the artifacts for the existing units exist or not is not checked.
Related issues
Updated by daviddavis almost 6 years ago
- Groomed changed from No to Yes
- Sprint Candidate changed from No to Yes
Updated by kersom over 5 years ago
- Related to Test #4448: Test sync mirror=True added
Updated by kersom over 5 years ago
- Related to Issue #4449: Default to mirror = False added
Updated by amacdona@redhat.com over 5 years ago
The responsibility of documenting this feature, IMO belongs to the plugins. This isn't necessarily obvious, because the field is implemented by pulpcore, and used by pulpcore-plugin in the declarative version, but plugins are not required to use the sync serializer and declarative version. It is conceivable that some plugins may not use this feature, or that it might behave differently. Fortunately, plugins do not need to do much, since this is a REST API field, if it is used, it is automatically included in the plugin REST documentation.
IMO, I don't think this needs a prose section. Instead, this story should be to remove the stub and improve the help text. Suggestion:
mirror:
boolean (Mirror)
Default: false
If True, remove content that has been removed upstream. If False, the sync will be only additive.
https://pulp-python.readthedocs.io/en/latest/restapi.html#operation/remotes_python_python_sync
Updated by amacdona@redhat.com over 5 years ago
- Status changed from NEW to POST
- Assignee set to amacdona@redhat.com
Added by amacdona@redhat.com over 5 years ago
Updated by amacdona@redhat.com over 5 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulpcore|c6ca9f60c63b85e41b2aab6b6ec909d9bfe1964c.
Updated by bmbouter almost 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
.
Improve the help text for mirrored sync
Be clear that mirror=True is destructive, and remove the unnecessary stub for mirroring.
https://pulp.plan.io/issues/4341
fixes #4341