Bug 1437472
| Summary: | [RFE] [6.3] Remove the 'Configuring the Provisioning Environment' chapter | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Lucie Jirakova <ljirakov> |
| Component: | Docs Managing Hosts | Assignee: | Michaela Slaninkova <mslanink> |
| Status: | CLOSED NEXTRELEASE | QA Contact: | Russell Dickenson <rdickens> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.2.0 | CC: | adahms, csm, mslanink, sbream, swadeley |
| Target Milestone: | Unspecified | Keywords: | FutureFeature |
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Enhancement | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2017-09-22 01:00:28 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: | |||
| Bug Depends On: | |||
| Bug Blocks: | 1473936 | ||
|
Description
Lucie Jirakova
2017-03-30 11:46:26 UTC
Let's take the recommendations above and implement so that this chapter can be removed from the Host Configuration Guide as part of the work for Satellite 6.3. In addition to the above, let us ensure that when we move the sections on architectures and hardware models to the Provisioning Guide, we add them to the start of the chapter on configuring provisioning resources and update the two sections so that they follow the same title format and style as the other sections. The section on configuring gPXE also looks like it would be a good candidate to go before the chapter summary of the chapter on configuring networking, and can be listed as an optional step. Assigning to Misa for review. Misa - this is probably the largest and most important piece of content for us to remove from the Host Configuration Guide, but it should be relatively straightforward. Let Steve or myself know at any time if you have any questions. Hello Andrew and Steve,
I started working on this BZ ticket, at first on moving content from the Host Configuration Guide [1] to the Puppet Guide [2]. From what I understood, the following sections should be moved:
- 6.2. Parameters
- 6.2.2. Configuring Smart Variables
- 6.2.3. Importing Parameterized Classes from a Puppet Master
- 6.4. Storing and Maintaining Host Information (with both sections "6.4.1 The Puppet Architecture" and "6.4.2 Using Facter and Facts")
I have already converted the content from docbook to asciidoc but don't know where exactly to put the sections. See the updated content of the Puppet Guide:
------------------------------------------------------
3. Adding Puppet Modules to Red Hat Satellite 6
3.1. Creating a Custom Product
3.2. Creating a Puppet Repository in a Custom Product
3.3. Uploading a Puppet Module to a Repository
3.4. Removing a Puppet Module from a Repository
3.5. Adding Puppet Modules from a Git Repository
3.6. Publishing a Content View
3.7. Puppet Environments
3.8. Parameters
3.9. Configuring Smart Class Parameters from Puppet Classes
3.10. Configuring Smart Variables
3.11. Importing Parameterized Classes from a Puppet Master
3.12. Using the Smart Variable Tool
4. Storing and Maintaining Host Information
4.1. The Puppet Architecture
4.2. Using Facter and Facts
4.2.1. Displaying Facts for a Particular Host
4.2.2. Searching for Hosts based on Facts
4.2.3. Custom Fact Reporting
--------------------------------------------------------
Could you or Steve tell me if it is okay, or if it needs reordering? I am not satisfied with the order of the sections 3.9- 3.12, and don't know whether "Storing and Maintaining Host Information" can stay as a separate chapter.
My last question is regarding "6.2.4. Configuring Smart Class Parameters". I was supposed to compare and merge this section with "Configuring Smart Class Parameters from Puppet Classes". However, the procedures are quite different and I am not sure how to merge them.
Thank you!
[1] https://doc-stage.usersys.redhat.com/documentation/en-us/red_hat_satellite/6.3-beta/html-single/host_configuration_guide
[2] https://doc-stage.usersys.redhat.com/documentation/en-us/red_hat_satellite/6.3-beta/html-single/puppet_guide/
Hi Michaela, I think that what you've proposed in comment 3 is fine. I'm not completely satisfied with the ordering of 3.9-3.12 either, but I've been unable to come up with a better order. Let's leave "Storing and Maintaining Host Information" as a separate chapter for now. I agree that the two sections on Configuring Smart Class Parameters don't seem to be addressing the same thing. Perhaps we can find an SME to clarify this? I'll ask in the program call. Perhaps Stephen can help? Thanks, Steve Hi Michaela, I agree with Stephen's comments. Let's replace the smart class section in the Puppet Guide with the one from the Host Configuration Guide, and make the necessary changes in Applying Configuration on Clients During Provisioning. Thanks, Steve *** Bug 1418402 has been marked as a duplicate of this bug. *** This content will be published with the initial release of the Red Hat Satellite 6.3 documentation. Closing. Updating the component and doc type. |