Commit graph

324 commits

Author SHA1 Message Date
Jeff Pettorino
cea8a222a3 Update playbooks_environment.rst (#62800) 2019-09-26 10:42:23 -04:00
Michael Prokop
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
Sandra McCann
7e01de96d7
add more anchors to collections docs (#62827) 2019-09-25 08:32:44 -04:00
Sandra McCann
7badeb6df0 [docs] split collections into user and dev guide sections (#62363)
* split collections into user and dev guide sections

* sentence case
2019-09-19 15:09:19 -05:00
Horst Gutmann
7047b66d34 Add examples for various inventory setups to the documentation (#62323)
* Add examples for various inventory setups to the documentation. This closes #12480.

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Use code-block and rename groups in inventory setup examples

* Fix group name in inventory setup example

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-19 09:32:04 -04:00
Jordan Borean
d16ee65ecd Add link to become plugins in become docs (#62462) 2019-09-18 15:53:16 -04:00
Sloane Hertel
09f1c286e0 Add some details to any_errors_fatal documentation (#62029) 2019-09-12 16:15:02 -04:00
createchange
e3ea89801b Update playbooks_prompts.rst (#62003)
Fixed typo: "wierd" > "weird"
2019-09-10 06:57:01 +05:30
Christopher Engelhard
375eb9723a Add caution about handlers & import to Pitfalls (#61060)
* Add caution about handlers & import to Pitfalls on the playbooks_reuse page.
The fact that handlers lose their name: when using import_tasks:, while logical, is not intuitive and should be noted.
Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-05 14:18:09 -05:00
Wojciech Sciesinski
7e7b7bb0b6 Correct indentation of the code in the example (#61622) 2019-09-03 10:09:47 -05:00
James Cammarata
51b33b79c0
T woerner max concurrent (#60702)
* play, block, task: New attribute forks

With this it is possible to limit the number of concurrent task runs.
forks can now be used in play, block and task. If forks is set in different
levels in the chain, then the smallest value will be used for the task.

The attribute has been added to the Base class as a list to easily provide
all the values that have been set in the different levels of the chain.

A warning has been added because of the conflict with run_once. forks will
be ignored in this case.

The forks limitation in StrategyBase._queue_task is not used for the free
strategy.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Handle forks in free strategy

The forks attribute for the free strategy is handled in run in the free
StrategyModule. This is dony by counting the amount of tasks where the uuid
is the same as the current task, that should be queued next. If this amount
is bigger or equal to the forks attribute from the chain (task, block,
play), then it will be skipped to the next host. Like it is also done with
blocked_hosts.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Test cases for forks with linear and free strategy

With ansible_python_interpreter defined in inventory file using
ansible_playbook_python.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Changing forks keyword to throttle and adding some more docs
2019-08-28 18:47:39 -05:00
Alicia Cozine
a6f585eb62 remove the word "support" from Windows pages, add Windows Server 2019 (#61404)
* remove support from Windows pages, add Windows Server 2019

* jborean feedback

* Removed CBT info

Removed the CBT note about what transports Ansible actually supports. We've worked with both NTLM and Kerberos for a while now.
2019-08-28 08:05:12 +10:00
Brett Campbell
5b16e012a4 Doc fixes for readability (formatting/punctuation) (#61086)
Variable-width font was extremely difficult to read in a couple places.
Fixed missing close-quote, colon, spelling, etc.
2019-08-22 15:29:53 -04:00
G. Weixelbraun
ab027611d5 fix typo in become.rst (#61011)
change remote_src: yex to remote_src: yes in documentation
2019-08-21 10:58:45 -05:00
Mark Chesney
11be31db71 Fix naming discrepancy in zip filter example (#60918)
Fix naming discrepancy in zip filter example
2019-08-20 09:53:15 -05:00
Jiri Tyr
da18e3b76c Updating intro_inventory.rst (#60676) 2019-08-16 09:23:58 -05:00
Jiri Tyr
c4d841f848 Updating intro_inventory.rst (#60651) 2019-08-15 14:42:37 -05:00
Aaron
d808b84621 Update intro_getting_started.rst to take into account inventory precedence when proposing '-u' to change the remote user. (#59858)
* Update intro_getting_started.rst
* adds more info about overriding SSH user to intro
2019-08-14 14:29:41 -05:00
Jered Sutton
6915ea96f1 Clarify behavior of --skip-tags, --list-tasks, and --list-tags. (#60492) 2019-08-13 09:47:28 -05:00
Felix Fontein
2d98734ad5 Amazon modules: rename _facts with ansible_facts result to _info (#60178)
* aws_s3_bucket_facts -> aws_s3_bucket_info

* cloudformation_facts -> cloudformation_info

* cloudfront_facts -> cloudfront_info

* ecs_service_facts -> ecs_service_info

* efs_facts -> efs_info

* Add changelog and porting guide entry.

* lambda_facts -> lambda_info

* Improve examples.

* Add subsection on renamed modules.

* Add sentence on registering variables.

* Fix ReST.

* Instead of renaming lambda_facts, deprecate it and replace with new module.

* Rename internal variable.

* Re-add sanity ignores for lambda_facts.
2019-08-13 08:01:37 -04:00
kfattig
dd7b9627ad Runas docs (#60082)
* Mention seclogon requirement in runas docs

* Mention seclogon requirement in Win become docs
2019-08-06 10:44:17 +10:00
Peter Mounce
24d8e82655 Windows Setup doc; offer 10x perf improvement (#58259)
* Windows Setup; document 10x perf improvement
2019-07-30 15:53:17 -04:00
d-little
11d61cc01e Swap ordering to ensure Dynamic always first (#58998) 2019-07-12 15:52:06 -05:00
Alicia Cozine
0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 2019-07-12 16:19:08 -04:00
Samy Coenen
0befccbeb9 Update intro_inventory.rst (#58732) 2019-07-09 15:56:21 -05:00
Brian Coca
c2469648e4 Docs on general precedence (#50201)
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-07-09 12:14:40 -05:00
Wojciech Sciesinski
f9a31e3e17 Provide the list of packages in a modern way (#58668) 2019-07-09 12:04:12 -05:00
Sloane Hertel
ec1287ca7e
Fix notifying handlers by using an exact match (#55624)
* Fix notifying handlers by using an exact match rather than a string subset if listen is text rather than a list

* Enforce better type checking for listeners

* Share code for validating handler listeners

* Add test for handlers without names

* Add test for templating in handlers

* Add test for include_role

* Add a couple notes about 'listen' for handlers

* changelog

* Add a test for handlers without names

* Test templating in handlers

* changelog

* Add some tests for include_role

* Add a couple notes about 'listen' for handlers

* make more sense

* move local function into a class method
2019-06-27 17:29:20 -04:00
Klaus Frank
ee52b60d7d Add note about delegate_facts to run_once (#58241)
* Add note about delegate_facts to run_once
2019-06-27 17:19:22 -04:00
Alicia Cozine
d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
2019-06-26 17:07:27 -04:00
Sayed Anisul Hoque
57596edcca Updated the playbooks_tags guide (#58011)
* Updated the playbooks_tags guide
2019-06-21 12:06:23 -04:00
Lucian Maly
446027341a Update playbooks_strategies.rst (#57784)
* Update playbooks_strategies.rst

##### SUMMARY
This page is very confusing and may suggest, that there is still a `serial` strategy (like it used to), but now it is just a directive of `linear` strategy. Multiple people reported this to me and it needs change.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

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

Co-Authored-By: Sam Doran <sdoran@redhat.com>

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

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Updates strategies page more broadly

* incorporate samdoran feedback

* fixes broken link

* new page title, focus on user intent

* more sdoran feedback

* adds details on setting the number of forks
2019-06-18 16:52:01 -04:00
Sayed Anisul Hoque
b768a0780c Update playbooks_vault.rst (#58005)
Corrected the internal reference link to point to the FAQ entry.

+label: docsite_pr
2019-06-18 11:23:30 -05:00
Felix Fontein
505c99265c docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508)
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
2019-06-18 10:56:33 -05:00
Sayed Anisul Hoque
2bdc4e5b4a Documentation error in the Test if a list contains a value section (#57923)
* Update docs/docsite/rst/user_guide/playbooks_tests.rst - 'contains' test works with 'select/reject' and 'selectattr/rejectattr' but not 'map'
2019-06-18 09:15:09 -05:00
asouini
a096fa5c12 filter bare variable with |bool (deprecation warn) (#57691)
* filter bare variable with |bool (deprecation warn)

https://github.com/ansible/ansible/pull/57691#issuecomment-502134480
2019-06-17 10:53:30 -04:00
Sayed Anisul Hoque
78f87f2451 Updated "Speeding up Vault Operations" section (#57701)
* Updated "Speeding up Vault Operations" section


Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2019-06-14 10:17:40 -04:00
Sayed Anisul Hoque
b9c893ec6f Updated the section under "Aborting the play" in the Error Handling In Playbooks page (#57705)
* Updated the section under "Aborting the play"

Updated "Aborting the play" section in the Error Handling In Playbooks page. Removed the reference to marking all hosts as failed.

+label: docsite_pr

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-06-14 10:04:05 -04:00
Strahinja Kustudic
6131de29d4 Improve regex_replace filter docs (#57450)
* Add a few examples of how to correctly use `regex_replace` filter
because it behaves differently on different Python versions when using
regex qualifiers that can match an empty string (e.g. '*', '?', etc).
2019-06-13 09:12:12 -05:00
Sandra McCann
c06f890f55 add docs for vlan_parser filter (#57498) 2019-06-11 11:22:02 -05:00
Felix Fontein
13f73adef5
AWS: _facts -> _info (part 4) (#57651)
* Rename ec2_vpc_dhcp_option_facts -> ec2_vpc_dhcp_option_info.

* Rename ec2_vpc_endpoint_facts -> ec2_vpc_endpoint_info.

* Rename ec2_vpc_igw_facts -> ec2_vpc_igw_info.

* Rename ec2_vpc_nacl_facts -> ec2_vpc_nacl_info.

* Rename ec2_vpc_nat_gateway_facts -> ec2_vpc_nat_gateway_info.

* Rename ec2_vpc_net_facts -> ec2_vpc_net_info.

* Rename ec2_vpc_peering_facts -> ec2_vpc_peering_info.

* Rename ec2_vpc_route_table_facts -> ec2_vpc_route_table_info.

* Rename ec2_vpc_subnet_facts -> ec2_vpc_subnet_info.

* Rename ec2_vpc_vgw_facts -> ec2_vpc_vgw_info.

* Rename ec2_vpc_vpn_facts -> ec2_vpc_vpn_info.

* Update module defaults, add changelog and porting guide.

* Update BOTMETA.
2019-06-10 21:40:05 +02:00
Felix Fontein
804d5eaf8e
AWS: _facts -> _info (part 3) (#57635)
* Rename ec2_ami_facts -> ec2_ami_info.

* Rename ec2_asg_facts -> ec2_asg_info.

* Rename ec2_customer_gateway_facts -> ec2_customer_gateway_info.

* Rename ec2_eip_facts -> ec2_eip_info.

* Rename ec2_elb_facts -> ec2_elb_info.

* Rename ec2_eni_facts -> ec2_eni_info.

* Rename ec2_group_facts -> ec2_group_info.

* Rename ec2_instance_facts -> ec2_instance_info.

* Rename ec2_lc_facts -> ec2_lc_info.

* Rename ec2_placement_group_facts -> ec2_placement_group_info.

* Rename ec2_snapshot_facts -> ec2_snapshot_info.

* Rename ec2_vol_facts -> ec2_vol_info.

* Update module defaults, add changelog and porting guide.

* Forgot one occurence of ec2_instance_facts.

* Update BOTMETA.

* Break too long line.
2019-06-10 19:33:38 +02:00
Sandra McCann
152202ceb0 add info about hwaddr conversion formats (#57491) 2019-06-06 12:56:10 -05:00
Abhijeet Kasurde
ee8a607cca ipaddr: Handle network address in ipmath (#57149)
* Updated testcase, documentation

Fixes: #54457

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-06-04 14:01:18 +05:30
Ilya Reshetnikov
bf0e846a39 Update playbooks_filters.rst (#57200)
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
2019-06-03 11:15:11 -05:00
Thad Guidry
78b003858d Mention other ways to handle private key files (#57238)
Often when I am helping others learn Ansible, they are using nodes spun up on Amazon/Google/etc.  where private key files (pem) are needed.  Mentioning just a bit more on how to handle those private key files on the intro_getting_started page will help more folks get started faster.
I even reviewed the changes with my learning team and they all agreed this helped clarify immediately for them how to really get started with Ansible from a practical perspective.
2019-06-03 10:17:13 -05:00
Bill Nottingham
c493593b4b Adjust assorted terminology and wording around product offerings. (#57242)
* Adjust assorted terminology and wording around product offerings.

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
2019-05-31 14:24:44 -05:00
Remon van de Kamp
dea9644d21 Use correct variable for run_once regardless of batch example (#57077)
Changes example to `when: inventory_hostname == ansible_play_hosts_all[0]` to really run run_once regardless of serial.
2019-05-29 12:24:12 -05:00
Jonathan Bride
db6407d6bf Correct typo in playbooks_intro.rst (#56919)
Typo in code block line: ansible-lint veryify-apache.yml should be
ansible-lint verify-apache.yml
2019-05-24 09:53:00 -05:00
Anatoly Kamchatnov
9a563f8947 Windows FAQ: fix reference (#56909) 2019-05-24 09:39:49 -05:00