0023: Converge Foreman and Katello adminstration scripts by ehelms · Pull Request #26 · theforeman/rfcs

ehelms · 2016-10-11T17:10:16Z

No description provided.

ares · 2016-10-12T08:24:07Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+
+ * centralize adminstration into hammer_cli_foreman_admin
+  - this would allow a single repository to manage scripts
+  - this would allow users to have discoverability (e.g hammer admin --help to see list of optional commands)


I like the idea, but it should be somehow noted that such commands can be run only on satellite server and ideally have some detection so if it's ran somewhere else, user would get clear error message. (rpm -q $package might be enough).

dLobatog · 2016-10-13T11:51:52Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

typo at the end and centralization

dLobatog · 2016-10-13T11:54:12Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+ * foreman-tail
+ * foreman-rake
+ * foreman-config
+ * hammer_cli_foreman_admin


katello-selinux-relabel, katello-certs-check, katello-certs-sign, foreman-selinux-relabel

These are all in katello-selinux, I'd keep that package.

+1 for katello-certs checks

sean797 · 2016-10-13T17:41:57Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

sean797 · 2016-10-13T17:48:39Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+ * hammer_cli_foreman_admin
+
+Based on the current design of the scripts and where they live, the following design has been put forth:
+


Probably goes without saying but we should also leave the current scripts locations working with a deprecated message for at least one release.

ehelms · 2017-02-01T22:24:17Z

I updated this RFC based on comments (sorry if I missed any, it has been a while) and opened an initial PR to get some design discussion going.

iNecas · 2017-02-10T10:26:22Z

I was looking into very similar context while looking into health-checking, remediation scripts and upgrade helpers. My additional requirements are:

zero-configuration: the tool should be able to detect what's running on the system and provide corresponding functionality based on that.
ability to use the same version of the tool against different versions of foreman/katello/satellite,
the tool will have definitions of the operations and will be able to determine what to do with the specific version.

This takes us to lower the dependencies on other things that are delivered as part of foreman/satellite (including even hammer).

I'm currently putting a POC of the code structure together, will have something to show next week.

iNecas · 2017-02-10T10:30:03Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+
+
+# Drawbacks
+[drawbacks]: #drawbacks


hammer is primarily used for taking to the foreman via API. This includes issues, such as:

slow start time: since there is already quite a lot of functionality, it takes more and more time to load (on my setup, 2 seconds just to load the whole thing. For now, I don't see too much benefits of building the tool as plugin into hammer, vs. standalone tool around clamp, limiting and focusing on maintenance tasks.

I see this as two different pieces:

hammer the code/library/integration with API

hammer as THE CLI tool for Foreman

As a user, it is nice to be able to have one tool and let it tell you about the functionality you can do from an interface perspective (ignoring whats under the hood).

I suppose two CLI tools would be OK and limit user's required sphere of knowledge. For example, OpenShift has oc and oadm. However, I do find it annoying that you have to still figure out what you can do in one tool and what operations you do in the other tool.

Yeah, I thought more on using hammer as a framework, integrating "hammer debug" into the foreman's "hammer" command was not good idea, it should have been perhaps separate command like this one.

What I find very useful is subcommands capabilities of hammer, this will be collections of subcommands essentially. If clamp (or whatever we choose to work with) provides that, that is fine I think.

In any case, this should be definitely a separate binary foreman-maintain instead of hammer (to be honest I think foreman-cli should be named foreman-cli from the day one).

I see no issue in having a separate maintenance tool. I see hammer as how the operator interacts with Foreman operationally. Maintenance and/or debug tasks IMHO should always be in a separate tool, as there will be tasks that can't be run remotely. Additionally, as an admin, I run hammer on my workstation.

I dont want to have to remember 'commands that I can only run locally' versus 'commands that I can run remotely'

iNecas · 2017-02-10T10:30:43Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+# Alternatives
+[alternatives]: #alternatives
+
+ 1) Use something other than hammer_cli_foreman_admin for CLI-ing scripts together like regular opt-parse


iNecas · 2017-02-10T10:31:23Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+
+Subcommands:
+ debug                         Generate debug output for upload
+ services                      Manage status of services


I would rename this to health-checks

I feel like they are two distinct pieces, solely because 'services' does more than 'check'. The current katello-services tool provides start, stop and restart abilities thus managing services. We could split out the status aspect.

iNecas · 2017-02-10T10:32:45Z

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md

+ backup                        Generate server backup
+ restore                       Use previously generated backup to restore server
+ remove                        Remove all RPMs and configuration from the server
+ tail                          Tail all relevant logs


another administrative tasks:

upgrades - I don't think the current way of doing so inside installer hooks is a good approach

remediation scripts - fixes/suggestions for things we know might get wrong

ehelms · 2017-02-13T17:10:38Z

Whichever route we go, I'd love to avoid the "plugin" style for administration tooling and scripts and have a single repository and tool for all functionality.

iNecas · 2017-02-13T17:14:02Z

This complies with the design decisions we do: what we need to address is that the tool needs to be sensitive enough on what's present on the system it's run against and offer just the things that are relevant to the version of the system (upstream vs. downstream, plugins presence, registered proxies etc.)

lzap · 2017-02-16T15:55:49Z

I am very happy we are building such a tool, I will do my part and rewrite foreman admin logging subcomand into this form once you have the first release and deprecate the old one.

ares reviewed Oct 12, 2016

View reviewed changes

dLobatog reviewed Oct 13, 2016

View reviewed changes

sean797 reviewed Oct 13, 2016

View reviewed changes

text/0016-katello-as-a-plugin/0022-converge-katello-foreman-scripts.md Outdated

Copy link

Member

sean797 Oct 13, 2016 •

edited

Loading

Choose a reason for hiding this comment

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

s/``/```/

sean797 reviewed Oct 13, 2016

View reviewed changes

0023: Converge Foreman and Katello adminstration scripts

7f5d3c3

ehelms force-pushed the 0023-converge-katello-foreman-scripts branch from 89163c9 to 7f5d3c3 Compare February 1, 2017 22:16

ehelms mentioned this pull request Feb 1, 2017

[DNM] Add remove command as an admin tool theforeman/hammer-cli-foreman-admin#5

Closed

iNecas reviewed Feb 10, 2017

View reviewed changes

		* hammer_cli_foreman_admin

		Based on the current design of the scripts and where they live, the following design has been put forth:

Conversation

ehelms commented Oct 11, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dLobatog Oct 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sean797 Oct 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ehelms commented Feb 1, 2017

Uh oh!

iNecas commented Feb 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ehelms commented Feb 13, 2017

Uh oh!

iNecas commented Feb 13, 2017

Uh oh!

lzap commented Feb 16, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Comments

dLobatog Oct 13, 2016 •

edited

Loading

sean797 Oct 13, 2016 •

edited

Loading