This bug has been migrated to another issue tracking site. It has been closed here and may no longer be being monitored.

If you would like to get updates for this issue, or to participate in it, you may do so at Red Hat Issue Tracker .
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 2262866 - Missing backup type description
Summary: Missing backup type description
Keywords:
Status: CLOSED MIGRATED
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Satellite Maintain
Version: 6.11.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Satellite QE Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-02-05 20:51 UTC by Andrei Tudor Corduneanu
Modified: 2024-10-05 04:27 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2024-06-06 17:01:42 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker   SAT-23081 0 None Migrated None 2024-06-06 17:01:41 UTC

Description Andrei Tudor Corduneanu 2024-02-05 20:51:27 UTC 
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Performing_a_Full_Backup_admin

Section Number and Name: 
8.2. Performing a Full Backup of Satellite Server or Capsule Server

Describe the issue: 
For the three main methods of backing up Satellite, the documentation says: 
"For more information about each of these methods, you can view the usage statements for each backup method".
And then shows the command lines:
 - satellite-maintain backup offline --help
 - satellite-maintain backup online --help
 - satellite-maintain backup snapshot --help

But none of those actually show description of the backup type in the Usage.

Suggestions for improvement: 
There should be a description for each of the main backup types, close to where they are first referenced.

Additional information:
Comment 2 Eric Helms 2024-02-06 19:33:14 UTC 
Can you expand on what specification information you are looking for to be included?
Comment 3 Andrei Tudor Corduneanu 2024-02-06 21:24:39 UTC 
I would be interested in having, for each type, information as the following (and similar):
 - offline = The Satellite is not available for use during the process, that generally (and depending on...) lasts between .... and ..... minus/hours.
 - online = The Satellite is available during the process, each pulp operations restarts the backup, and the implications of this (it could virtually run forever, not recommended).
 - snapshot = How exactly is this different from the other two.
Comment 4 Eric Helms 2024-02-08 16:28:11 UTC 
Thank you for that information. I forgot to ask -- are you wanting to see this information on the --help text or within the documentation?
Comment 5 Andrei Tudor Corduneanu 2024-02-11 17:40:01 UTC 
I think it would make sense to see a very brief description in the --help message, and then a more verbose version complete with implications and differences between each backup type in the product documentation, like describing the use cases where each type is fit.
Comment 6 Eric Helms 2024-06-06 17:01:42 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 7 Red Hat Bugzilla 2024-10-05 04:27:14 UTC 
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 120 days
Note You need to log in before you can comment on or make changes to this bug.