Commit graph

45 commits

Author SHA1 Message Date
Alicia Cozine
ac9c75d467 updates RHEL packages to 2.9 () 2019-11-06 14:33:17 -05:00
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 () 2019-10-08 13:46:38 -04:00
Kathryn Morgan
f2214951c5 Update intro_installation.rst () 2019-10-03 16:57:30 -04:00
Jon Pugh
6a5cbcf8b8 Link to the GitHub Web UI for the example file. ()
Change link in the Ansible Config docs to the example `ansible.cfg` file, from the raw download to the web user interface.
2019-08-16 15:09:43 -05:00
Otto Winter
e4dc17fa9f Fix small typo in pip install guide ()
Noticed this small typo in the docs:
- `Ansble` -> `Ansible`
2019-08-12 10:21:00 +05:30
ggeorgg
3efb57f64e Typo () 2019-06-13 10:27:23 -04:00
Takashi Sugimura
e17434c19f Correct repository name to install () 2019-05-28 11:13:36 -04:00
Sandra McCann
3129fc0b17 Update RHEL repo for Ansible 2.8 () 2019-05-23 11:31:12 -05:00
Reginald Davis
dd0b0ae47b Lack of "--update" flag in older Ubuntu distros ()
When installing Ansible on older Ubuntu distributions be aware of the lack of ``-u`` or ``--update`` flag.

+label: docsite_pr
2019-05-09 19:09:41 -05:00
Matt Martz
db6cc60352
Migrate command line parsing to argparse ()
* Start of migration to argparse

* various fixes and improvements

* Linting fixes

* Test fixes

* Fix vault_password_files

* Add PrependAction for argparse

* A bunch of additional tweak/fixes

* Fix ansible-config tests

* Fix man page generation

* linting fix

* More adhoc pattern fixes

* Add changelog fragment

* Add support for argcomplete

* Enable argcomplete global completion

* Rename PrependAction to PrependListAction to better describe what it does

* Add documentation for installing and configuring argcomplete

* Address rebase issues

* Fix display encoding for vault

* Fix line length

* Address rebase issues

* Handle rebase issues

* Use mutually exclusive group instead of handling manually

* Fix rebase issues

* Address rebase issue

* Update version added for argcomplete support

* -e must be given a value

* ci_complete
2019-04-23 13:54:39 -05:00
Keith Maxwell
be09f420de Add a title to the installation guide ()
Also remove placeholder text.
2019-04-11 12:33:43 +01:00
Sam Doran
6ce9cf7741
Change default smart connection to ssh on macOS and remove paramiko from requirements.txt ()
* Remove default use of paramiko connection plugin on macOS
    This fix was originally to work around a bug that caused a kernel panic on macOS
    that has since been fixed.
