Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt Admin guide for Katello and Foreman-EL #684

Closed
wants to merge 4 commits into from

Conversation

melcorr
Copy link
Member

@melcorr melcorr commented Aug 20, 2021

Based on the comments here: theforeman/theforeman.org#1879 (comment)

And in line with what was described in #676, this PR is to adapt the Admin guide to meet the requirements of foreman-el and katello scenarios.

There are a few comments I need further guidance on:

Admin guide, chapter 2: I don't know what prerequisite to add:

To use this section, you must have foreman-maintain installed (how do they do that?)
And is there an alternative method? I can add that in?
At the moment, i've just added an ifndef for foreman-deb builds for Chapter 2.

Chapter 5.4.5. - I'll add a new issue to address this. I don't know how to improve it. It's out of scope

Regarding:

Chapter 8: again, RPM-only due to foreman-maintain usage. Mention of /root/ssl-build and various other
directories makes it Katello-only. /var/opt/rh/rh-postgresql12 makes it EL7 only.

I've ifndef'd it to stream it out of foreman-deb
I'd happily add in alternative directories if anyone can provide me with the info.

Chapter 13.3.3 & Chapter 13.7 - out of scope for now - l do not know how to make it better. I'll create an issue.

I added in the debian logs and excluded debian where I was certain. The scope of this PR is not to have it complete for Debian. I was just trying to be helpful and clean what I could.

Cherry-pick into:

  • Foreman 3.0
  • Foreman 2.5 (Satellite 6.10)
  • Foreman 2.4
  • Foreman 2.3 (Satellite 6.9)
  • Foreman 2.1 (Satellite 6.8)

Melanie Corr added 2 commits August 24, 2021 12:34
For foreman-el and katello scenarios where the user might not
have installed foreman-maintain. Give the option of how to
install foreman-maintain, and tell them as an alternative they
can simply use systemctl
* Update debian apache log filepath
* Update very outdated Puppet filepath
# yum install `{foreman-maintain}`
----

Alternatively, you can also use `systemctl` to start and stop services:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still struggle with this. With this you still have services running in the background, like dynflow (job processing). I don't really know what the intent of this chapter is. It's really written as all or nothing, but that's really vague. So I don't really have good advice on what to write.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember when this chapter was introduced if I'm honest. I think that we wanted a way to show the foreman-maintain service options. It's technically not a procedure just a reference list of options for starting and stopping. It's totally lacking context.
I didn't understand your dynaflow comment from the issue, and commented as such. I get it a small bit better. I can add a note in.

For systemctl users in el and katello scenarios
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants