You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/user_guide
Matt Martz 445ff39f94
Become plugins (#50991)
* [WIP] become plugins

Move from hardcoded method to plugins for ease of use, expansion and overrides
  - load into connection as it is going to be the main consumer
  - play_context will also use to keep backwards compat API
  - ensure shell is used to construct commands when needed
  - migrate settings remove from base config in favor of plugin specific configs
  - cleanup ansible-doc
  - add become plugin docs
  - remove deprecated sudo/su code and keywords
  - adjust become options for cli
  - set plugin options from context
  - ensure config defs are avaialbe before instance
  - refactored getting the shell plugin, fixed tests
     - changed into regex as they were string matching, which does not work with random string generation
     - explicitly set flags for play context tests
 - moved plugin loading up front
 - now loads for basedir also
 - allow pyc/o for non m modules
 - fixes to tests and some plugins
 - migrate to play objects fro play_context
 - simiplify gathering
 -  added utf8 headers
 - moved option setting
 - add fail msg to dzdo
 - use tuple for multiple options on fail/missing
 - fix relative plugin paths
 - shift from play context to play
 - all tasks already inherit this from play directly
 - remove obsolete 'set play'
 - correct environment handling
 - add wrap_exe option to pfexec
 - fix runas to noop
 - fixed setting play context
 - added password configs
 - removed required false
 - remove from doc building till they are ready

future development:
  - deal with 'enable' and 'runas' which are not 'command wrappers' but 'state flags' and currently hardcoded in diff subsystems

* cleanup

  remove callers to removed func
  removed --sudo cli doc refs
  remove runas become_exe
  ensure keyerorr on plugin
  also fix backwards compat, missing method is attributeerror, not ansible error
  get remote_user consistently
  ignore missing system_tmpdirs on plugin load
  correct config precedence
  add deprecation
  fix networking imports
  backwards compat for plugins using BECOME_METHODS

* Port become_plugins to context.CLIARGS

This is a work in progress:
* Stop passing options around everywhere as we can use context.CLIARGS
  instead

* Refactor make_become_commands as asked for by alikins

* Typo in comment fix

* Stop loading values from the cli in more than one place

Both play and play_context were saving default values from the cli
arguments directly.  This changes things so that the default values are
loaded into the play and then play_context takes them from there.

* Rename BECOME_PLUGIN_PATH to DEFAULT_BECOME_PLUGIN_PATH

As alikins said, all other plugin paths are named
DEFAULT_plugintype_PLUGIN_PATH.  If we're going to rename these, that
should be done all at one time rather than piecemeal.

* One to throw away

This is a set of hacks to get setting FieldAttribute defaults to command
line args to work.  It's not fully done yet.

After talking it over with sivel and jimi-c this should be done by
fixing FieldAttributeBase and _get_parent_attribute() calls to do the
right thing when there is a non-None default.

What we want to be able to do ideally is something like this:

class Base(FieldAttributeBase):
    _check_mode = FieldAttribute([..] default=lambda: context.CLIARGS['check'])

class Play(Base):
    # lambda so that we have a chance to parse the command line args
    # before we get here.  In the future we might be able to restructure
    # this so that the cli parsing code runs before these classes are
    # defined.

class Task(Base):
    pass

And still have a playbook like this function:

---
- hosts:
  tasks:
  - command: whoami
    check_mode: True

(The check_mode test that is added as a separate commit in this PR will
let you test variations on this case).

There's a few separate reasons that the code doesn't let us do this or
a non-ugly workaround for this as written right now.  The fix that
jimi-c, sivel, and I talked about may let us do this or it may still
require a workaround (but less ugly) (having one class that has the
FieldAttributes with default values and one class that inherits from
that but just overrides the FieldAttributes which now have defaults)

* Revert "One to throw away"

This reverts commit 23aa883cbed11429ef1be2a2d0ed18f83a3b8064.

* Set FieldAttr defaults directly from CLIARGS

* Remove dead code

* Move timeout directly to PlayContext, it's never needed on Play

* just for backwards compat, add a static version of BECOME_METHODS to constants

* Make the become attr on the connection public, since it's used outside of the connection

* Logic fix

* Nuke connection testing if it supports specific become methods

* Remove unused vars

* Address rebase issues

* Fix path encoding issue

* Remove unused import

* Various cleanups

* Restore network_cli check in _low_level_execute_command

* type improvements for cliargs_deferred_get and swap shallowcopy to default to False

* minor cleanups

* Allow the su plugin to work, since it doesn't define a prompt the same way

* Fix up ksu become plugin

* Only set prompt if build_become_command was called

* Add helper to assist connection plugins in knowing they need to wait for a prompt

* Fix tests and code expectations

* Doc updates

* Various additional minor cleanups

* Make doas functional

* Don't change connection signature, load become plugin from TaskExecutor

* Remove unused imports

* Add comment about setting the become plugin on the playcontext

* Fix up tests for recent changes

* Support 'Password:' natively for the doas plugin

* Make default prompts raw

* wording cleanups. ci_complete

* Remove unrelated changes

* Address spelling mistake

* Restore removed test, and udpate to use new functionality

* Add changelog fragment

* Don't hard fail in set_attributes_from_cli on missing CLI keys

* Remove unrelated change to loader

* Remove internal deprecated FieldAttributes now

* Emit deprecation warnings now
7 years ago
..
shared_snippets Add docs detailing how to convert many with_X style loops to use loop and filters (#40964) 8 years ago
become.rst standardize connection variable names (#51776) 7 years ago
command_line_tools.rst Refine plugin docs (#49324) 7 years ago
index.rst Core Docs Refactor and Redesign (#36067) 8 years ago
intro.rst Remove more docs build errors (#45364) 7 years ago
intro_adhoc.rst doc(user_guide): fix typos (#47425) 7 years ago
intro_bsd.rst Remove use of simplejson throughout code base (#43548) 7 years ago
intro_dynamic_inventory.rst Broken link fixed. (#51492) 7 years ago
intro_getting_started.rst Become plugins (#50991) 7 years ago
intro_inventory.rst standardize connection variable names (#51776) 7 years ago
intro_patterns.rst Prefer https:// links in the docs site 7 years ago
intro_windows.rst Core Docs Refactor and Redesign (#36067) 8 years ago
modules.rst Prefer https:// links in the docs site 7 years ago
modules_intro.rst Prefer https:// links in the docs site 7 years ago
modules_support.rst link to KB article -certified modules (#50050) 7 years ago
playbook_pathing.rst doc(user_guide): fix typos (#47425) 7 years ago
playbooks.rst bad space (#47667) 7 years ago
playbooks_advanced_syntax.rst Updates variables docs: facts examples, headers, links, etc. (#47767) 7 years ago
playbooks_async.rst Fix docs syntax highlighting errors (#50836) 7 years ago
playbooks_best_practices.rst updated documentation fixing #47202 (#47267) 7 years ago
playbooks_blocks.rst updated documentation fixing #47202 (#47267) 7 years ago
playbooks_checkmode.rst docs: Document disabling diff on task level (#37998) 8 years ago
playbooks_conditionals.rst add note about register + skip (#51339) 7 years ago
playbooks_debugger.rst Add shorthand debugger method to recreate the task from the original ds (#46987) 7 years ago
playbooks_delegation.rst Update playbooks_delegation.rst (#51949) 7 years ago
playbooks_environment.rst clarify environment (#50987) 7 years ago
playbooks_error_handling.rst Update changed_when and failed_when examples (#50411) 7 years ago
playbooks_filters.rst Fix yaml indentation for from_yaml_all filter example (#51998) 7 years ago
playbooks_filters_ipaddr.rst ipaddr: Add missing documenation about network/prefix filter (#49532) 7 years ago
playbooks_intro.rst Become plugins (#50991) 7 years ago
playbooks_lookups.rst Prefer https:// links in the docs site 7 years ago
playbooks_loops.rst grammer fix and changed description to iteratively from recursively. (#50837) 7 years ago
playbooks_module_defaults.rst Add k8s module_defaults group and document (#51093) 7 years ago
playbooks_prompts.rst added unsafe toggle to vars_prompt (#49219) 7 years ago
playbooks_python_version.rst Core Docs Refactor and Redesign (#36067) 8 years ago
playbooks_reuse.rst Add link to include / import module doc to discussion of include / import. (#48932) 7 years ago
playbooks_reuse_includes.rst update example to YAML style in documentation (#45968) 7 years ago
playbooks_reuse_roles.rst Correct docsite typos: it's -> its (#50812) 7 years ago
playbooks_roles.rst Reduce warnings (#39254) 8 years ago
playbooks_special_topics.rst clarifies FAQ answer about env vars (#48432) 7 years ago
playbooks_startnstep.rst Core Docs Refactor and Redesign (#36067) 8 years ago
playbooks_strategies.rst Only one strategy_plugins page (#49442) 7 years ago
playbooks_tags.rst docs: tags: streamline indentation (#50875) 7 years ago
playbooks_templating.rst Add now() jinja2 global func for getting the date/time (#43792) 7 years ago
playbooks_tests.rst Correct match test documentation (#50229) 7 years ago
playbooks_variables.rst standardize connection variable names (#51776) 7 years ago
playbooks_vault.rst Add anchors to some guides and all module categories (#36642) 8 years ago
plugin_filtering_config.rst Update plugin filter documentation (#46665) 7 years ago
quickstart.rst Update documentation based on 301 permanent redirects (#43675) 7 years ago
vault.rst Clean up Vault docs in User Guide. (#46188) 7 years ago
windows.rst Core Docs Refactor and Redesign (#36067) 8 years ago
windows_dsc.rst Code example improvements in Windows documentation (#45055) 7 years ago
windows_faq.rst Fix typo 7 years ago
windows_setup.rst Update windows_setup.rst (#50941) 7 years ago
windows_usage.rst fixes typo in windows usage guide (#49672) 7 years ago
windows_winrm.rst Add a missed command (#50781) 7 years ago