b768a0780c
Update playbooks_vault.rst ( #58005 )
...
Corrected the internal reference link to point to the FAQ entry.
+label: docsite_pr
5 years ago
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>
5 years ago
fe8a3108a8
Fix error when a deprecated alias of a deprecated module is processed. ( #57774 )
5 years ago
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'
5 years ago
8dfa376e1c
removes link from 404 content, explains options ( #57971 )
5 years ago
1a63f8642e
Update local module options ( #57553 )
...
* Docs: Point out that local plugins can be loaded based on ansible.cfg settings
5 years ago
e834cd7d41
updates reqs for building docs locally ( #57967 )
5 years ago
5658b2ee3e
Adds custom 404 with cowsay image ( #57422 )
...
* Adds custom 404 with image, updates CI reqs, sets version latest for TOC links on 404 page
5 years ago
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
5 years ago
49983fdaf7
doc draft for collections ( #57853 )
...
* doc draft for collections
* fixes
* Update docs/docsite/rst/collections_tech_preview.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/collections_tech_preview.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Apply suggestions from doc review
* Update docs/docsite/rst/collections_tech_preview.rst
* Update docs/docsite/rst/collections_tech_preview.rst
6 years ago
c289006e05
validate-modules: new module: fail if 'type' isn't documented
...
Don't require 'type' when:
- parameter name starts with an underscore
6 years ago
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
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
5243cba0b2
describe how to link to modules or plugins ( #57806 )
6 years ago
3efb57f64e
Typo ( #57795 )
6 years ago
1a5fd720a4
Ansible galaxy role download should not have to perform aditionnal check against tar archive file extension #56616 . ( #56617 )
...
Ansible galaxy role download checked for `.tar.gz`, but `tarfile.is_tarfile(...)` can identify and open any valid tarfile. This change uses transparent stream compression to make `.tar.gz` and `.tar.bz2` formats valid with python 2.6.x/2.7.x (as well as `.tar.xz` with python 3.x).
6 years ago
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
c06f890f55
add docs for vlan_parser filter ( #57498 )
6 years ago
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
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
fc4bbff6e1
AWS: _facts -> _info (part 2) ( #57626 )
...
* Rename cloudwatchlogs_log_group_facts -> cloudwatchlogs_log_group_info.
* Rename elasticache_facts -> elasticache_info.
* redshift_facts -> redshift_info.
* Rename route53_facts -> route53_info.
* Rename rds_instance_facts -> rds_instance_info.
* Rename rds_snapshot_facts -> rds_snapshot_info.
* Rename iam_mfa_device_facts -> iam_mfa_device_info.
* Rename iam_role_facts -> iam_role_info.
* Rename iam_server_certificate_facts -> iam_server_certificate_info.
* Rename elb_application_lb_facts -> elb_application_lb_info.
* Renaming elb_classic_lb_facts -> elb_classic_lb_info.
* elb_target_facts -> elb_target_info.
* Rename elb_target_group_facts -> elb_target_group_info.
* Update porting guide.
* Add changelog.
* Fix module defaults (both for this PR and #57613 ).
* Two fixes.
6 years ago
51229eb99c
AWS modules: _facts -> _info ( #57613 )
...
* Rename aws_acm_facts -> aws_acm_info.
* Rename aws_az_facts -> aws_az_info.
* Rename aws_caller_facts -> aws_caller_info.
* Rename aws_kms_facts -> aws_kms_info.
* Rename aws_region_facts -> aws_region_info.
* Rename aws_sgw_facts -> aws_sgw_info.
* Rename aws_waf_facts -> aws_waf_info.
* Adjust docs.
* Add changelog and update porting guide.
6 years ago
039eb892ba
Second batch for _facts -> _info rename ( #57020 )
...
* Second batch of _facts -> _info.
* Forgot one reference.
6 years ago
ef2d70a806
Rename ali_instance_facts -> ali_instance_info ( #57036 )
...
* Rename ali_instance_facts -> ali_instance_info.
* Add changelog.
6 years ago
93a85b6c86
Additional rename fixes ( #57527 )
...
* adding symbolic link
* missing renames
* reverted version_added
6 years ago
152202ceb0
add info about hwaddr conversion formats ( #57491 )
6 years ago
72297db686
Renames Digital Ocean cloud _facts modules to _info ( #57315 )
...
Fixes : #57276
6 years ago
c6097a268c
rename modules azure_rm_..._facts to azure_rm_..._info ( #57395 )
6 years ago
3136007032
update docsite breadcrumbs from sphinx_rtd_theme ( #57316 )
...
* improve breadcrumbs
* get edit on github working again
6 years ago
96693600f9
2.9 roadmap dates ( #57420 )
...
* add dates to 2.9 roadmap, remove alpha phase
6 years ago
dfaa72297c
Fix an RST link to the changelog config in docs
6 years ago
ee8a607cca
ipaddr: Handle network address in ipmath ( #57149 )
...
* Updated testcase, documentation
Fixes : #54457
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
7b40b569b2
Rename memset_*_facts to memset_*_info ( #57030 )
...
* Rename memset_*_facts to memset_*_info
* Add changelog.
6 years ago
5162d21ea3
VMware: vSphere Automation SDK installation docs ( #57280 )
...
* VMware: adds instructions for installing vSphere Automation SDK to the dynamic inventory scenario
6 years ago
bf0e846a39
Update playbooks_filters.rst ( #57200 )
...
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
6 years ago
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
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
49ec681a73
Fix ansible_async_dir in the migration doc
6 years ago
c47e9d22b4
Rename one_image_facts -> one_image_info ( #57035 )
...
* Rename one_image_facts -> one_image_info.
* Add changelog.
* Forgot symlink.
6 years ago
5183f84016
📝 Mention the minumum cherry-picker version in doc ( #57139 )
6 years ago
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
e17434c19f
Correct repository name to install ( #56991 )
6 years ago
61b48778a7
Rename _facts -> _info ( #57028 )
6 years ago
7a0af34ba9
First batch _facts -> _info rename. ( #56822 )
6 years ago
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
9a563f8947
Windows FAQ: fix reference ( #56909 )
6 years ago
50b1a66649
Update instructions for running module directly ( #56883 )
...
The internals of AnsiballZ changed silghtly
6 years ago
fc94d79c47
CLI docs include license not copyright ( #56871 )
6 years ago
f9b43a0f68
Copyright fix for 2018 ( #56860 )
...
* update copyright in footer
* remove extraneous copyright from cli commands
6 years ago
3129fc0b17
Update RHEL repo for Ansible 2.8 ( #56859 )
6 years ago
26d38dd642
VMware: Add folder param in vmware_datastore_cluster
...
* Make datacenter as alias and optional
* Add folder param to place datastore cluster in specific folder
* Updated examples
* Updated tests
Fixes : #48010
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
459776eb82
VMware: Add folder option for vmware_dvswitch ( #56707 )
...
* Added folder param
* Mark datacenter as optional parameter
* Updated docs
* Updated tests
Fixes : #54986
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
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
53ec9c8019
Clarify that GPLv3+ module_utils need core team approval ( #56740 )
...
* Clarify that GPLv3+ module_utils need core team approval.
* Update docs/docsite/rst/dev_guide/shared_snippets/licensing.txt
Co-Authored-By: Sam Doran <sdoran@redhat.com>
* More 'module_util' -> 'file in module_utils'.
6 years ago
388f5d0b2b
Add links to quickstart guides ( #56722 )
...
* shell of quickstart
* link to existing quickstart guides
6 years ago
66bfa27685
Replace deprecated ansible-container references ( #56427 )
...
Link to ansible-bender instead of the deprecated ansible-container.
Co-Authored-By: Felix Fontein <felix@fontein.de>
6 years ago
abca3f1956
Clarify documentation on _info vs. _facts modules ( #56611 )
...
* Clarify documentation on _info vs. _facts modules.
* Expand with examples for facts and non-facts.
6 years ago
4742897635
Move backport guide to 2.8 ( #56578 )
...
The backport guide should refer to Ansible 2.8 instead of 2.7 as the target branch, since 2.8 is out.
6 years ago
3f4a22d8ef
Add compat tojson filter for jinja2 versions missing it ( #56596 )
6 years ago
a3c3fd91f8
move too old version to 2.3 ( #56540 )
6 years ago
730456b402
Add seed parameter to random_mac filter ( #51841 )
6 years ago
f88b660717
adds 2.9 roadmap, reversed local TOC order ( #56371 )
6 years ago
118cf3ece6
Cloud dev docs to rst ( #56485 )
...
* Moves developer docs for AWS, ovirt, and openstack modules out of lib/ansible/, integrates them with dev_guide, with abadger's fix to make python snippets pass rstcheck
6 years ago
635931051b
[Doc-Release-2.8] fixed broken module links in 2.8 porting guide ( #56494 )
...
* fixed broken module links
6 years ago
4bf134756b
changed version to 2.8 ( #56487 )
6 years ago
f097dca60d
update release table for 2.8 ( #56486 )
6 years ago
d55823b013
Update of Ansible 2.8 roadmap (add RC2 & RC3) ( #56436 )
...
##### SUMMARY
* Remove **if needed** for RC2 & RC3
* Set correct release date for RC3
6 years ago
f9b56a5b56
Add sanity test to check for unwanted files.
6 years ago
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
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
6948e04276
Add myself to committer list. ( #56363 )
6 years ago
85fa65e5f0
docs: Update scopes value example ( #56362 )
...
Existing example in GCE guide returns "invalid scope" error; value needs "https://" prefix
6 years ago
c1ebc8d9c2
Update default roles_path documentation ( #56320 )
6 years ago
3c8d8b1509
should have gone into 52373 ( #56306 )
6 years ago
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
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
dae5564e2b
Fix var naming ( #55796 )
...
* Fix var naming in GCE guide
6 years ago
8ff27c4e0c
more info on how vaults work ( #56183 )
...
also add warning about what it covers.
6 years ago
53ed1bfc49
Improve rendering of default lists ( #56041 )
6 years ago
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
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
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
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
5d4c73e197
unite poll defaults ( #55470 )
...
* unite poll defaults and update docs
6 years ago
76dba7aa4f
Add faq note about ssh ServerAliveInterval ( #55568 )
6 years ago
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
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
b3ce3fc5eb
Restore ansible --version output ( #55728 )
...
* Add custom action class for version info
* Use args from CLI as prog for ArgumentParser object
* Make prog a required parameter of create_base_parser() and update all uses to pass in the newly required parameter.
* Add unit test for checking ansible --version
* Update other related unit tests
6 years ago
47a440774f
Speed up the Sphinx documentation build ( #55593 )
...
* speeds up the docs build by changing the navigation collapse setting
6 years ago
943f7334c5
Fix var naming ( #55795 )
...
Make vars match tasks in Google Compute guide.
6 years ago
9d5b5d7ddd
correct description of modules vs plugins ( #55784 )
6 years ago
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
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
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
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
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
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
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
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
6ea3eca8ff
Update windows_setup.rst ( #55535 )
...
Wrong protocol and port in command.
+label: docsite_pr
6 years ago
Sayed Anisul Hoque