ipa_getkeytab: Create module

[abakanovskii]

SUMMARY

ipa_getkeytab as a fancy wrapper around ipa-getkeytab command

ISSUE TYPE

• New Module/Plugin Pull Request

COMPONENT NAME

ipa_getkeytab

ADDITIONAL INFORMATION

Pretty much a simple wrapper around a ipa-getkeytab using cmd_runner
I tested this module by my hands and it seems to work as intended
I don't know how to write unit tests because for integration test I would need FreeIPA server and client installed so i wrote something up using test_npm as a source

# Before this module you would have to do something like this
    - name: Create keytab
      ansible.builtin.shell: ipa-getkeytab -s <ipa_server> -p <some_principal> -k <some_path>

# Now you can do this like this
    - name: Create keytab
      community.general.ipa_getkeytab:
        path: <some_path>
        principal: <some_principal>
        ipa_server:  <ipa_server>

[ansibullbot]

cc @Akasurde @Nosmoht @justchris1
click here for bot help

[russoz]

I am not sure these parameters make sense. They are never really used and module's code is not reused. Code is simpler without them.
Additionally, you might want to take a look at StateModuleHelper, see https://docs.ansible.com/ansible/latest/collections/community/general/docsite/guide_modulehelper.html for details on how to use it. There is a number of modules in this collection using that you can look up to for examples of actual usage.

[russoz]

Is there a minimum level for the Kerberos library? In any case, the library (with or without min version) should be cited in the requirements, for completeness.

[abakanovskii]

Well it comes with freeipa-client package, I used this sentence from man pages :)

[russoz]

Maybe add a link to those man pages (in one of those sites that publish them)? Or some other relevant reference.

[abakanovskii]

It seems that there are not much trusted resources with man page of ipa-getkeytab, there are source file for that (https://github.com/freeipa/freeipa/blob/master/client/man/ipa-getkeytab.1) but other than that I found Ubuntu docs https://manpages.ubuntu.com/manpages/jammy/man1/ipa-getkeytab.1.html
What do you think? Should I add that link in the full description of a module?

[russoz]

Yup, one of those (whichever you prefer). https://linux.die.net/man/1/ipa-getkeytab also appears out of google, just as an example.
Anyways, if you prefer not to add that to the description, maybe add it to the notes section.
Come to think of it, I will review all my modules (that call commands) to add links to the respective man pages. :-)

[abakanovskii]

Agreed :) I used ubuntu doc as linux.die.net don't have all options documented
I'll do the same thing for a kutils module then

[felixfontein]

Thanks!

[abakanovskii]

Thanks for the review! @felixfontein

[russoz]

LGTM