summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Eol 2.9 docs (#77884)Sandra McCann2022-05-262-3/+2
| | | | | | | | | | | * EOL 2.10 docs (cherry picked from commit 0d42a01fd947ed79615626dd6cb2db82b6e627df) * add link to AAP lifecycle for RH customers * remove extra period * change message based on feedback
* fixed ansible.cfg link for 2.9 (#75631)Brian Coca2021-09-021-1/+1
|
* add known-good requirements for docs (#75459)Sandra McCann2021-08-112-1/+17
|
* collections_using.rst: add note that manual upgrade is required when ↵Andrew Klychkov2021-06-241-0/+3
| | | | | installing collections from Galaxy (#75024) (#75027) (cherry picked from commit 5df82415b553a96c50b335b3480385e5701a9033)
* remove reference to container ML (#75014) (#75030)David Shrewsbury2021-06-231-2/+1
| | | (cherry picked from commit 2387ce311f26ca34bf6974d1231d470db22fdd42)
* Due to the takeover of freenode we're moving to a different irc network. ↵Andrew Klychkov2021-06-2377-85/+93
| | | | | | | | | | | | | | | | | | (#74775) (#75007) * Update channel references to point at the same channel name on libera.chat * Update generic links to https://libera.chat * In general, use irc.libera.net for link names/text and https://libera.chat for link targets. The irc service is hosted on irc.libera.chat but the project web server is hosted on libera.chat. * Removed http://irc.freenode.net from the linkcheck exceptions. * Add a link to where contributors should get support for developing groups of modules to docs/docsite/rst/dev_guide/developing_modules_in_groups.rst Co-authored-by: John R Barker <john@johnrbarker.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 80e7e1a17cb6aaf10e289e671fc382a614018e6e) Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
* Workaround bug in jinja2-3.0.0 and 3.0.1 (#74795)Toshio Kuratomi2021-06-031-2/+7
| | | | | | | | | | | | | | Jinja2-3.0.0 and 3.0.1 has a bug where undefined values cannot be checked to see if they contain a value: https://github.com/pallets/jinja/issues/1448#issuecomment-846029509 We workaround this in two ways, either of which would be sufficient: * Normalize the data so that choices is an empty iterable when it isn't specified in the documentation. This is what antsibull-docs (and thus documentation builds on 2.10+) do. * Change the logic in the template to check whether choices exists before checking containment. This better expresses the logic at that point in the template (if there is a default value but there is not a list of choices, then display the default in its own string) so it's a good change to make as well.
* Product-related updates. (#74463)Bill Nottingham2021-05-038-19/+17
|
* Backports list of available versions to 2.9 for Ansible 3 (#74265) (#74321)Alicia Cozine2021-04-161-2/+2
| | | | | | | | | * updates list of available versions for Ansible 3 (#74265) (cherry picked from commit 126e9244c2bbe12234d0cbd98c0802444ab103f5) * oops, also need to update pointer to latest Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
* Revert "[2.9]update the docs requirements versions (#73108) (#73252)" (#73261)Alicia Cozine2021-01-151-2/+2
| | | | | This reverts commit 6ae2146d023a74b28d3d85635f4a18d308c0a19c. Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
* [2.9]update the docs requirements versions (#73108) (#73252)Sandra McCann2021-01-151-2/+2
| | | | | | | * update the docs requirements versions (#73108) (cherry picked from commit 093662390150491a81e8762d24d96a4258b0aa0d) * remove antsibull
* replace porting guides with stub pages - issue 71687 (#71988) (#72599)Sandra McCann2020-11-139-2915/+38
| | | (cherry picked from commit 5a3a2d1a39a610a820ec0142b93b0200222c05f3)
* Improve config.rst formatting (#72354) (#72488)Felix Fontein2020-11-131-32/+101
| | | | | | | | | | | | | | | * Indent Jinja2 directives. * Show version_added and deprecations for ini settings and environment variables. * Make default conditional, add choices. Copied from #55474. * Add Ansible variables. Copied from #55474. * Turn ini keys and environment variables into lists. Copied from #55474. * Improve formatting. Copied from #55474. (cherry picked from commit 569d937df8cfc2bd0e4c9f62b5b25021ae5e5cc1)
* clarify upstream release status of 2.10 (#72269) (#72490)Sandra McCann2020-11-051-5/+11
| | | | | * clarify upstream release status of 2.10 (cherry picked from commit d76f85208daef0c6acf8b9b7e40ba88d113044a3)
* remove github link from plugins (#70951) (#71894)Sandra McCann2020-09-251-4/+8
| | | (cherry picked from commit e28b20d72930ad8c0a359de05e05726090165fda)
* update version switcher for 2.10 release (#71867)Sandra McCann2020-09-221-2/+2
| | | (cherry picked from commit bf4e102d97325e2dcf471b7ddd887942aa27da64)
* [2.9] Redirect inventory script links (#71732)Felix Fontein2020-09-214-7/+7
|
* [docs] Fix up porting guides for CVE revert [2.9] (#71582)Rick Elrod2020-09-012-4/+10
| | | | | | | | Change: - Fix up wording and do proper backports for porting guide entries. - Remove original, non-backported version Signed-off-by: Rick Elrod <rick@elrod.me> (cherry picked from commit ed48a2dd624cb7feb874fddcf49ef538857cd3e6)
* Re-add changelogs and add docs for CVE-2020-1736 reverts [2.9] (#71515)Rick Elrod2020-08-311-0/+4
| | | Signed-off-by: Rick Elrod <rick@elrod.me>
* point all older release pages to devel (#71428) (#71430)Sandra McCann2020-08-241-138/+3
| | | (cherry picked from commit 3be597419d5656ea69fa7c505f196d528af07914)
* Add Fest banner (#71360) (#71362)Sandra McCann2020-08-191-15/+8
| | | | | Adds Fest banner, with fixes; updates existing banners, adds links. (cherry picked from commit 9be8d723da8380c5717235b124e08dfcb23dd792)
* Adds fest link (#71241) (#71350)Alicia Cozine2020-08-191-4/+4
| | | | | | * adds year-round link to AnsibleFest from the Ansible docs index page Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit ae3b8eec1277f1cb75f131314d1eedc9ea059820)
* [doc] Fix link to packet inventory files in 2.9 branch (#71206)Baptiste Mille-Mathias2020-08-171-2/+2
| | | fixes #71203
* [stable-2.9] Revert "Change default file permissions so they are not world ↵Sam Doran2020-08-121-75/+1
| | | | | readable (#70221) (#70825)" (#71232) This reverts commit 0199b1cf05e1838bc65ac26d99f2c5505c24ad0f.
* [stable-2.9] Change default file permissions so they are not world readable ↵Sam Doran2020-08-061-1/+75
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (#70221) (#70825) * [stable-2.9] Change default file permissions so they are not world readable (#70221) * Change default file permissions so they are not world readable CVE-2020-1736 Set the default permissions for files we create with atomic_move() to 0o0660. Track which files we create that did not exist and warn if the module supports 'mode' and it was not specified and the module did not call set_mode_if_different(). This allows the user to take action and specify a mode rather than using the defaults. A code audit is needed to find all instances of modules that call atomic_move() but do not call set_mode_if_different(). The findings need to be documented in a changelog since we are not warning. Warning in those instances would be frustrating to the user since they have no way to change the module code. - use a set for storing list of created files - just check the argument spac and params rather than using another property - improve the warning message to include the default permissions. (cherry picked from commit 5260527c4a71bfed99d803e687dd19619423b134) Co-authored-by: Sam Doran <sdoran@redhat.com> * Fix jboss test * Fix lamdba_policy test * Fix aws_lamdba test * Fix warning for new default permissions when mode is not specified (#70976) Follow up to #70221 Related to #67794 CVE-2020-1736 When set_mode_if_different() is called with mode of 'None', ensure we issue a warning about the change in default permissions. Add integration tests to ensure the warning works properly. * Fix tests - actually use custom module 🤦‍♂️ - verify file permission on created files - use remote_tmp_dir so we're ready for split controller - improve test module so we can skip the call to set_fs_attributes_if_different() - fix tests for CentOS 6 (cherry-picked from commit dc79528cc6) * Use new category in changelog fragments
* Warning banner should only show on `/devel/` docs, not on pages with 'devel' ↵Alicia Cozine2020-08-061-22/+26
| | | | | | | | | | | | | in their titles (#70849) (#71076) * banner should not be placed on pages with 'devel' in their titles * Update docs/docsite/_themes/sphinx_rtd_theme/ansible_banner.html * Only match paths at the beginning Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com> (cherry picked from commit 8313cc8fb1a6f879328b5178f790086a2ba580b2)
* [backport][2.9][PR #70446] Refactor Python API examples and docs (#70851)Sviatoslav Sydorenko2020-08-061-85/+3
| | | | | | | | | | | | | | | | | | | * Add boilerplate snippet into `examples/` It is a partial backport of #70224 (partially cherry picked from commit 4816bb4f43ee22f20fa7d75a79db659cc1cdeaf3) * Refactor Python API examples and docs PR #70446: it's a follow-up for #70445. It includes a merge of `examples/scripts/uptime.py` and a similar code snippet from `docs/docsite/rst/dev_guide/developing_api.rst`. This patch also changes the docs RST file to include contents of the example file instead of holding a copy of a similar code. (cherry picked from commit 20bb91509279ff91bf8410972827a95e1af55075)
* Fix the internal Python API usage examples (#70842)Sviatoslav Sydorenko2020-08-061-9/+13
| | | | | | | | | | | | | | Previous version initialized the `TaskQueueManager` after calling `Play.load()` while advertising a way to inject a custom library location path. This caused the tasks loader not to find any custom modules because it was triggered before the path was actually added to the module loader. This patch changes the order of the operations to ensure that the customized `context.CLIARGS` actually influences things. Resolves https://github.com/ansible/ansible/issues/69758. (cherry picked from commit 8d97c8c222d134cb1108310c5b22eb65ead2d2d3)
* Sanitize URI module keys with no_log values (#70762) (#70821)David Shrewsbury2020-08-061-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add sanitize_keys() to module_utils. * More robust tests * Revert 69653 change * Allow list or dict * fix pep8 * Sanitize lists within dict values * words * First pass at uri module * Fix insane sanity tests * fix integration tests * Add changelog * Remove unit test introduced in 69653 * Add ignore_keys param * Sanitize all-the-things * Ignore '_ansible*' keys * cleanup * Use module.no_log_values * Avoid deep recursion issues by using deferred removal structure. * Nit cleanups * Add doc blurb * spelling * ci_complete (cherry picked from commit bf98f031f3f5af31a2d78dc2f0a58fe92ebae0bb)
* Update Molecule support contact (#70797) (#70805)John R Barker2020-07-221-1/+1
| | | | | | | | As Molecule started to use https://github.com/ansible-community/molecule/discussions we need to update documentation before retiring the molecule-users mailing list. (cherry picked from commit b7ee07215d24430554a0b289c0811bd6a9ce9aad) Co-authored-by: Sorin Sbarnea <ssbarnea@users.noreply.github.com>
* [2.9] Docs: mention about Ansible workshops (#70378)Abhijeet Kasurde2020-07-021-1/+1
| | | | | | Lightbulb is deprecated in favor of https://ansible.github.io/workshops/. Update links accordingly. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit e4f48c920cd9501804f4e2e626a895c51509cdea)
* adds japanese translation as a version-switcher option (#70214) (#70217)Sandra McCann2020-06-221-1/+1
| | | | Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit 4a0f42923b4487cf480446f0dae09acb916d9970)
* Allow tasks to notify a fqcn handler name (#68213) (#70074)Sloane Hertel2020-06-171-0/+6
| | | | | | | | | | | | | | | * Allow tasks to notify a fqcn handler name * Add tests. Fixes #68181 * Add changelog fragment * Add test to ensure handlers are deduped properly with fqcn, role, and just handler names * Add some docs about new special vars (cherry picked from commit 087be1da5065f70bff89e1cff7af042d80ed0acc) Co-authored-by: Matt Martz <matt@sivel.net>
* Add platform guide for FRR (#69773) (#70067)Nilashish Chakraborty2020-06-163-1/+70
| | | | | | | | | | * Add platform guide for FRR * Add entry in index Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> (cherry picked from commit 5a7f2f9d5da9093cd524dc9011a32fdb3a5688b3) Add changelog
* [2.9] Update developing_modules_best_practices.rst (#69939)Abhijeet Kasurde2020-06-101-1/+1
| | | | | | | wrong module path for module_utils.basic in developing_modules_best_practices.rst (cherry picked from commit ff98ecc4d0413f7b51dfb5210534b2c5b2ebdce1) Co-authored-by: usatosi <usatosi@e-mail.jp>
* Explain module docs loss for devel (#68369) (#69546)Sandra McCann2020-05-181-1/+1
| | | (cherry picked from commit 0d379d4205ea609e7718527be5512fbb16ba63be)
* [2.9] Docs: point inventory script to respective versionAbhijeet Kasurde2020-05-051-9/+9
| | | | | | | With collections migration, inventory scripts are moved from devel (2.10). Point docs for inventory script to their respective version. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* Mention acme_certificate behavior changes in porting guide caused by a ↵Felix Fontein2020-05-051-0/+1
| | | | bugfix and previously incorrect examples. (#69167)
* [2.9] CVE-2020-1746 - Remove the params module option from ldap_attr and ↵Sloane Hertel2020-04-143-1/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | ldap_entry (#68714) * Remove the params module option from ldap_attr and ldap_entry Module options that circumvent Ansible's option handling were disallowed in: https://meetbot.fedoraproject.org/ansible-meeting/2017-09-28/ansible_dev_meeting.2017-09-28-15.00.log.html Additionally, this particular usage can be insecure if bind_pw is set this way as the password could end up in a logfile or displayed on stdout. Fixes CVE-2020-1746 (cherry picked from commit 0ff609f1bc5e391fa25710b9a0baaf669f347eb1) * Fix formatting for option names Co-Authored-By: Felix Fontein <felix@fontein.de> * Fix fail_json * fix indentation error Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de>
* [2.9] docs: Fixed "Edit on GitHub" link for plugin, cliAbhijeet Kasurde2020-04-143-0/+8
| | | | | | | | Fixed sphinx theme to navigate "Edit on Github" link to locate correct plugin, cli source in GitHub repo. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 2728c2476e27f5e84ec05060a7f5e9cd6ebd43ab)
* Add Kubernetes Working Group to Communicating guide. (#68501)Jeff Geerling2020-04-031-0/+1
|
* Allow no_log=False to silence the no_log warnings for module parameters ↵kaorihinata2020-02-242-2/+6
| | | | | | | | | | | | | | | | | | | | (#64733) (#67439) As AnsibleModule._log_invocation is currently implemented, any parameter with a name that matches PASSWORD_MATCH triggers the no_log warning as a precaution against parameters that may contain sensitive data, but have not been marked as sensitive by the module author. This patch would allow module authors to explicitly mark the aforementioned parameters as not sensitive thereby bypassing an erroneous warning message, while still catching parameters which have not been marked at all by the author. Adds tests for various no_log states including True, False, and None (as extracted by AnsibleModule._log_invocation) when applied to an argument with a name that matches PASSWORD_MATCH. Fixes: #49465 #64656 (cherry picked from commit 3ca4580cb4e2a24597c6c5108bf76bbcd48069f8)
* Backport of 67645 docs/docsite/rst/: fix typos (#67649)Andrew Klychkov2020-02-248-9/+9
|
* [2.9] Backport /docs/docsite/rst: fix typos (#67650)Andrew Klychkov2020-02-244-4/+4
| | | | | | | | | | | | | | * user_guide/intro_adhoc.rst: fix typo (#67644) (cherry picked from commit 05a3192eb77efe7ae9f6a5de5445de7f5057d9c1) * dev_guide/developing_modules_best_practices.rst: fix typo (#67639) (cherry picked from commit 244277adddfadc1fe5ef1cc34cab6b6857d95267) * /docs/docsite/rst/dev_guide: fix typos (#67643) (cherry picked from commit 907c98ebcd7a08fab4090c5ba188f6ed884aa56d)
* [stable-2.9] Update example requirements file docs (#67626) (#67714)Sam Doran2020-02-242-16/+16
| | | | | | | | | | Use "name" when possible rather than "src" to make the examples of roles and collections in a single requirements files more coherenant. Fundamentally, roles and collections are completely different. But we can make the requiremets file easier to read by unifying the format as much as possible. (cherry picked from commit 6c70959131) Co-authored-by: Sam Doran <sdoran@redhat.com>
* Specify lowercase only for Galaxy namespaces (#67485) (#67503)Sandra McCann2020-02-171-1/+1
| | | | | | * specify lowercase only for galaxy namespaces * doh... include meta file (cherry picked from commit a60feeb3c1e5a6a6c96bee49bec98f0a5f5b7ca8)
* [backport][2.9]Add note that devel branch should not be used in real ↵Sandra McCann2020-02-171-8/+9
| | | | | | | environments (#… (#67494) * Add note that devel branch should not be used in real environments (#67483) (cherry picked from commit 39fef58beaca3510ec4465f74071c736578ccbf1)
* Clarify b64encode with Python 2 (#67488) (#67491)Jordan Borean2020-02-171-2/+5
| | | (cherry picked from commit 423a900791d2cd2494a3407e4cfba62623e758cf)
* Docs: improve anchors vs. header bar (#67244) (#67317)Felix Fontein2020-02-112-15/+22
| | | (cherry picked from commit fd43619f1a47be784a016431346531ad7d2dd71c)
* add info on creating doc fragments in a collection (#67171) (#67279)Sandra McCann2020-02-102-0/+24
| | | | | | * add info on creating doc fragments in a collection Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit 4dd2513371800c649eeb45ea0bd819ac3ebd153b)
View Lorry Controller Status