Bug 1383190 - An overview of lazy sync must be added to the Architecture Guide
Summary: An overview of lazy sync must be added to the Architecture Guide
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Architecture Guide
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
high
high vote
Target Milestone: Unspecified
Assignee: Stephen Wadeley
QA Contact: Brandi Munilla
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-10-10 06:57 UTC by Andrew Dahms
Modified: 2019-09-25 20:38 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-10-13 08:28:29 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Andrew Dahms 2016-10-10 06:57:33 UTC
A brief overview of the lazy sync feature, its purpose, and the major modes of operations must be added to the Architecture Guide.

Comment 1 Andrew Dahms 2016-10-10 06:58:42 UTC
Assigning to Stephen for review.

Stephen - looks like a good location for this might be as a new paragraph in the middle of the following:

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/architecture-guide#sect-Defining_Content_Sources

Comment 2 Andrew Dahms 2016-10-10 07:00:08 UTC
Reference -

"Lazy Sync

A new field has been added to repositories called download policy. With it, users can speed up repository synchronization by downloading only the repository’s metadata and deferring the download of content until later. The three values for download policy are immediate, on demand, and background. For on demand synchronization, only the metadata is downloaded during sync and packages are fetched and stored on the filesystem when clients request them. For background syncs, a background task will download all packages after the initial sync. The immediate option is what Katello currently provides where all metadata and packages are downloaded during sync. Currently, lazy sync is only available for yum repositories."

From http://www.katello.org/docs/3.0/release_notes/release_notes.html

Comment 3 Stephen Wadeley 2016-10-10 14:29:50 UTC
Hello

That section contains this sentence with link:

For detailed instructions on setting up content sources see the Red Hat Satellite Content Management Guide. 

The link goes to "https://access.redhat.com/documentation/en/red-hat-satellite/version-6.2/content-management-guide/"

That is an out of date URL

I propose we change the sentence to say:

For detailed instructions on setting up content sources see the "Importing Red Hat Content" section of the Red Hat Satellite Content Management Guide. 

and link directly to:
Chapter 4. Importing Red Hat Content - Red Hat Customer Portal - https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/content-management-guide/chapter-4-importing-red-hat-content

If we are going to add text as per comment 0, then we best do it before the sentence I mentioned above.

Comment 5 Andrew Dahms 2016-10-11 01:28:42 UTC
Hi Stephen,

Thank you for the needinfo request.

The addition to the guide itself and to the glossary look good to me, and I'm happy for this to be passed on to peer review.

The only note I have to pass on is that the new link format for the Content Management Guide (and all titles, going forward) is the following -

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/content-management-guide

Note the addition of the '/single/' format indicator.

I suspect we may need to review our other links as well to ensure they are working as intended, although that is, needless to say, outside the scope of this particular bug.

Kind regards,

Andrew

Comment 8 Brandi Munilla 2016-10-12 20:18:15 UTC
Stephen,

All set.

Thanks,
Brandi

Comment 9 Stephen Wadeley 2016-10-13 08:28:29 UTC
Hello


These changes are now live on the customer portal.

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/architecture-guide/43-content-sources


Note You need to log in before you can comment on or make changes to this bug.