Commit Graph

1428 Commits (f9b56a5b5627c129ff3c28008b1fd06de4048f47)

Author SHA1 Message Date
Matt Clay f9b56a5b56 Add sanity test to check for unwanted files. 6 years ago
Pilou b3ab83bc70 [doc] fix example: always trigger the handler (#56384)
by default, debug task result isn't changed - add 'changed_when: yes' to trigger handler
6 years ago
Sandra McCann 88be323bcd Fix 2.8 changlog url and reverse order porting guides TOC (#56373)
* fixed url for 2.8 changelog, fixed spelling issues, reversed TOC order
6 years ago
Felix Fontein 6948e04276
Add myself to committer list. (#56363) 6 years ago
Isaac 85fa65e5f0 docs: Update scopes value example (#56362)
Existing example in GCE guide returns "invalid scope" error; value needs "https://" prefix
6 years ago
Sam Doran c1ebc8d9c2 Update default roles_path documentation (#56320) 6 years ago
Alicia Cozine 3c8d8b1509 should have gone into 52373 (#56306) 6 years ago
Reginald Davis dd0b0ae47b Lack of "--update" flag in older Ubuntu distros (#56283)
When installing Ansible on older Ubuntu distributions be aware of the lack of ``-u`` or ``--update`` flag.

+label: docsite_pr
6 years ago
Dag Wieers eac7f1fb58 dev_guide: Various small updates (#53273)
* Document the clarifications that I usually remark when doing reviews
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst

Co-Authored-By: dagwieers <dag@wieers.com>
6 years ago
stroebitzer dae5564e2b Fix var naming (#55796)
* Fix var naming in GCE guide
6 years ago
Brian Coca 8ff27c4e0c more info on how vaults work (#56183)
also add warning about what it covers.
6 years ago
Jim Rollenhagen 86e98c5213 Note that by default the regex test is identical to match, but can do much more (#50205)
* Note that the regex test behaves like 'match', with default settings
6 years ago
Matthew Davis 7d5ada7161 add doc example of multiline failed_when with OR (#56007)
* add doc example of multiline failed_when with OR

* add variety to multiple OR failed_when doc example
6 years ago
Toshio Kuratomi edafa71f42 Developer documentation update involving module invocation (#55747)
* Update docs for the 2.7 change to AnsiballZ which invokes modules with one
  less Python interpreter

* Add a section on how module results are returned and on trust between modules, action plugins, and the executor.

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-Authored-By: abadger <a.badger@gmail.com>
6 years ago
Mark Zhitomirski b14f477bee docsite: correct path, list requirements for testing module docs, etc. (#52008)
* dev_guide: correct path, list requirements, etc.; module HTML docs are in '_build/html/module' subdir
6 years ago
Brian Coca 5d4c73e197 unite poll defaults (#55470)
* unite poll defaults and update docs
6 years ago
Klaas Demter 76dba7aa4f Add faq note about ssh ServerAliveInterval (#55568) 6 years ago
Alicia Cozine 8542459b95
Docs: edits & expands module_utils & search path info in dev guide (#55931)
* Update docs/docsite/rst/dev_guide/developing_module_utilities.rst
6 years ago
Alicia Cozine 5439eb8bd8
Clarifies how Ansible processes multiple `failed_when` conditions (#55941)
Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
6 years ago
Sandra McCann 47a440774f Speed up the Sphinx documentation build (#55593)
* speeds up the docs build by changing the navigation collapse setting
6 years ago
stroebitzer 943f7334c5 Fix var naming (#55795)
Make vars match tasks in Google Compute guide.
6 years ago
Alicia Cozine 9d5b5d7ddd
correct description of modules vs plugins (#55784) 6 years ago
Alicia Cozine bb5059f2c7
Add security group info and example to AWS guide (#55783)
* expand documentation on how to use lookup plugin aws_service_ip_ranges with ec2_group module

* fix rst syntax error
6 years ago
tacatac dbc64ae64c Clarify poll value behaviour in playbook async doc (#54929)
Clarify the documentation for `async` and `poll`; describe the behavior when `poll` = 0 and when it does not.

* Update docs/docsite/rst/user_guide/playbooks_async.rst

* Update the default poll value in async doc

Co-Authored-By: tacatac <taca@kadisius.eu>
6 years ago
hiyokotaisa 7b86208fcd Add Microsoft Document URL for WinRM Memory Hotfix (#55680)
* Add microsoft document for memory hotfix

* Update docs/docsite/rst/user_guide/windows_setup.rst

Co-Authored-By: hiyokotaisa <thel.vadam2485@gmail.com>
6 years ago
Lars Kellogg-Stedman a5cb47d697 Improve consistency of loop documentation (#55674)
There were a series of sections with subheadings in the loop
documentation, but the most recent additions did not follow the same
pattern.
6 years ago
tacatac 79198cad7a Clarify the Vault guide and add Vault ID examples (#55111)
updates docs/docsite/rst/user_guide/vault.rst
* Add reference to single variable vault encryption
* rST ref to jump to the section
* Clarify the two targets of vault encryption, with notes about advantages and drawbacks of each
* Add the default form for --vault-id
* Add Vault ID examples for normal operations

Co-Authored-By: tacatac <taca@kadisius.eu>
6 years ago
Matt Martz db6cc60352
Migrate command line parsing to argparse (#50610)
* 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
6 years ago
Xaroth a9f24e097f Add ansible_parent_role_names magic variable (#46687)
-Add: Test cases for ansible_parent_role_names and ansible_parent_role_paths
-Add: ansible_parent_role_names/paths variables for when a role is being included by another role.
6 years ago
Sandra McCann cca365061c
add how to create HttpApi plugins for network modules (#54340)
* initial port over from gdoc

* crosslink httpapi pages

* Add some examples?

* Add quick example of using Connection

* Fix indentation of python code blocks

* moved to a full developer guide for networks

* Try to clarify some examples

* Fix typos

How did I even do that?
6 years ago
spellis 6ea3eca8ff Update windows_setup.rst (#55535)
Wrong protocol and port in command.

+label: docsite_pr
6 years ago
Gregor Dschung 158452661a Correct link to Thomas' GitHub account (#55587)
Thomas renamed his account from tstringer to trstringer
6 years ago
Alex Stephen e298de0986 GCP deprecations (#53355)
* gcdns_record deprecation

* gcdns_zone deprecation

* gcp_forwarding_rule deprecation

* gcp_url_map deprecation

* gcspanner deprecation

* gcp_healthcheck deprecation

* porting guide

* test failures

* forgot to rename

* deprecating

* porting guide changes

* unit test fixes

* changing ignores
6 years ago
Jordan Borean 8542f16fa9
SCP filename validation docs (#55399)
* SCP filename validation docs

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* edits to scp FAQ entry

* zeut alors I have missed one

* incorporate jborean feedback

* adds link to bug report
6 years ago
Alicia Cozine d7f6493084 adds better links to tips and pitfalls page (#55458) 6 years ago
Matt Martz 9f83139dcb
Don't register tests as filters (#55332)
* Don't register tests as filters. Fixes #55319

* Remove tests for deprecated functionality

* Remove no-tests-as-filters sanity tests

* Remove docs too

* Revert "Remove docs too"

This reverts commit 7daf457a74.

* Make no-tests-as-filters doc an orphan
6 years ago
Michelle Perz 960df24272 include windows server 2019 in supported hosts (#55367)
<!--- Your description here -->

+label: docsite_pr
6 years ago
Kevin Breit 521e62aa38 Update set_module_args in unit test docs (#55244)
* Update docs/docsite/rst/dev_guide/testing_units_modules.rst
`set_unit_args()` should be imported and used in the unit test documentation. 

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
6 years ago
Alex Stephen 91a664a93e Gce migration docs (#51838)
* migration docs for gce, with example playbook

* Update docs/docsite/rst/scenario_guides/guide_gce.rst

Co-Authored-By: rambleraptor <alexstephen@google.com>
6 years ago
Kevin Breit a005dcfbbd Add example for full path on unit tests (#55243)
Docs: adds an example when a full path is needed for unit tests, with module_utils, etc.
6 years ago
Jiri Tyr 7efb952825 Adding missing comma (#55254) 6 years ago
Abhijeet Kasurde 3003954415 Update unit testing docs (#55272)
* Updated links
* Updated indentation
* Fixed typos

Fixes: #55242

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Toshio Kuratomi b4f41fd9e2
Document replacements (#55226)
* Document replacements

Document suggested replacement moduels for kubernetes, oc, and ec2_ami_find
modules in the porting guide

* remember the _module suffix
6 years ago
Toshio Kuratomi a1c8fc37e8 Remove modules which have ended their deprecation cycle
* Remove code but leave the metadata so that they can be listed as
  removed in documentation.
* Remove removed modules from validate-modules ignore
* Remove unittests for the removed nodules
* Remove links to removed modules and add list of removed moduels to the
  2.9 porting guide
6 years ago
Toshio Kuratomi e5a31e81b6 Add a script to generate a new porting guide
* porting-guide.py is allowed to be Python-3.6+ as it will only be run
  by release engineers
6 years ago
Keith Maxwell 04220478da Fewer examples use connection: local in docs (#55133)
* Fewer connection: local lines in module examples and scenario guides

The line 'connection: local' is not required. See
./docs/docsite/rst/inventory/implicit_localhost.rst
6 years ago
Sandra McCann 7a1e2ef746 Clarify platform EOS and NXOS table settings (#55096) 6 years ago
Sam Doran f7ed194bc9 Clarify how to use variables with handlers (#54928)
* Add clarification on handler names

Add example on how to use variables in handlers

* Update docs/docsite/rst/user_guide/playbooks_intro.rst
6 years ago
Keith Maxwell be09f420de Add a title to the installation guide (#55138)
Also remove placeholder text.
6 years ago
John R Barker 424747e50b porting_guide_2.8 - fix broken links (#55092)
* porting_guide_2.8 - fix broken links in deprecated modules section
6 years ago