Commit Graph

452 Commits (6160e82bf2fc840487e620ec48be3bd28fb2b744)

Author SHA1 Message Date
Baptiste Mille-Mathias 8c48366f1c
Document to_json will convert to ASCII strings by default (#70954)
... as reported in issue #68702
4 years ago
Emilien Macchi 37e9d2278a
Fix a typo in "restart mysql" example (#70950)
Fix a typo in "restart mysql" example task. It's missing a space between "state:" and "restarted".
4 years ago
Fixmetal 7a42d27462
Proper example for splitext filter in docs (#70494)
* Update playbooks_filters.rst with a clear example of how to extract its 2 tokens. 

Co-authored-by: Sloane Hertel <shertel@redhat.com>
4 years ago
Sandra McCann 24e5d3a51c
fix rstcheck problem and gitignore collections dir (#70764) 4 years ago
David Rieger 633c2d0522
Fix misleading documentation for naming blocks (#68458)
From what I have observed it is the block itself that doesn't support the name attribute rather than the tasks inside the block.

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

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi 9dda393d70
Collections docs generation (#59761)
* Build documentation for Ansible-2.10 (formerly known as ACD).

Builds plugin docs from collections whose source is on galaxy

The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.

* Update the python syntax checks
  * docs builds can now require python 3.6+.

* Move plugin formatter code out to an external tool, antsibull-docs.
  Collection owners want to be able to extract docs for their own
  websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs

* Cleanup and bugfix to other build script code:
  * The Commands class needed to have its metaclass set for abstractmethod
    to work correctly
  * Fix lint issues in some command plugins

* Add the docs/docsite/rst/collections to .gitignore as
  everything in that directory will be generated so we don't want any of
  it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages

* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs

* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined

* Remove references to plugin documentation locations that no longer exist.
  * Perhaps the pages in plugins/*.rst should be deprecated
    altogether and their content moved?
  * If not, perhaps we want to rephrase and link into the collection
    documentation?
  * Or perhaps we want to link to the plugins which are present in
    collections/ansible/builtin?

* Remove PYTHONPATH from the build-ansible calls
  One of the design goals of the build-ansible.py script was for it to
  automatically set its library path to include the checkout of ansible
  and the library of code to implement itself.  Because it automatically
  includes the checkout of ansible, we don't need to set PYTHONPATH in
  the Makefile any longer.

* Create a command to only build ansible-base plugin docs
  * When building docs for devel, only build the ansible-base docs for
    now.  This is because antsibull needs support for building a "devel
    tree" of docs.  This can be changed once that is implemented
  * When building docs for the sanity tests, only build the ansible-base
    plugin docs for now.  Those are the docs which are in this repo so
    that seems appropriate for now.
4 years ago
Alicia Cozine db354c0300
Docs: User guide overhaul, part 5 (#70307) 4 years ago
Karl Goetz c410311f55
Clarify that index_var is 0 indexed (#70548)
A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed.
Its zero indexed twin has a 0 suffix.

``ansible_loop.index``      The current iteration of the loop. (1 indexed)
``ansible_loop.index0``     The current iteration of the loop. (0 indexed)

To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed.
4 years ago
mahadelmi f4ea43c4a0
Update windows_winrm.rst (#70306)
gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation.
4 years ago
FloMiau f7db428375
update documentation link to python 3 (#70509)
update the docs link for strftime on the filters page to point to the python3 docs
4 years ago
David Shrewsbury 4e41e37aa7
Fix flatten null perserve versionadded (#70435) 4 years ago
Baptiste Mille-Mathias 9eb904ea61
Add documentation for ipaddr filters (#70343) 4 years ago
jafiala 7c90a2d2a6
Update playbooks.rst (#70317) 4 years ago
Brian Coca 7a15a3a109
fix flatten handling of nulls/nones (#70141)
* fix flatten loop control issue (break -> continue)

fix issue #69012

(cherry picked from commit 2127be5ec5)

* fixed null break bug and added option to include

 fixes #69012
 fixes #69013

Co-authored-by: pseudocoder <borisovano@users.noreply.github.com>
Co-authored-by: David Shrewsbury <Shrews@users.noreply.github.com>
4 years ago
Brian Coca 5d3d097de3
more correct info about role main.yml (#70326)
fixes #40496
4 years ago
Alicia Cozine c89f3cda9e
incorporate minimalism feedback on filters page (#70366)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Rick Elrod 91aea92c62
Add ability to fallback to chgrp remote_tmp and its files. (#68627)
* Add ability to fallback to chgrp remote_tmp and its files.

Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Mark Sanders dc6f4b6502
Fix bullet points in intro_getting_started.rst. (#70365)
The layout was jumbled due to issues with whitespace.
4 years ago
Gonéri Le Bouder b491f776b9
doc: avoid mix of single and double quotes (#70115)
Avoid mix of single and double quotes in the `ternary`, this way
we can copy/past the example without any surprise.
4 years ago
Adam Miller 3c9be97e16
fix runtime.yml splunk.enterprise_security -> splunk.es (#70305)
Signed-off-by: Adam Miller <admiller@redhat.com>
4 years ago
Abhijeet Kasurde 40a42de081
async_status: Update documentation (#70196)
Fixes: #38164

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Westley Argentum Hennigh-Palermo 5885ed4455
remove gendered example (#70117)
Changed example to not assume things about names and genders
4 years ago
Allen fb9740db4c
Specify numeric range can contain a stride (#68952)
Updated the range creation example to show that you can also specify a stride value when creating a hostname by numeric range.
4 years ago
Alicia Cozine 851e8e18b2
clarifies that vars can begin with _, with a warning (#69749)
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>
4 years ago
Matt Martz 9667f221a5
Make AnsibleVaultEncryptedUnicode work more like a string (#67823)
* Make AnsibleVaultEncryptedUnicode work more like a string. Fixes #24425

* Remove debugging

* Wrap some things

* Reduce diff

* data should always result in text

* add tests

* Don't just copy and paste, kids

* Add eq and ne back

* Go full UserString copy/paste

* Various version related fixes

* Remove trailing newline

* py2v3

* Add a test that can evaluate whether a variable is vault encrypted

* map was introduces in jinja2 2.7

* moar jinja

* type fix

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

* Remove duplicate __hash__

* Fix typo

* Add changelog fragment

* ci_complete

Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Marco Lussetti 1dd8247fba
Add SLES to user_guide/playbook_conditionals.yml (#69262) 4 years ago
Sloane Hertel e40889e711
Add support to install collections from git repositories (#69154)
* Enable installing collections from git repositories

* Add tests for installing individual and multiple collections from git repositories

* Test to make sure recursive dependencies with different syntax are deduplicated

* Add documentation

* add a changelog

* Skip Python 2.6

* Only fail if no collections are located in a git repository

Add support for a 'type' key for collections in requirement.yml files.
Update the changelog and document the supported keys and allowed values for the type.

Add a note that the collection(s) in the repo must contain a galaxy.yml

* Add a warning about embedding credentials in SCM URLs

* Update with review suggestions

* suppress sanity compile failure for Python 2.6
4 years ago
Brian Coca d0a25f004c
note that environment is not good for secrets (#69618)
* note that environment is not good for secrets
* Update docs/docsite/rst/user_guide/playbooks_environment.rst
Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Jeff Geerling 21b65257bf
Fix spacing for playbook collections example. (#69688) 4 years ago
Jack Scheible 0ce404c4d9
Update intro_inventory.rst (#69718)
Vars in inventory are merged in ASCII order. Change docs to reflect that.
4 years ago
Pilou 59f2174c8b
Doc: playbook keywords are reserved names too (#69585) 4 years ago
Alicia Cozine 6fffb0607b WIP: Docs: User guide overhaul, part 4 (#69266)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Lukas Pirl 34db57a47f
introduce fact "ansible_processor_nproc": number of usable vcpus (#66569)
This fact reflects the number of usable vcpus (which might be different
from ansible_processor_vcpus, e.g., in containers with limits). See
also #51504.

* Add fixture data and update unit tests

Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Sloane Hertel 55e29a1464
ansible-galaxy - fall back to galaxy.yml when listing collections (#68925)
Fallback to galaxy.yml for listing collections that don't have a FILES.json or MANIFEST.json

Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Andreas Bühmann 1a5bbfbe01
Fix name of utility "nologin" (#69207)
The utility is `nologin`, not 'no login'. Fix this on the page about Become. In the example further down below it is spelled correctly.
4 years ago
Lucas Ramage c52121f4c9
Clarification for Ansible and BSD Introduction (#69275)
Bug: https://github.com/ansible/ansible/issues/69274
4 years ago
Douglas Thor 46fea92125
Add note in inventory guide saying group names follow variable name guidelines. (#69285) 4 years ago
Sandra McCann 44a4538280
add FQCN for migrated filters (#69321) 4 years ago
Sandra McCann caa263e2cf
Document how to migrate a standalone role to a collection (#68687)
Adds docs for role developers/owners in the collections ecosystem
4 years ago
Abhijeet Kasurde b437236633
Redirect inventory script links (#69143)
With inventory script migrated to their respective collection,
redirect links in documentation to their respective collection
location.

Fixes: #69139

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Abhijeet Kasurde 572fe9e480
Adjust Openstack Inventory script path (#69058) 4 years ago
Abhijeet Kasurde 6493a190f6
docs: Update inventory script paths (#68905)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Kenyon Ralph a681810b2f
doc: variable precedence: "override", not "overwrite" (#68698) 5 years ago
pallxk 43270332e7
true and false commands have to be quoted (#68761)
otherwise they will be parsed as bool instead of string by YAML.
5 years ago
nzarin 16e07fe5b5
Fix grammar error in docfile (#68707) 5 years ago
John Mahowald db01053d6a
Remove reference to core Ansible (#68462) 5 years ago
Alicia Cozine 9139c1f81d
consistently call tests tests, not filters (#68170)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
5 years ago
Toby Foster 913ee9119a
Fix list formatting in Getting Started (#68153) 5 years ago
Simon Legner 969e209a48
docs(windows_setup): +choco install openssh (#68408)
Also show most basic way of installing OpenSSH via Chocolatey
5 years ago
Jordan Borean 7ec0d59c30
windows - add docs for UNC path in PSModulePath error (#68421) 5 years ago