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.
Document URL:
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html/provisioning_hosts/index
Section Number and Name:
Provisioning Hosts
Describe the issue:
Current provisioning documentation contains much information that could be overwhelming for new Satellite users or someone who is new to the provisioning. I know that we expect from our customers some technical-level knowledge before they’ll start using Satellite provisioning, but nevertheless, I still believe that having some introduction and easier-to-understand documentation would benefit significantly to our customers.
Right now with current documentation, users may try every provisioning method that is mentioned in the documentation, making tons of configuration changes, troubleshooting, and trying just to see what might be the best provisioning method for them.
Having documentation that will guide the user through all provisioning methods, and shows them the comparison and differences between them can greatly benefit the user and in the end, save our support team some time with troubleshooting and answering questions.
Suggestions for improvement:
1. Introduction to provisioning
Document where we will describe the basics, methods that can be used in the Foreman/Satellite scope, explanation of terms that we used, and so on.
There is an Intro section right now, but that's not anywhere near what it could be.
2. Comparison table of provisioning methods
Table from where users can easily see what provisioning method is the best one for them and their environment.
See the upstream post & (outdated) Satellite KC:
https://community.theforeman.org/t/provisioning-methods-comparison-table/32953/2https://access.redhat.com/solutions/2674001
3. Split provisioning guide by provisioning methods
It’s simple: One guide = One provisioning method, don't mix them together.
4. Debugging provisioning
As an example see the upstream post:
https://community.theforeman.org/t/debugging-provisioning/32952
I realize that this is a big change and will require a lot of effort, doing all of these changes in one PR is not a good idea, I wanted mainly to draft the whole effort so the goal is clear and it’s known what has to be done. I offer my full support for the technical part of the documentation, feel free to reach me
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.