* Remove paramiko from requirements.txt
* Move paramiko checking to common place
* Drop the warnings obfiscation code
* Update pip installation instructions to reflect upstream instructions
* Fix tests on CentOS 6 (Python 2.6) that now show Python deprecation warnings
* Add changelog fragment
2019-04-03 22:35:59 -04:00
Matt Martz
445ff39f94
Become plugins ()
* [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
2019-02-11 11:27:44 -06:00
Richard Diphoorn
ad549e375a Changed 'Control Machine' to 'Control Node' ()
* Changed 'Control Machine' to 'Control Node' in the documentation. Changing the term 'Control Machine' to 'Control Node', to be in line with the basic concepts here: https://docs.ansible.com/ansible/latest/network/getting_started/basic_concepts.html

Also for both entities; Control/Managed using the same common denominator 'Node' brings consistency.

* Updated reference links to new term.
2019-02-08 13:40:09 -06:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" () 2019-01-15 14:53:04 +01:00
Alicia Cozine
4d6807a6b0 uses correct highlighting () 2019-01-02 13:28:35 -05:00
Humberto Nanni
128760cc47 Update intro_installation.rst ()
directions to install ansible on CLR Linux
2018-12-12 13:17:43 -06:00
mbk87
95d810ab94 apt over apt-get ()
* apt over apt-get

* added note on apt-get for older versions
2018-12-05 09:14:48 -05:00
Keith Maxwell
7db2861961 Remove unnecessary --recursive option to git clone ()
From installing / Running from source.
Since the repomerge, Ansible doesn't use submodules. Also, between 2.12.0 and 2.13.0 git dropped '--recursive' in favor of '--recurse-submodules'.
2018-11-08 19:43:43 -06:00
majekw
383da46c32 Document installation procedure on Slackware ()
Add section with installation procedure on Slackware Linux using sbopkg and SlackBuilds.org build scripts repository.
2018-11-07 09:54:00 -06:00
InputValidation
7760b04020 Updated Red Hat Repo ()
Updated Red Hat Repo to current version number
2018-11-06 11:26:22 -06:00
Matt Martz
45ff6df1af Remove Deprecated configs 2.8 ()
* Removed deprecated ANSIBLE_HOSTS

* Bump sudo/su configs to match deprecation version for cli and playbook args

* Bump include configs to match deprecation version for 'include'
2018-11-05 12:08:13 -05:00
Luke Short
9cf407f683 Gentoo installation no longer requires a workaround. ()
The default Python version has been 3.6
since June 2018 and was 3.5 before then.
Ansible supports Python 3.5 and above.
2018-10-17 10:23:23 -05:00
Kamil Wilczek
78e9f452a5 Simplify PPA installation for Ubuntu ()
Adds the `--update` flag to automatically update the cache and the `--yes` flag to disable the Ansible repo description and skips confirmation dialog. +label: docsite_pr
2018-09-17 08:59:20 -05:00
Brian Coca
e9c2695ce7 updated fbsd install instructions () 2018-09-11 15:55:21 -05:00
Sam Doran
d257095976 Change Mac OSX to macOS in installation docs ()
* Change Mac OSX to macOS in docs

* Lowercase via
2018-08-31 11:12:12 -05:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects () 2018-08-13 14:54:14 -05:00
Toshio Kuratomi
da26ba3760 Documentatin fixes 2018-08-13 07:38:38 -07:00
Toshio Kuratomi
c4951cce0b Exorcise Python-2.6 2018-08-13 07:38:38 -07:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Brian Coca
b6f2aad600 ignore ansible.cfg in world writable cwd ()
* ignore ansible.cfg in world writable cwd
 * also added 'warnings' to config
 * updated man page template
2018-06-29 16:46:10 -07:00
Troy Murray
15ce7c5bab change OS X to macOS ()
* change OS X to macOS

<!--- Your description here -->

+label: docsite_pr

* Update all Mac OS X references to be macOS

* Drop extra Mac
2018-06-26 14:09:23 -04:00
Abhijeet Kasurde
01cdc22ac6
Add documentation around package dependencies ()
Documented procedure to handle package dependencies required by
packages which are Ansible dependencies.

Fixes: 
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-06-15 20:44:01 +05:30
Abhijeet Kasurde
e8227e8395
Add note about updating pip ()
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-06-06 09:27:07 +05:30
Pilou
3f5f5faec6 doc: config intro, add link to searched locations () 2018-05-25 00:29:29 -04:00
Alicia Cozine
4b52a54e18 Reduce warnings ()
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
2018-04-25 11:18:52 -07:00
Matt Clay
c262dbfd30 Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
Matt Clay
7e96421132
Handle warnings in docs-build sanity test. () 2018-04-19 23:09:48 -07:00
Toshio Kuratomi
a08459a814
Update info on python support ()
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

  * virtualenv info (previously on the python3 support page)
  * BSD (Link to the working with BSD page)
  * Solaris (Document how to work around the non-POSIX shell on some
    Solaris hosts)

  Fixes 

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:

ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

* Make wording for Solaris troubleshooting better.
2018-04-18 13:04:47 -07:00
scottb
c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of . ()
Disambiguates autogenerated module docs - fixes .
2018-04-17 18:45:07 -07:00
Abhijeet Kasurde
8bc7af2e34 Minor typo in installation guide ()
Change subsription-manger to subscription-manager

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-04-08 14:41:59 -07:00
Elijah Lynn
95d40bcd0a Update fish setup to use source instead of . ()
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."

source: https://fishshell.com/docs/current/commands.html#source
2018-04-05 11:51:55 -07:00
Sam Doran
34dca85417 Update installation docs for RHEL based distributions. ()
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
2018-04-05 10:46:46 -07:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza ()
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
scottb
373b1dcf59
Core Docs Refactor and Redesign ()
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00