apt_repository module requires gpg to be installed target, but docs don't mention

[zoredache]

Summary

The apt_repository will fail with a somewhat confusing error if gnugp, and dirmngr manager are not installed. Neither of these packages are Required/Essential/Important, and may not be already installed in minimal systems that you might want to run apt_repository on.

The fix might be to just include gnupg in the requirements section of the docs.

Issue Type

Documentation Report

Component Name

apt_repository

Ansible Version

$  ansible --version
ansible [core 2.11.4]
  config file = ...
  configured module search path = ...
  ansible python module location = ...
  ansible collection location = ...
  executable location = /usr/local/bin/ansible
  python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110]
  jinja version = 3.0.1
  libyaml = True

Configuration

$ ansible-config dump --only-changed

OS / Environment

Mostly a docs issue so this is N/A. But apt_repository applies to Debian, Ubuntu, and forks.

Additional Information

Tells people that need gnupg when using apt_repository.

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibot]

Files identified in the description:

• lib/ansible/modules/apt_repository.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[bcoca]

the real dependency is apt-key, which itself requires gpg

also note that apt-key is deprecated and we should look to using the new way of accepting repositories in debian

[tigerblue77]

I transformed my

apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 93C4A3FD7BB9C367

to

gpg --keyserver keyserver.ubuntu.com --recv 93C4A3FD7BB9C367 && \
gpg --export 93C4A3FD7BB9C367 > /usr/share/keyrings/ansible-archive-keyring.gpg

thanks to this topic. Don't hesitate to suggest improvments :)

[samccann]

@bcoca the docs fix here seems quite simple - add gpg to the requirements on the apt_repository module. But I'm unsure if you want to keep this ticket open for a bugfix to change apt_key to something else because it's deprecated?

[bcoca]

since then i've updated apt_repository to use gpg in case apt-key is not present so 'requirements: apt-key or gpg

[samccann]

Documentation fix:

Add a line above https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/apt_repository.py#L102
That says:

• apt-key or gpg

[tigerblue77]

@bcoca As apt-key is deprecated, you should probably only use gpg and install it automatically if needed

[bcoca]

@tigerblue77 it is a fallback for now as people tend to keep things around much longer than they should and the module should work for them too.

[akamanzi]

@samccann @bcoca I can update the requirements section if that's the fix and if no one has taken on this issue

[samccann]

Sounds good, thanks @akamanzi !!

[akamanzi]

@samccann, check PR #78586