ansible

Commit Graph

Author	SHA1	Message	Date
Sandra McCann	45c8c9909d	[Docs][2.10] Backportapalooza 11 (#71702 ) * Add note on where inventory scripts moved to' (#71638) (cherry picked from commit `2f240f5dd7`) * clarify that collection names use same requirements as namespaces (#71639) (cherry picked from commit `bbd4ec13f1`) * Fix typo in documentation (#71652) Fix typo on the page about unit testing modules, (cherry picked from commit `1ad0f666d5`) * Changed all_modules references to list_of_collections in the documentation (#71656) (cherry picked from commit `a34043c6be`) * Adds FAQ and other pointers for collections (#71606) (cherry picked from commit `b430f9b9aa`) * Docs(lineinfile): Update link to python regex docs (#71688) There was a link still pointing at the python2 documentation. (cherry picked from commit `11ba30183e`) * Docsite: add reference to Style guide (#71694) (cherry picked from commit `73bed95ead`) Co-authored-by: Zois Pagoulatos <zpagoulatos@hotmail.com> Co-authored-by: esmersmith <62951573+esmersmith@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Valentin Krasontovitsch <v.krasontov@gmail.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>	5 years ago
Alicia Cozine	43e0aa5b57	WIP: Backport/2.10/71588 (#71626 ) * Add dual index pages for roadmaps (part of #71566) (cherry picked from commit `b518a5db14`) * Docsite: replace Latin phrases to English (#71588) Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases. * Update docs/docsite/rst/community/committer_guidelines.rst * Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst * Update docs/docsite/rst/dev_guide/module_lifecycle.rst * Update docs/docsite/rst/user_guide/intro_inventory.rst * Update docs/docsite/rst/user_guide/playbooks_loops.rst * Update docs/docsite/rst/user_guide/playbooks_reuse.rst * Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst * Update docs/docsite/rst/dev_guide/testing.rst * Update docs/docsite/rst/dev_guide/testing_integration.rst * Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst * Update docs/docsite/rst/reference_appendices/faq.rst (cherry picked from commit `7bfeed3e24`) * fix index page and TOCs * adds old roadmap index * adds toctree ref for old roadmaps Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>	5 years ago
Sandra McCann	d3e0cb4320	[docs][2.10] Backportapalooza 9 (#71493 ) * Explain duplicate checks includes tags and when (#68183) ##### SUMMARY Per #67913, when comparing dependencies, Ansible takes into account parameters, tags and the when clause in determining whether a role is a duplicate or not. ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit `3e4377300b`) * Docs: ansible_host can contain FQDN (#71186) (cherry picked from commit `13ab73cd89`) * clarify inventory plugin user documentation (#71387) (cherry picked from commit `fb035da3b2`) * Keep caution tape for older versions (#71400) (cherry picked from commit `156b1c5245`) * document securing editor for vault (#71404) (cherry picked from commit `6c48c62f93`) * galaxy: Add examples for galaxy section in ansible.cfg (#70931) Add example section for galaxy section in ansible.cfg Fixes: #68402 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `3f3bcbf05e`) * docs: Remove examples using the `ec2.py` script (#69107) This script is mostly unmaintained and relies on the deprecated and unmaintained `boto` library. Featuring it prominently in the docs leads to many new users using it instead of the supported `aws_ec2` inventory plugin. (cherry picked from commit `66e38bf499`) * Update uri.py (#67688) Adds an example of creating workspaces in Log analytics Azure Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit `4317c2c80c`) * docs: Update Kubernetes Guide (#71372) Fixes: #61681 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `59b80b9146`) * fix broken links due to master -> main branch rename (#71426) (cherry picked from commit `2b7461eb52`) * Modify wording to specify two ctl-d to end stdin input in ansible-vault (#69436) * 51860 - Modify wording to specify two ctl-d to end stdin input in ansible-vault * removes space to make line 160 chars (cherry picked from commit `a6537b59ab`) * user_guide: Add an example for loop (#71441) Explain how to use complex data in loop while converting from with_together Fixes: #47906 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `5c1594916a`) * Add link to Matt's blog (#71436) nitzmahone's blog nicely explained why Windows is not supported as Ansible controller. Link that in documentation so users can read about it. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `3c8744f0c1`) * user_guide: Fix reuse role examples (#71440) Fixes: #53919 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `0b16c0a8c7`) * service: Add a note about ignored parameters (#71455) Some parameters for systemd are ignored, add a note about such parameters in documentation. Fixes: #23144 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `1257b0a184`) * updates network plugin docs pages for 2.10 (#71467) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit `f82a1e06d7`) * Remove "mode: preserve" option from documentation (#71486) Remove "mode: preserve" option from documentation in doc fragments "FILE_COMMON_ARGUMENTS", as it was incorrectly included in the documentation for the `lineinfile`, `unarchive` and other file-related modules. The `copy` and `templates` modules documentation remains untouched and still contain "mode: preserve", as intended. (cherry picked from commit `7127d37466`) * quick update to changelog instructins (#71492) (cherry picked from commit `addee0699e`) * update Network Advanced Topics for FQCN (#71325) * update Network Advanced Topics for FQCN (cherry picked from commit `b6f10b9b52`) * fix shippable error Co-authored-by: David M. Lee <leedm777@yahoo.com> Co-authored-by: Eric G <e+github1690@linuxw.info> Co-authored-by: Sloane Hertel <shertel@redhat.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: flowerysong <paul.arthur@flowerysong.com> Co-authored-by: Jose l. Azagra <azagramac@gmail.com> Co-authored-by: Patrick Reader <pxeger@protonmail.com> Co-authored-by: John Westcott IV <32551173+john-westcott-iv@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Timothy Visser <team@sacrome.com>	5 years ago
Sandra McCann	ae9c1167e4	[2.10] Docs Backportapalooza 7 (#71261 ) * Fixes due to branch being renamed (#71115) The ansible collection repository correctly renamed their default branch from `master` to `main`, which has caused a number for broken urls. This PR fixes those urls. (cherry picked from commit `fb9c9570d5`) * Docs: Fix typo (#71119) (cherry picked from commit `cb9336ab6d`) * remove network for 2.10 base porting guide (#71158) (cherry picked from commit `56748a8060`) * Updating Getting Started with Resources section #68962 (#71102) * Updating Getting Started with Resources section #68962 * Add links, including Workshops URL #68962 (cherry picked from commit `5f8b45a70e`) * start of 'data manipulation' examples (#46979) Co-authored-by: Klaus Frank <agowa338@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `f46b124d65`) * toml: Clarify about inventory examples (#71180) Add a note in toml inventory plugin about three different inventory examples. Fixes: #67003 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `edac065bd2`) * filters: minor doc fix (#71178) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `0a7ab396c7`) * docs: 'ansible_play_hosts' lists active hosts, not limited by serial (#71116) ansible_play_batch lists the currently targeted host(s) in the serial/batch, while ansible_play_hosts lists all the hosts which will be targeted by the play. (cherry picked from commit `e72e12aa27`) * Fix references to Ansible Collections Overview (#71227) (cherry picked from commit `19589db10c`) * add another resource module example (#71162) * Update docs/docsite/rst/network/user_guide/network_resource_modules.rst Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com> (cherry picked from commit `f4388de14d`) * Adds fest link (#71241) (cherry picked from commit `ae3b8eec12`) * Update release page for ansible and ansible-base (#71229) * [docs] 2.7 is EOL, add 2.10 which is almost out - Remove 2.7 support from the maintenance schedule - Add 2.10 which is in RC and will be out soon enough. Signed-off-by: Rick Elrod <rick@elrod.me> * Update docs/docsite/rst/reference_appendices/release_and_maintenance.rst, fix table and separate ansible-base from ansible, fix rstcheck errors, clean up sections, explain the two packages Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Rick Elrod <rick@elrod.me> (cherry picked from commit `553ccedcd3`) Co-authored-by: Daniel Finneran <dan@thebsdbox.co.uk> Co-authored-by: Liviu Chircu <liviu@opensips.org> Co-authored-by: kshitijcode <ikshitijsharma@gmail.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Håkon Solbjørg <hakon@solbj.org> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	5 years ago
Toshio Kuratomi	46b1a999c6	Collections docs generation backport (#70515 ) * 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. * Docs: User guide overhaul, part 5 (#70307) (cherry picked from commit `db354c0300`) * Need to return any error code from running antsibull-docs (#70763) This way we fail early if there's a problem (cherry picked from commit `1e3989c9f7`) Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	5 years ago
Adam Miller	ad61774acf	fix runtime.yml splunk.enterprise_security -> splunk.es (#70305 ) (#70310 ) Signed-off-by: Adam Miller <admiller@redhat.com>	6 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	6 years ago
Jeff Geerling	21b65257bf	Fix spacing for playbook collections example. (#69688 )	6 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>	6 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	6 years ago
Jordan Borean	a2deeb8fa2	ansible-galaxy - add download option (#67632 ) * ansible-galaxy - add download option * Fix sanity issues and added integration tests * Fix doc suggestions * Added --pre option	6 years ago
Sandra McCann	8fbec3cdeb	add download tarball option (#67548 )	6 years ago
John R Barker	4844adff9a	Collection developer guide - BOTMETA (#67538 ) * Docs: Improve how to migrate and create collections * Update docs/docsite/rst/dev_guide/developing_collections.rst Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>	6 years ago
Sam Doran	f506fd4730	Add ansible-galaxy collection list command (#65022 ) * Start adding ansible-galaxy collection list options * Working list all collections and list a specific collection * Nuke debugging cruft * Use to_text to get a string of the FQCN for sorting * Improve collection output formatting - add header - display collection name and version in separate columns - width of columns is dynamic based on collection name and version length * Make role list output match collection output list - add header - add columns for role name and version - make column width dynamic based on name and version length * remove debug statemnt and extra header * Revert "Make role list output match collection output list" This reverts commit a0b3db47bb3b198aafd34c1f1be5b6561af2f928. * Add validate_collection_path function Utility function for ensuring a collection target ends with 'ansible_collection' * Use validate_collection_path * Do not warn if a specific collection in found in any search path * Fix extraneous warning and remove duplicate code Do not warn when listing a specific collection and it does not exist in other collection paths. Restructure the code that loops through collection paths to remove duplicate conditional code. * Indicate role path was found * Use new function name * WIP Save Point * Use separate functions for role and collection list * Wrap error message There may be a better way to do this besides hard coding a line break, but this does make the message a lot more readable. * Add validate_collection_path function (#66441) * Add validate_collection_path function Utility function for ensuring a collection target ends with 'ansible_collection' * Fix bad syntax * Correct docstring * Bikeshed the names * Properly list a single role * Simplify _display_warnings() Only display warnings. Move exception raise back to each caller. * Move private methods to private functions They don't need self, so it makes sense to have them as functions Get rid of _display_warnings() function since it doesn't do anything worthy of an independent function. * Add integration tests for ansible-galaxy collection list * Fix docs sanity test * Fix bug where ansible_collections dir does not exist The path may exist, but if there is no ansible_collections dir inside that path, an exception was raised in find_existing_collections(). Add integration test for this scenario * Put execute_list() method back * Add some informational messages for debugging * Add unit tests Units tests for the various private methods in support of collection list * Start adding unit tests for test_execute_list * Display collection path when listing specific collection * Add unit tests for listing all collections and specific collection - Create fixture for creating test objects - Add function for controlling os.path.isdir results * Set defaults for minimum collection widths Ensure that collections with small FQCNs display correctly. Add unit tests * Split up unit tests and fix fixtures Add more fixtures for mocking objects during the specific collection tests * Change help message for -p in list subcommand Give accurate description of what it actually does rather than trying to use language shared between sub commands. * Disable colorized output in unit test * Add docs for collection list * Fix integration test on macOS The temp file path is really long on macOS, so the warning message gets wrapped across multiple lines. That make seth grep fail. Switch to matching on a smaller part of the warning. * Recreate common path options for collections Improve help about what the '-p' option does and how it works. * Remove unnecessary elif after continue statements * Account for duplicate paths in collections_searh_paths If someone specifies the same path via '-p' that is the COLLECTIONS_PATHS, do not list the collections twice. * Docs updates	6 years ago
Ken Dreyer	0485ce9d12	docs: fix path to roles' meta/main.yml file (#67408 )	6 years ago
Sloane Hertel	97f011cf94	Add verify subcommand to 'ansible-galaxy collection' (#65618 ) * [WIP] Add verify subcommand command to 'ansible-galaxy collection' * Fix pep8 and use consistent display order * WIP - docs * Remove some redundancy in verify display messages by using an error queue for each collection * Share common code and improve output format * clean up documentation * typo * Apply suggestions from code review Co-Authored-By: Sandra McCann <samccann@redhat.com> * Move ModifiedContent namedtuple to the global scope Add a public metadata property Rename function to _get_json_from_tar_file * Add some unit tests * fix using common functions after rebase * changelog * Improve efficiency finding specific installed collections Improve efficiency by only downloading the tar.gz from the galaxy server for comparison after checking that the collection has been installed Handle multiple collection paths Fix up tests * pep8 * reword that for accuracy * use more common code and verify collection name * Improve error message and add documentation * Update unit tests and add coverage for both local and remote collections that are unable to be located * Only validate collections using the format collection_namespace.collection_name Fix tests to reflect that Fix documentation * Fix a bug when a local collection does not contain a file * pep8 * Fix formatting Co-authored-by: Sandra McCann <samccann@redhat.com>	6 years ago
Alicia Cozine	cb8ce7159d	Docs: clarify that roles do not inherit collections set in a playbook (#66667 ) Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com> Co-authored-by: Sandra McCann <samccann@redhat.com>	6 years ago
Sandra McCann	a01376a493	update configuring ansible-galaxy client (#64796 ) * update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.	6 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	6 years ago
Alicia Cozine	941a9b68fc	Docs: User guide overhaul, part 1 (#63056 )	6 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	6 years ago
Chris Houseknecht	911aa6aab9	Default collection install path to first path in COLLECTIONS_PATHS (#62870 )	6 years ago
Sandra McCann	7e01de96d7	add more anchors to collections docs (#62827 )	6 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	6 years ago

24 Commits (45c8c9909de665e63a0c986bc96e4f99aac650f8)