Pure Storage _facts modules need to be renamed to _info and stop returning ansible_facts

[felixfontein]

SUMMARY

According to the requirements, _facts modules should return information that is specific to the host the module runs on as ansible_facts. (See also #54280 for some discussion.)

I think that the following modules do not satisfy this condition: they return information that is not specific to the host machine, but bound to an API account. Please verify whether this is actually the case.

To fix this, the core team thinks the best approach is to rename the _facts modules to _info modules, and change the return value so that if the module is called with the _facts name (should be deprecated, and will then be removed in Ansible 2.13), it should return ansible_facts as now (and print a deprecation message), and if it is called with the _info name, it no longer returns ansible_facts, so that the result needs to be registered. This informs users that they have to change something, won't break their playbooks, and allows them (by switching to the _info names) to verify that their roles and playbooks no longer use the facts.

If that approach doesn't work, or you want to change the module's interface (like rename the return value(s)), it is better to deprecate the _facts module and create a new _info module next to it. To see both approaches implemented, you can take a look at 2d98734 (#60178).

If you have any input — preferred method to solve this, doubts that all modules should be renamed, ... — please write it here!

ISSUE TYPE

• Bug Report

COMPONENT NAME

purefa_facts
purefb_facts

ANSIBLE VERSION

2.9.0

[ansibot]

Files identified in the description:

• lib/ansible/modules/storage/purestorage/purefa_facts.py
• lib/ansible/modules/storage/purestorage/purefb_facts.py

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

click here for bot help

[ansibot]

cc @bannaych @genegr @lionmax @opslounge @raekins @sdodsley @sile16
click here for bot help

[ansibot]

cc @bannaych @genegr @lionmax @opslounge @raekins @sdodsley @sile16
click here for bot help

[felixfontein]

resolved_by_pr #60641