fixes #10788 - add foreman-admin for admin tasks

[komidore64]

moving into foreman proper due to conversation in theforeman/foreman-packaging#672

still to do:

• add clamp to foreman deps
• man page

[theforeman-bot]

There were the following issues with the commit message:

• ec4e50d must be in the format Fixes/refs #redmine_number - brief description.

Guidelines are available on the Foreman wiki.

---

This message was auto-generated by Foreman's prprocessor

[komidore64]

renamed commit message

[komidore64]

fixed rubocop warnings

[mmoll]

should be fine without this line in Ruby 1.9, not sure about 1.8

[komidore64]

this line is required for 1.8.

[domcleal]

Foreman core doesn't support 1.8, it can be removed.

[komidore64]

isn't ruby's version on el6 outside of the SCL 1.8 though?

[domcleal]

Yeah, but see below, if packaged in Foreman then we can simply depend on SCL and use 1.9+ on all platforms.

[komidore64]

addressed

[domcleal]

Needs fleshing out some more, removal of all of the TODOs.

[ShimShtein]

@komidore64 Can you fix rubocop errors please?

[domcleal]

TODO still needs doing, and how do you plan for this to be extended from plugins? It should also have a man page.

[komidore64]

@domcleal haha, well yeah. they're TODOs because i'm still working on it :)

how do you plan for this to be extended from plugins?

As for plugins adding more commands, what they'd need to do is add a file to /etc/foreman-admin.d/ upon installation which would contain the command that foreman-admin would then slurp up and use whenever it runs.

Take foreman-tasks for example which needs to add a export-tasks command. foreman-tasks will install /etc/foreman-admin.d/export_tasks.rb that foreman-admin will then pull in whenever it runs. The command classes in plugin commands aren't complicated. There are two base command classes that you can choose to extend: ForemanAdmin::Command and ForemanAdmin::ExternalCommand. These two classes are wrappers on Clamp's Command class so all the usual clamping is applicable.

ForemanAdmin::Command is for actions that will be carried out in the ForemanAdmin ruby environment. A command name must be set (command_name 'my-new-command') and a description must be set (description 'a description of my-new-command'). Then override the execute method to carry out your desired logic.

example:

module ForemanAdmin
  class CountCommand < ForemanAdmin::ExternalCommand
    command_name 'countdown' # required
    description 'prints out numbers counting downward' # required

    # regular clamp-style parameters and options
    option ['--prefix', '-p'], 'PREFIX', 'String to prefix each count', :default => ''
    parameter 'COUNT', 'Number to start from' do |c|
      Integer(c)
    end

    # override is required otherwise command will simply exit
    def execute
      count.downto(1) { |c| puts "#{prefix}#{c}" }
    end
  end
end

ForemanAdmin::External command is for when an action is external to ForemanAdmin requiring the tool to shell out. Specifying the command name and description are required, as well as giving the external_invocation. This the external tool/script that will be called when shelling out. By default ExternalCommand only shells out with #{external_invocation} but you can override the external_command method to append options, arguments, etc into the command that is externally called.

example:

class DebugCommand < ForemanAdmin::ExternalCommand
  command_name 'generate-debug' # required
  description 'Create a foreman-debug tarball for debugging purposes' # required
  external_invocation '/usr/sbin/foreman-debug' # required

  parameter "[ARGS] ...", "args", :hidden => true

  # optional override (this is a clamp method)
  def help
    `#{external_invocation} -h`.gsub(external_invocation, File.expand_path(__FILE__))
  end

  # optional override (this is a ForemanAdmin::ExternalCommand method)
  def external_command
    "#{external_invocation} #{args_list}"
  end

end

[komidore64]

It should also have a man page.

Most of what I just explained above will make it into foreman-admin's man page in one form or another.

[theforeman-bot]

There were the following issues with the commit message:

• 3678e7e must be in the format Fixes/refs #redmine_number - brief description.

Guidelines are available on the Foreman wiki.

---

This message was auto-generated by Foreman's prprocessor

[komidore64]

argh @theforeman-bot!

@ShimShtein addressed rubocop messages.

[domcleal]

This should probably be relative to Foreman's root, and definitely not in /etc for code.

[domcleal]

Lacking i18n support?

[komidore64]

foreman-debug is only in English?

[domcleal]

It is, but Foreman is generally i18n capable, as is our existing main CLI, so I'd expect a new CLI to be i18n capable too. Especially if you're trying to make it more user-centric than the existing mix of tools.

[domcleal]

Seems that with stuff like extensions and locales that using the existing Hammer framework would be quite useful. Any reason this couldn't just be developed in its existing plugins in some way?

[komidore64]

@domcleal hammer was considered, but as you stated earlier hammer is not part of Foreman core.

Since these actions take place on the filesystem (not inside of the rails environment), @mccun934 and I are wanting these actions to only be available to the system's root user which can best be achieved by operating outside of the Foreman/Rails environment entirely instead of using hammer with an API.

[domcleal]

hammer was considered, but as you stated earlier hammer is not part of Foreman core.

Right, but at least we have an existing plugin distribution method for it, existing locale support etc. Reinventing that properly is work.

Since these actions take place on the filesystem (not inside of the rails environment), @mccun934 and I are wanting these actions to only be available to the system's root user which can best be achieved by operating outside of the Foreman/Rails environment entirely instead of using hammer with an API.

It doesn't need to operate over the API though, that's only what hammer_cli_foreman usually does, not hammer_cli.

[tbrisker]

@komidore64,
Thank you very much for your efforts!
This PR has been open for a very long time with no activity.
Please indicate if you plan to continue working on it or not; if not, feel free to close it.
If you do not respond either way within a couple of weeks, I will assume this PR is abandoned and will go ahead and close it for you.

[komidore64]

Portions of foreman-admin need more development, so I'm going to close this.