Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 2208326

Summary: Content management guide section about export/import syncable content is not clear
Product: Red Hat Satellite Reporter: Joniel Pasqualetto <jpasqual>
Component: Inter Satellite SyncAssignee: satellite6-bugs <satellite6-bugs>
Status: CLOSED MIGRATED QA Contact: Satellite QE Team <sat-qe-bz-list>
Severity: unspecified Docs Contact:
Priority: low    
Version: 6.13.0CC: bangelic, chrobert, saydas
Target Milestone: UnspecifiedKeywords: Documentation, MigratedToJIRA, Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2024-06-06 16:14:32 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Joniel Pasqualetto 2023-05-18 15:28:35 UTC 
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html/managing_content/synchronizing_content_between_servers_content-management#Exporting_the_Library_Environment_in_a_Syncable_Format_content-management

Section Number and Name: 

8.4. Exporting the Library Environment in a Syncable Format
8.5. Importing Syncable Exports

Describe the issue: 

Instructions are not really clear about how things are supposed to work.

Section 8.4 says that:

"You can then serve the generated content using a local web server on the importing Satellite Server or in another Satellite Server organization."

Then goes about how to modify the CDN configuration to use a custom CDN. 

This is not wrong, but:

1. Configuring the custom CDN should be on the section talking about importing content. It is not related to export.

2. If the user decides to use another webserver to host the content, the guide has no instructions on how the user should proceed. For example:

  - I decided to put my content on webserver.example.com/pub/SATCONTENT
  - configured the custom CDN to use that URL

  questions that come to my mind:
  - how is satellite getting the content?
  - the command on section 8.5 accepts an URL instead of a local path to import?

Section 8.5, simply gives one command to import the content. It does not explain:

1. What exactly is the command doing
2. What are next steps after the command is executed (if any)
3. The note saying the data must be on one of the allowed import paths is true only if the data is stored locally. If it's on a URL it works. This kind of comes with my observation about the import command accepting an URL.

Suggestions for improvement: 

Give examples :-)

- One example of an import being stored locally on Satellite
- One example of an import of an incremental export (stored locally on satellite)
- One example of an import from an external webserver
- One example of an import of an incremental export from an external webserver

Explain what the commands do and if anything else is necessary after running them. Lots of customer come from older versions where they had to manually enable repositories and manually sync them. It's important to let the reader know when the process is done.

Additional information:
Comment 1 Joniel Pasqualetto 2023-05-18 16:39:02 UTC 
I just noticed some of the examples I asked for are present on later sections of the documentation. 

That being said, I would like to suggest that we could group the instructions in different (and isolated) chapters?

This kind of happens on section "8.1. How to Synchronize Content Using Export and Import" but it only talks briefly about it and doesn't really cover the steps. The explanation about the method is distributed on other sections (not always easy to find unless you already know what you're looking for)

This is what I have in mind (just a general idea):

8.1 - How to Synchronize Content Using Export and Import 
   - 8.1.x - group together all possibilities available for that method: export/import + complete/incremental + library/version/repository) in sub-itens

8.2 - How to Synchronize Content Using Syncable exports
    - 8.2.x - group together all possibilities available for that method (export/import + complete/incremental + library/version/repository + from webserver/from local disk)

8.3 - How to synchronize using an Upstream Satellite Server as a Content Store
    - 8.3.x - Any sub-items to help describe how it works

A graphic design of the workflow used by each method would be awesome.
Comment 3 Eric Helms 2024-06-06 16:14:32 UTC 
This BZ has been automatically migrated to the issues.redhat.com Red Hat Issue Tracker. All future work related to this report will be managed there.

Due to differences in account names between systems, some fields were not replicated.  Be sure to add yourself to Jira issue's "Watchers" field to continue receiving updates and add others to the "Need Info From" field to continue requesting information.

To find the migrated issue, look in the "Links" section for a direct link to the new issue location. The issue key will have an icon of 2 footprints next to it, and begin with "SAT-" followed by an integer.  You can also find this issue by visiting https://issues.redhat.com/issues/?jql= and searching the "Bugzilla Bug" field for this BZ's number, e.g. a search like:

"Bugzilla Bug" = 1234567

In the event you have trouble locating or viewing this issue, you can file an issue by sending mail to rh-issues. You can also visit https://access.redhat.com/articles/7032570 for general account information.
Comment 4 Red Hat Bugzilla 2024-10-05 04:26:09 UTC 
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 120 days