Commit graph

504 commits

Author SHA1 Message Date
Patrick Gagnon-Renaud
d6b40c935f Fix Passlib example in FAQ (#21997)
* Fixes passlib example in FAQ to reduce the number of rounds to 5000

As stated in issue #15326, the default number for glibc is 5000, where
the default for passlib is 656000.

I actually found out when I spend few hours trying to understand why
ansible was taking almost x3 the time to run a playbook when using a
user with sudo and password (comparared to sudo with NOPASSWD set).
Well, it was because the user was created using ansible and the passlib
example found in the docs' FAQ.

Reducing the numbers of rounds to 5000 will ensure a better experience
with ansible for newcomers when using sudo with a password.

* Fixes passlib example in FAQ to reflect the API changes in passlib 1.7

Method encrypt() was deprecated in 1.7 and renamed to hash(), which
happened almost a year ago.

https://passlib.readthedocs.io/en/stable/lib/passlib.ifc.html#passlib.ifc.PasswordHash.encrypt
2017-02-27 10:14:02 -05:00
Toshio Kuratomi
9d85d81ed0 Make the metadata docs agree with what's currently implemented 2017-02-27 09:27:00 -05:00
Wouter
5d39056379 Correct link in documentation (#21894)
Fixes #20692
2017-02-24 22:37:13 +00:00
John R Barker
fdd03916a3 Document ANSIBLE_METADATA (#21250)
* Document ANSIBLE_METADATA

* Formatting

* Reive feedback - WIP

* notes about Declarative

* fix headings

* Use field lists

* typo

* review feedback

* Imports

* typo

* Toshio's feedback
2017-02-24 20:31:58 +00:00
jhawkesworth
d0278d1d1e [WIP] documentation: Remove assemble from list of windows modules, plus tweaks (#21859)
* Remove assemble from list of windows modules, but advise you can delegate appropriate modules to localhost.  Try to fix list of usable on windows modules to appear as a list instead of on one line.

* Update intro_windows.rst

Minor edit
2017-02-24 13:30:12 +00:00
Daniel
d18bb96e88 Make pull-request sentence less ambiguous (#21802) 2017-02-22 17:52:41 -08:00
John R Barker
48c6dd2689 Point to cloud/amazon/GUIDELINES.md in main repo (#21780) 2017-02-22 15:31:06 +00:00
Matt Davis
67f74bbc81 CHANGELOG/roadmap updates for Windows 2017-02-17 00:10:17 -08:00
Robin Schneider
3700bcb6dd Use HTTPS instead of legacy HTTP for ansible.com (#16870)
Mechanical edit done by this "one-liner":

```Shell
git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#http://(www\.|galaxy\.|)ansible\.com#https://\1ansible.com#g;'
```

Related to: https://github.com/ansible/ansible/issues/16869
2017-02-15 16:09:33 -08:00
Michael Scherer
6fae1d2bbf Make password lookup treat /dev/null as a special case
I have from time to time a need of random password without
wanting to write them down (one example is mailman list creation,
that requires a password to be given to be sent to the list owner).

But using /dev/null do not return null, but the empty string, which
doesn't generate a password at all and so do not achieve my use case.
2017-02-15 12:15:09 -08:00
Toshio Kuratomi
d7b7cbac1a Move to using a requirements.txt to install the python packages. (#21430)
Move to using a requirements.txt to install the python packages.

This makes it easy to keep the documentation and actual package
dependencies in sync.

Fixes #18453
2017-02-15 06:58:09 -08:00
John R Barker
53ac312382 validate-modules --arg-spec (#21331)
* validate-modules --arg-spec

* Update developing_modules_documenting.rst

* Never mock out ansible or ansible.module_utils

* No more false positives
2017-02-15 08:09:08 +00:00
Vlad Dm
32b92b53b0 service state typo 2017-02-14 10:47:37 -05:00
Pilou
f2c22109fb Don't mix deprecations messages with warnings messages (#21337)
* Remove unused attribute '_passthrough'

* Don't mix deprecations with warnings

* Return values: add 'deprecations' key used internally

* 'deprecations' and 'warnings' return values: add tests
2017-02-13 23:49:39 -05:00
Peter Sprygada
58fa0bc1ea 2.3 roadmap updates for networking 2017-02-13 20:50:15 -05:00
John R Barker
0edda106f1 Delete link to test-network-modules (#21347) 2017-02-13 18:25:15 +00:00
Dylan Silva
8bf69411d9 Updated wording around support for different modules 2017-02-13 09:40:22 -05:00
927589452
a6cb377420 removed empty shell block (#21309) 2017-02-12 11:52:05 -08:00
Jeffrey Cafferata
4d0b62ede7 Update playbooks_best_practices.rst (#21288)
Updated the GitHub examples directory URL.
2017-02-12 00:01:43 -08:00
John R Barker
cd6792a058 Docs partner checklist (bulk modules) (#20794)
* WIP Partners guide for adding multiple modules

* WIP

* WIP

* WIP

* WIP

* WIP

* HACK

* Revert hack

* Brian's feedback

* Remove squash notes

* Minor tidyups

* Unit & Integration tests (& minor tweaks)

* Details about Unit tests
* As we are about to feature freeze on Ansible 2.3 remove the notes about Ansible 2.4 and py2.4.
* Module names should be in the singular

* Scot & Dylan's feedback

* 5 PRs at once. Remove FIXMEs

* Formatting

* How to use Git & GitHub

* directories are in category & topic

* Expectations of Module authors

* Better wording for module author's responsibilities
2017-02-10 14:02:24 -08:00
John R Barker
959637ff59 How to document your module (#21021)
* How to document your module

* Remove blank lines

* note:: Versions should be strings

* requirements on the host that executes the module.

* option names & option values

* Feedback

* formatting

* Scott's final feedback
2017-02-10 12:15:55 +00:00
Craig Francis
2ccedc2ed9 Correct links to modules source code (#20650)
As per issue #20647, the modules are now in the main Ansible repository.
2017-02-10 00:37:25 -08:00
Pavlo Shchelokovskyy
6e875e81aa Fix docs re inventory_ignore_extensions config (#21132)
The list of ignored by default extensions is outdated in doc for dynamic
inventories, and this option is completely missing from configuration
file overview.
2017-02-10 00:32:22 -08:00
927589452
19df0e0bf5 removed a typo (#21153)
* removed a type

doubled half sentence at the end removed

* Update intro_configuration.rst

Minor wording tweak.
2017-02-10 00:25:50 -08:00
Damien
b71a62283c New Module : aos_ip_pool as part of network/aos (#21044)
* Initial version of aos_ip_pool module

* Add examples for IP Pool

* Break down ip_pool into smaller function

* Refactor do_load_resource

* Add get_display_name_from_file

* Add ‘src’ as an option to load ip pool from JSON file

* Rename directory network/apstra to network/aos

* Remove exception handling temporary

* Remove all ‘Exception as XX’ to be python 2.4 compatible

* Replace ‘== False’ with ‘is False’ for PEP8 Test

* Update documentation to be Yaml compatible

* Lisg all method imported from module_utils.aos

* Refactor to align with collection.find() changes

* Update examples by @gundalow’s  recommendations

* Update Documentation per @gundalow’s recommendations

* Change the license per @gundalow recommendation

* Add exception handling for get_aos_session

* Change Auth format and add check_aos_version() to check minimum version

* Add a check for minimum version

* Refactor ‘src’ into ‘content’ to allow more options
Remove get_display_name_from_file in aos.py
Add content_to_dict in aos.py

* Fix variable name in do_load_resource

* Add mention of aos.py in module_utilities doc

* Add try/except for import yaml

* Add try/Except around main block of code and function

* Refactor to auto detect content_format, update doc accordingly

* Change create_new_ip_pool inputs

* Remove unused import

* Remove in_use as it’s never used

* Fix doc format

* Add version number in requirement doc
2017-02-09 22:22:56 +00:00
Dylan Silva
719b1fecfc [WIP] Added in bullet of Python 2.4+2.5 support discontinuation (#19264)
* Added in bullet of Python 2.4+ support discontinuation

* Update ROADMAP_2_4.rst

* Update ROADMAP_2_4.rst
2017-02-09 15:57:00 +00:00
Jordan Borean
719e1840da Added info on ntlm and credssp, updated configure script for credssp (#21175) 2017-02-08 17:00:58 -08:00
Brian Coca
5f29117e59 become options dont qualify as new anymore 2017-02-08 11:51:15 -05:00
Toshio Kuratomi
a3eab4fc48 Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3 (#21019)
* Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3

* Add roadmap-2.3 updates and an item for roadmap-2.4
2017-02-07 15:27:14 -08:00
bverschueren
3b64bff7a5 fix missing ident in provider dict assignment (#21089)
Thanks @bverschueren!
2017-02-07 10:54:49 -08:00
John R Barker
9ddc94d0e9 Update ROADMAP_2_3.rst 2017-02-07 18:47:36 +00:00
Matt Davis
764e1cc630 update azure roadmap items 2017-02-07 10:09:12 -08:00
John R Barker
54a2be9e2e formatting 2017-02-07 16:35:32 +00:00
Adrian Likins
a5d3b186ba update ansible-ssh in roadmap 2017-02-07 11:27:45 -05:00
John R Barker
965fe80f1a formatting 2017-02-07 16:27:01 +00:00
Jason McKerr
6a6f13a5bd Update ROADMAP_2_3.rst 2017-02-07 11:20:14 -05:00
Jason McKerr
64a3c8f9de Update ROADMAP_2_3.rst 2017-02-07 11:19:26 -05:00
Jason McKerr
31fbc6e203 Update ROADMAP_2_3.rst 2017-02-07 11:18:27 -05:00
Ryan Brown
0de96d68f6 Update roadmap for cloud work 2017-02-07 10:44:29 -05:00
John R Barker
b773b99136 developing_module status 2017-02-07 15:12:19 +00:00
Jiri Tyr
5d9dd5934a Making the decoration more clear (#20931) 2017-02-07 11:07:41 +00:00
Matt Clay
22db51f15c Update Testing and CI section of 2.3 roadmap. 2017-02-06 16:28:56 -08:00
Brian Coca
a2c38c47aa added docs for vault and made trigger shorter: !vault (#20985)
* added docs for vault and made trigger shorter: !vault

* added single var valuting

* Update playbooks_vault.rst

Edit pass for spelling and grammar. Ship it!

* Update playbooks_vault.rst

Typo fixes.
2017-02-03 15:28:50 -05:00
Adrian Likins
9703b0ff39 Add 'Improve testing of setup.py/facts.py' to 2.4 roadmap 2017-02-03 15:20:35 -05:00
John R Barker
b038aad173 make webdocs speedup is done 2017-02-03 19:13:04 +00:00
Toshio Kuratomi
1df7d95cec Module utils default path (#20913)
* Make the module_utils path configurable
* Add a config value to define the path site module_utils files
* Handle module_utils that do not have source as an error
* Make an integration test for module_utils envvar working
* Add documentation for the ANSIBLE_MODULE_UTILS config option/envvar
* Add it to the sample ansible.cfg
* Add it to intro_configuration.
* Also modify intro_configuration to place envvars on equal footing with
  the config options (will need to document the envvar names in the
  future)
* Also add the ANSIBLE_LIBRARY use case from
  https://github.com/ansible/ansible/issues/15432 so we can close out
  that bug.
2017-02-02 17:48:53 -08:00
rektide
1df14ed121 Update loop docs to also describe register:'s value when inside loop. (#20991) 2017-02-02 15:02:28 -08:00
John R Barker
8d5f4dda06 Roadmap is draft (#20970)
The keyword is "draft",  not "final".
2017-02-02 12:00:39 +01:00
Brian Coca
114ef96572 added example keyring looukp 2017-01-31 17:50:09 -05:00
Scott Butler
a002dca42d Edited for grammar, punctuation and spelling 2017-01-31 12:44:23 -08:00
Sebastian
a8c038383e Update intro_installation.rst (#20854)
Added command to install the repository key to prevent errors
2017-01-31 11:58:23 -08:00
Albert Mikaelyan
b89f222028 Some better explanation to release cycle 2017-01-31 12:36:42 -05:00
John R Barker
9bc4a12ae5 No more split repos (#20804)
* All bugs go to into `ansible/ansible`
* Issue template is automatically added when raising a new issue, so no manual steps needed
2017-01-29 13:04:10 -08:00
Matt Clay
10d9318de7 PEP 8 indent cleanup. (#20800)
* PEP 8 E121 cleanup.

* PEP 8 E126 cleanup.

* PEP 8 E122 cleanup.
2017-01-29 07:28:53 +00:00
Matt Clay
d913f69ba1 PEP 8 W291 whitespace cleanup. 2017-01-27 17:08:02 -08:00
scottb
13fc909058 Refurbish developing modules content - stage 1 (#20673)
* Revamping module development docs - work in progress

* Refurb of developing modules content continues.

* Developing modules refurb work continues

* Continued refurb of developing modules content. Work-in-progress.

* Ibid

* Dev guide content refurb continues - WIP

* Ibid.

* Removed reference to old extras module repo

* Tweaks

* Removed some non-intro material; added link to github module PRs.

* Incorporated review feedback from @gundalow and @tkuratomi; fixed some links; renamed '*contributing' to '*checklist'
2017-01-27 14:03:26 -08:00
pietro
8c3b915721 Fix versionadded on math filters section (#20674)
Extra character was breaking the rendering of the file.
2017-01-26 13:41:30 -05:00
Brian Coca
af59781b56 removed core/extras ref from module pages
fixes #20647
2017-01-25 11:45:23 -05:00
Brian Coca
e5f7a22215 clarified tag usage 2017-01-25 10:52:07 -05:00
Sumit Kumar
9283772e54 Add doc_fragment and module util for NetApp platforms (#19607)
* Add doc_fragment and module util for NetApp platforms

* Make requested changes

* Fix links and change formatting.

* Fix description sections.
2017-01-25 09:51:57 +00:00
Matt Davis
06353c055a winrm managed kinit (#20416) 2017-01-24 15:04:11 -08:00
Brian Coca
9db1cfebbc docs fixes
fixed version number
updated C year
2017-01-24 15:11:11 -05:00
Jonathan Sabo
6a6fb28af5 Updating credstash link to the new link (#20598)
We changed the name of the github repo awhile back and I noticed it was out of date in the docs.
2017-01-24 12:30:22 -05:00
Adrian Likins
d7615f68c4 Docs cleanup (#20517)
* build-site.py is no longer used, remove

Replacement is using the standard sphinx-build script.
Makefiles already use that, but standalone use of
build-site.py is no longer needed.

* build.sh no longer used in docs build
2017-01-20 13:12:19 -05:00
Brian Coca
216e2c8813 leaving os immediate 2017-01-19 23:11:53 -05:00
Brian Coca
0803c638bb set cpus only if not set already 2017-01-19 23:09:55 -05:00
Brian Coca
c95bd7d9b0 fixed escape again 2017-01-19 23:08:01 -05:00
Toshio Kuratomi
e7505220d4 Need to define the OS variable at this level too 2017-01-19 19:53:29 -08:00
Brian Coca
2a5d949c52 corrected path to edit docs on devel to new loc
fixes #20474
2017-01-19 14:01:18 -05:00
Will Thames
75a7ebe900 Deprecate ec2_vpc module (#20344)
* Deprecate ec2_vpc module

The deprecation of ec2_vpc module has been discussed for
2 years and is causing duplication of effort as changes
are implemented for ec2_vpc rather than for the newer
alternatives

* Improve module deprecation documentation

Update the developing modules documentation with the latest
instructions on how to deprecate a module.
2017-01-19 11:25:28 +00:00
Brian Coca
339312a6b4 added missing file to cleanup 2017-01-18 14:34:01 -05:00
Brian Coca
e2a871b49e corrected which app adds plugins 2017-01-18 14:14:28 -05:00
Brian Coca
712be24a74 Doc fixes (#20353)
* cleanup to reflect current builds

* consolidate templating docs and minor rewording

* new templating intro page

* fixed warnings as per feedback

* Update playbooks_filters.rst

Edited for clarity.

* Update playbooks_templating.rst

Light edits
2017-01-17 18:55:03 -08:00
Sascha Vogt
abe46dd75f Fix double colon which fixes block rendering
the 'EXPORT ANSIBLE_NOCOWS=1' rendering is broken due to a double colon in the paragraph above
2017-01-17 10:25:15 -05:00
Klaus Ethgen
ae57b95313 Documentation fix (#20198) 2017-01-17 01:25:53 -08:00
Brian Coca
c129fd7c81 added clarification on directives/blocks 2017-01-16 11:01:55 -05:00
Brian Coca
497347d600 fixed phrasing on 0 being non error 2017-01-13 20:55:45 -05:00
Adrian Likins
960be799fd Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
Adrian Likins
3645893a5b update path to _themes 2017-01-13 18:14:33 -05:00
Scott Butler
1c8b85a6f1 Added support statement for older releases. 2017-01-13 11:59:16 -08:00
Adrian Likins
a560a2d512 Use portable CPUS detect for docsite make default.
Some folks run 'make webdocs' from docs/docsite, so
use the portable CPUS detections as the default here as
well.
2017-01-13 14:41:14 -05:00
Adrian Likins
0381bc170c Docsite sphinx rm buildsite (and speed up docs build) (#20237)
Replace docs build-site.py with default-ish sphinx build

This seems to speed up docsite build _alot_. 

The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes.

The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j'
2017-01-13 14:32:27 -05:00
Bernie Schelberg
2b4afd23eb Update docker example on Inventory page (#20209)
The docker module has been deprecated, so the example should be
updated to use the newer docker_container module.
2017-01-12 18:57:27 -08:00
Brian Coca
4b3977d5af added note about custom modules/plugins in roles 2017-01-12 20:15:09 -05:00
Brian Coca
2538383cf4 updated docs to make clear new option scope
this does not affect user tasks with `setup`
2017-01-12 10:53:24 -05:00
Alvaro Aleman
1b2ad94496 Configurable fact path (#18147)
* Make fact_path configurable

* Add docs for fact_path

* Add tests for localfacts

* Default fact gathering settings in PlayContext
2017-01-12 10:49:04 -05:00
Toshio Kuratomi
eeebd51f21 Rename the type filter to type_debug
Because we add the names of all filters to the callable whitelist used
by safe_eval, adding a filter named type makes it so code calling "type()"
gets eval'd.  We can't think of a way to exploit this but it's
sufficiently sketchy that we're renaming it in case someone smarter than
us can think of a problem.
2017-01-11 14:48:21 -08:00
Dag Wieers
de21038feb Enable -Verbose and log to EventLog (#19909)
Instead of asking the user to type something prior to running the script, why not allow -Verbose on the command line directly.
Also log important events to EventLog, so that it can be traced e.g. when running via RunOnce mechanism.

The documentation is updated as well.
2017-01-10 23:52:41 -08:00
scottb
745219d200 Update playbooks_lookups.rst
Edited.
2017-01-10 16:19:22 -05:00
Brian Coca
f9f99ddfbc updated docs to suggest quote filter for shells
Also changed comments into -name in examples where appropriate.
2017-01-10 16:19:22 -05:00
Brian Coca
3c4afd0470 Doc module meta (#20093)
* updated module docs to reflect unification/meta

* new doc page

* also remove module refs to old core/extra

* Update modules_support.rst

Light edit.
2017-01-10 12:58:22 -08:00
Jasper Lievisse Adriaanse
073c4df790 Update references to Passlib as homepage/docsite moved (#20082) 2017-01-10 13:17:32 +00:00
Brian Coca
54800ea47c better sections for module return docs 2017-01-09 20:18:30 -05:00
Brian Coca
0aad46c85b corrected common headers 2017-01-09 15:54:45 -05:00
Ryan Brown
a2b4ad9da0 (docs) Remove/update mentions of git submodule in docs and error me… (#19941)
* (docs) Remove/update mentions of `git submodule` in docs and error messages.

* Remove parenthetical per @dharmabumstead
2017-01-09 12:11:39 -05:00
Toshio Kuratomi
08d6990e67 Fix code-blocks to use correct syntax highlighting 2017-01-08 09:18:45 -08:00
Toshio Kuratomi
adb7426c0c Some more code-block fixes 2017-01-07 11:47:35 -08:00
John R Barker
7df31aaca1 Fix all RST errors for docs/docsite/rst (#20005)
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
2017-01-07 11:38:52 -08:00
Brian Coca
3b2a4c1955 fixed porting guide headers 2017-01-06 15:50:32 -05:00
Toshio Kuratomi
1be3ac36df Fix block highlighting
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
2017-01-06 12:37:51 -08:00
John R Barker
ebc8b927ce Fix RST Errors 2017-01-06 19:45:47 +00:00
Rodolfo Carvalho
8f3c435b27 Fix path to test plugin examples 2017-01-06 11:41:15 -05:00
Brian Coca
d108a6f0fc fixed webdoc generation 2017-01-06 11:23:29 -05:00
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00