Commit Graph

421 Commits (e0f25a2b1f9e6c21f751ba0ed2dc2eee2152983e)

Author SHA1 Message Date
Wojciech Sciesinski aacc2d1a18 Update indentation used in the code examples, unify empty lines (#65874) 5 years ago
Steve Leonard af1c788ba7 Fix list formatting in Getting Started docs page (#65713) 5 years ago
Mossroy c3c1708dea Fix variable name in an example (#65760)
Makes the variable name consistent between the example code (`myname`) and the text below (mentioning a variable called `name`) in the docs.
5 years ago
Sandra McCann 9c30325704 fixed some link nits (#65772) 5 years ago
Alicia Cozine 860cacc54f Docs: User guide overhaul, part 2 (#65474) 5 years ago
Wojciech Sciesinski 95aef88a45 Update indentation used in the code examples, unify empty lines (#65346) 5 years ago
Evgeni Golov 3af1732bd8 fix rendering of GOOD/BAD code for regex_replace examples (#65654)
adds double colon (::) so the examples render as code
5 years ago
Jasper Lievisse Adriaanse 53cd0bdd29 docs: Prefer python3 on OpenBSD (#65447) 5 years ago
Sam Doran 21bbf49396 Mention Python builtin methods in filter docs (#65425) 5 years ago
林博仁(Buo-ren Lin) 8ebc57c186 Mention that Python keywords are invalid Ansible variable names (#65094)
* Mention that Python keywords are invalid Ansible variable names
Using a Python keyword as a variable name triggers the error `Invalid variable name in 'register' specified: 'return'`.
5 years ago
Niklas Liechti 39ebd244e3 Update playbooks_filters.rst (#64769) 5 years ago
Andrew Schultz 756ac826fe Improve ignore_unreachable documentation (#64938) 5 years ago
Kenyon Ralph a797802d27 playbooks_filters_ipaddr.rst: fix syntax, indentation (#65208) 5 years ago
Sam Doran 0471ed3731 Add docs clarifying behavior of retry files (#65153) 5 years ago
gaoruifeng f9f7a0c60e fix syntax issue (#65166)
- can disabled  
+ can be disabled
5 years ago
Alicia Cozine b0c8e7926f link from quickstart page to Network Getting Started (#65150) 5 years ago
Baptiste Mille-Mathias e65be0beee Put all files and Path filters under a specific section (#64913)
Many of the filters in the "other useful filters" list manipulate filenames and paths; add a heading and put them together.
5 years ago
Sandra McCann a01376a493 update configuring ansible-galaxy client (#64796)
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
5 years ago
Robert de Bock f17a55a181 Add advice how to prevent jinja2 warning (#60594)
* Add advice how to prevent jinja2 warning

##### SUMMARY
This addition helps users to demonstrate how to prevent `[WARNING]: when statements should not include jinja2 templating delimiters`.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Update playbooks_tests.rst

* Update playbooks_tests.rst

Refer to the advised FAQ about when to use `{{ }}`.
5 years ago
Vincent Bernat bf19060683 ipaddr: add an option to return peer of a point-to-point link (#59144)
* ipaddr: add an option to return peer of a point-to-point link

Signed-off-by: Vincent Bernat <vincent@bernat.ch>

* ipaddr: extend "peer" to also work with /30
5 years ago
James Cassell a7f90df0e9 Document match/search tests (#64775)
* clarify `search` vs `match` tests

* string test docs: fix rst formatting
5 years ago
Sorin Sbarnea 7ea1db89d3 Documents storage of task files (#62345) 5 years ago
Jordan Borean 901eaf2ecc Add warning about winrm on MacoS (#64472) 5 years ago
Jordan Borean 74b0760cb4 Add note about kerberos dependency versions (#64478) 5 years ago
Bibas f21f3219b2 [Fix] Typo in playbooks_environment.rst (#64496)
Change from `varaible` to `variable`
5 years ago
Caleb Collins-Parks f178c49c02 Add warning about skipped vars (#63599) 5 years ago
Hiroki Kobayashi e7cd5af1a6 Update intro_inventory.rst (#64345)
##### SUMMARY
A minor typo in `user_guide/intro_inventory.rst` is fixed.
Changed from "know" to "known"
5 years ago
Mark Chappell 9b0d487ce1 Add module_defaults group for ovirt (#64377)
* Add module_defaults group for ovirt

* Update docs to list ovirt module_defaults group
5 years ago
Kenyon Ralph 53f07bc283 intro_patterns.rst: fix typo (#64422)
Changed "your" to "you" in intro_patterns.rst
5 years ago
Christian Adams b1f02be9eb clarify vault warning and fix typo (#64419) 5 years ago
Pierre Prinetti 2444fae208 Add a named parameter to the filter to_uuid (#64057)
Let the caller choose a namespace for `to_uuid` and document the
behaviour of both the default case, and the new explicit case.

This PR does not change the existing behaviour of the `to_uuid` UUIDv5
filter.
5 years ago
Brian Coca 885ee62b53 clarified some points on environment keyword usage (#64065) 5 years ago
Marek Czernek 18f4f0549f Correct a typo (#64020) 5 years ago
AndrewCi c562e17659 Fixed example error in windows_winrm user guide (#63922)
##### SUMMARY
The example code to configure TLS 1.2 Support using Ansible had an indention error. The register variable 'enable_tls12' was not indented. This caused the subsequent task to fail since the variable was not registered. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
5 years ago
Pouyan Azari cfe2beae46 added a link to install instruction of OpenSSH (#63548) 5 years ago
Pouyan Azari f638f29e44 Replaced old DSC links that given 404 (#63556)
Replace DSC links that returned "not found" with updated, working links.
5 years ago
Sandra McCann ae265bc546 Move galaxy appendix info to a new Galaxy section (#63356)
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
5 years ago
Felix Fontein aa04e61c89 docker_* modules: add docker module defaults group (#63164)
* Add docker module defaults group.
* Add footnote about docker_stack not being included (instead of remarks column)
5 years ago
Michael C 19587b35da docs: add Centos and Ubuntu to examples for playbook conditionals (#63085)
* docs: add Centos and Ubuntu to examples for playbook conditionals

Co-Authored-By: Sandra McCann <samccann@redhat.com>
5 years ago
Alicia Cozine 941a9b68fc Docs: User guide overhaul, part 1 (#63056) 5 years ago
Abhijeet Kasurde deda9d4cc5 VMware: Add module defaults for VMware modules (#63197)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Adrian Likins 239d639fee Add support for automation-hub authentication to ansible-galaxy (#63031)
Adds support for token authentication in Automation Hub. Fixes: ansible/galaxy-dev#96
5 years ago
Sam Doran 0311897722 Add docs on hiding sensitive data in loops (#63096) 5 years ago
Matt Martz 594a0fa9ae Add new truthy and falsy jinja2 tests (#62602) 5 years ago
Chris Houseknecht 911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS (#62870) 5 years ago
Felix Fontein 8bfc39e231 ACME module defaults (#62719)
* Add module defaults group 'acme'.

* Start YAML document.
5 years ago
Andreas Olsson c8315bfd60 Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
5 years ago
Jeff Pettorino cea8a222a3 Update playbooks_environment.rst (#62800) 5 years ago
Michael Prokop b33ae14949 doc: fix typos (#62852) 5 years ago
Sandra McCann 7e01de96d7
add more anchors to collections docs (#62827) 5 years ago
Sandra McCann 7badeb6df0 [docs] split collections into user and dev guide sections (#62363)
* split collections into user and dev guide sections

* sentence case
5 years ago
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>
5 years ago
Jordan Borean d16ee65ecd Add link to become plugins in become docs (#62462) 5 years ago
Sloane Hertel 09f1c286e0 Add some details to any_errors_fatal documentation (#62029) 5 years ago
createchange e3ea89801b Update playbooks_prompts.rst (#62003)
Fixed typo: "wierd" > "weird"
5 years ago
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>
5 years ago
Wojciech Sciesinski 7e7b7bb0b6 Correct indentation of the code in the example (#61622) 5 years ago
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
5 years ago
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.
5 years ago
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.
5 years ago
G. Weixelbraun ab027611d5 fix typo in become.rst (#61011)
change remote_src: yex to remote_src: yes in documentation
5 years ago
Mark Chesney 11be31db71 Fix naming discrepancy in zip filter example (#60918)
Fix naming discrepancy in zip filter example
5 years ago
Jiri Tyr da18e3b76c Updating intro_inventory.rst (#60676) 5 years ago
Jiri Tyr c4d841f848 Updating intro_inventory.rst (#60651) 5 years ago
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
5 years ago
Jered Sutton 6915ea96f1 Clarify behavior of --skip-tags, --list-tasks, and --list-tags. (#60492) 5 years ago
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.
5 years ago
kfattig dd7b9627ad Runas docs (#60082)
* Mention seclogon requirement in runas docs

* Mention seclogon requirement in Win become docs
5 years ago
Peter Mounce 24d8e82655 Windows Setup doc; offer 10x perf improvement (#58259)
* Windows Setup; document 10x perf improvement
5 years ago
d-little 11d61cc01e Swap ordering to ensure Dynamic always first (#58998) 5 years ago
Alicia Cozine 0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 5 years ago
Samy Coenen 0befccbeb9 Update intro_inventory.rst (#58732) 5 years ago
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>
5 years ago
Wojciech Sciesinski f9a31e3e17 Provide the list of packages in a modern way (#58668) 5 years ago
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
6 years ago
Klaus Frank ee52b60d7d Add note about delegate_facts to run_once (#58241)
* Add note about delegate_facts to run_once
6 years ago
Alicia Cozine d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
6 years ago
Sayed Anisul Hoque 57596edcca Updated the playbooks_tags guide (#58011)
* Updated the playbooks_tags guide
6 years ago
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
6 years ago
Sayed Anisul Hoque b768a0780c Update playbooks_vault.rst (#58005)
Corrected the internal reference link to point to the FAQ entry.

+label: docsite_pr
6 years ago
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>
6 years ago
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'
6 years ago
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
6 years ago
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>
6 years ago
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>
6 years ago
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).
6 years ago
Sandra McCann c06f890f55 add docs for vlan_parser filter (#57498) 6 years ago
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.
6 years ago
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.
6 years ago
Sandra McCann 152202ceb0 add info about hwaddr conversion formats (#57491) 6 years ago
Abhijeet Kasurde ee8a607cca ipaddr: Handle network address in ipmath (#57149)
* Updated testcase, documentation

Fixes: #54457

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Ilya Reshetnikov bf0e846a39 Update playbooks_filters.rst (#57200)
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
6 years ago
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.
6 years ago
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
6 years ago
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.
6 years ago
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
6 years ago
Anatoly Kamchatnov 9a563f8947 Windows FAQ: fix reference (#56909) 6 years ago
CsilLAB 6900378766 [WIP] Tip to see the content of a single encrypted var (#37887)
* Tip to see the content of a single var encrypted with Ansible Vault
6 years ago
Sandra McCann 388f5d0b2b Add links to quickstart guides (#56722)
* shell of quickstart

* link to existing quickstart guides
6 years ago
s-hamann 730456b402 Add seed parameter to random_mac filter (#51841) 6 years ago