Project

Profile

Help

Story #4341

closed

As a user, I have comprehensive docs on mirroring, sync modes, and how they interact together

Added by dalley almost 4 years ago. Updated almost 3 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 52
Quarter:

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

Related to Pulp - Test #4448: Test sync mirror=TrueCLOSED - COMPLETEragbalakActions
Related to Pulp - Issue #4449: Default to mirror = FalseCLOSED - CURRENTRELEASEttereshcActions
Actions #1

Updated by daviddavis almost 4 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes
Actions #2

Updated by dalley almost 4 years ago

  • Description updated (diff)
Actions #3

Updated by kersom almost 4 years ago

  • Related to Test #4448: Test sync mirror=True added
Actions #4

Updated by kersom almost 4 years ago

  • Related to Issue #4449: Default to mirror = False added
Actions #5

Updated by dkliban@redhat.com over 3 years ago

  • Tags Documentation added
Actions #6

Updated by dkliban@redhat.com over 3 years ago

  • Sprint set to Sprint 51
Actions #7

Updated by amacdona@redhat.com over 3 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

Actions #8

Updated by rchan over 3 years ago

  • Sprint changed from Sprint 51 to Sprint 52
Actions #9

Updated by amacdona@redhat.com over 3 years ago

  • Status changed from NEW to POST
  • Assignee set to amacdona@redhat.com
Actions #10

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #11

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)

Added by amacdona@redhat.com over 3 years ago

Revision c6ca9f60

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

Actions #12

Updated by amacdona@redhat.com over 3 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions #13

Updated by bmbouter almost 3 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF