Red Hat Bugzilla – Bug 1013348
User guide does not describe how to configure Katello into a working state
Last modified: 2015-05-26 14:22:33 EDT
Section Number and Name:
Describe the issue:
The userguide does not describe how to configure Katello into a working state, so it can be used to install and manage servers and applications with it.
Without any knowledge of Puppet, Pulp, general "RHN Satellite" design, etc, it is difficult to even know where to start. Most of the documentation that is not missing is outdated which is confusing when you try to make sense out of your installed Katello server.
Suggestions for improvement:
Create documentation on how to configure Katello into a working state, so it can be used to install and manage servers and applications.
This is a blocker for most people that want to evaluate or use Katello. A proper set of docs is the foundation for both adoption and contribution on a wider scale.
I've seen that the UserGuide is marked "Under Construction" on the Wiki and that a proper guide on "howto get Katello working" is listed at https://fedorahosted.org/katello/wiki/FeatureRequests but I thought I'd make it even more visible and create a bug as well.
Updated the userguide with a link to installation instructions and youtube video tutorials.
Thanks Manjiri for improving on the installation instructions, but two of the Youtube videos are based on a Katello from 1 year ago and the two other videos are of Katello versions that are 6 and 7 months old.
For example, the "Initial Setup" video uses Fedora 16 with Katello, as far as I know, that's not even supported.. not sure how much use these do.
Thanks Magnus for the feedback, working on them.
Moving to Sat6 to be tracked there. Upstream bugs are moving to redmine.
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.
What's the status of this? Does the existing User Guide address this properly?
This is addressed in the Provisioning Guide:
going to CLOSE:CURRENTRELEASE this.
Magnus, please take a look at the Provisioning Guide I linked to here, it discusses the steps necessary to configure Satellite 6 to provision and connect clients.
Feel free to re-open with additional commentary as to what additional docs we need.
Hey Mike, I've had a look, I am missing more detailed documentation regarding Puppet modules.
So far, the documentation reads:
"The next step is to upload a Puppet Module to the Puppet Module repository. You can also use the forge.puppetlabs.com as the URL to mirror Puppet Forge locally. This means that all of the content from Puppet Forge will be available on your Satellite. However, this requires downloading over 2700 modules and can take considerable time, depending on available bandwidth. This example uses the motd module because it is simple, and has no dependencies on other modules.
Procedure 3.4. To Upload a Puppet Module to the Repository:
Download the motd puppet module from https://forge.puppetlabs.com/jeffmccune/motd. The file that you download will have a .tar.gz extension.
Click Content → Products and then click Custom Products in the Name field.
On the Repositories tab, click Puppet Modules to modify the Puppet Modules repository.
In the Upload Puppet Module section, click Browse, and navigate to the motd module that you downloaded.
Click Upload. Satellite displays Content successfully uploaded after the upload completes successfully.
But it does not detail the creation of your own Puppet modules. If it's the Puppet Forge way that is the correct one, I would expect a link to their documentation regarding the matter. Maintaining a Puppet Forge module without the proper tooling is also difficult, so perhaps you should say something about that, if it's not covered by Puppet Forge.
May I ask why we have changed this from 6.1.0+ to 6.1.0?
Thank you for submitting this request.
Since it looks like the request has changed a bit since the bug was originally filed, I am going to close this bug and I have opened a new one specifically for the request about adding specific info on puppet modules to the Provisioning Guide. That new bug can be found here:
Please follow that new bug for updates on this.
*** This bug has been marked as a duplicate of bug 1225166 ***