deprecate or extend documentation for AGNOSTIC_BECOME_PROMPT (temp workaround from #34761)

[agowa]

Summary

I just stumbled across the setting for agnostic become prompts, which was introduced in #34761 as a temporary workaround to avoid breaking ansible tower in 2.5 until 2.6/2.7.

Its documentation is very confusing and it also has probably outlived its usefulness anyway. Therefore I'd like to suggest deprecating/removing it or updating the documentation to explain why exactly it exists. The current wording is very confusing to people that do not know about ansibles console output from before 2.5.

Currently, the description is:

Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method

A better description is probably:

When set to TRUE, any become password prompt asking for user input will start with "BECOME" instead of the used become_method in uppercase. This allows for a become method-agnostic password prompt and thereby allows 3rd party utilizers to be become_method agnostic and provide a simplified way of identifying the need for entering a password.
NOTE: A special case for the prompt exists if also DEFAULT_ASK_PASS is TRUE. In that case the prompt will also include the string [defaults to SSH password] to indicate that the same password as for the SSH transport will be used by default. And it will be asked after an additional prompt for the SSH transport password.

Also, a final note if we do NOT end up deprecating this option, we probably should change the word "SSH" to "Transport" in ask_passwords() for the same reason the prompt was changed to a generic BECOME in the first place.

Issue Type

Documentation Report

Component Name

lib/ansible/cli/init.py

Ansible Version

2.5 and up

Configuration

AGNOSTIC_BECOME_PROMPT

OS / Environment

any

Additional Information

/cc @sivel
relates to: #34761

/cc @bcoca
relates to: #33789

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibot]

Files identified in the description:

• lib/ansible/cli/__init__.py

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