Commit Graph

702 Commits (cad892125c2b51ed8e60e14277531d12c2038fe0)

Author SHA1 Message Date
Sandra McCann e03069a444
[docs][backport] Docs backports week 4-18-22 (#77557)
* Update reporting_bugs_and_features.rst (#77518)

(cherry picked from commit fa7c5d9b10)

* docs: Add porting guide for Ansible 6.0.0a1 (#77526)

(cherry picked from commit 0d9a580f24)

* Steering Committee: add new member (#77529)

(cherry picked from commit 553a226da5)

* Update pip example with standard lowercase http[s]_proxy env vars (#77515)

(cherry picked from commit 2ba39fcf8c)

* Update docs to recommend the TTY for prompts over stderr (#77533)

(cherry picked from commit 789d29e895)

* update python devel docs (#77499)

* update python devel docs

Co-authored-by: Sandra McCann <samccann@redhat.com>
(cherry picked from commit 2fc73a9dc3)

* setup: remove 'any' as seemingly valid option (#77532)

fixes #59783

(cherry picked from commit 762d97f1b8)

* Update developing_collections_shared.rst (#77497)

##### SUMMARY
Use of the meta/runtime.yml file to specify the ansible-core version for collections

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

(cherry picked from commit eef0a1cef9)

* Update developing_collections_structure.rst (#77496)

(cherry picked from commit 538a19b748)

* Fix a broken link and some grammatical errors (#77531)

(cherry picked from commit 0c1cb0e9d4)

* Add contributor path page (#77494)

Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
(cherry picked from commit 3b0d74c145)

Co-authored-by: Iheanacho Amarachi Sharon <58210919+Iheanacho-ai@users.noreply.github.com>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Co-authored-by: Junegunn Choi <junegunn.c@gmail.com>
Co-authored-by: Matt Martz <matt@sivel.net>
Co-authored-by: Brian Coca <bcoca@users.noreply.github.com>
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
Co-authored-by: Kajsa Gauza <nimrod7@gmail.com>
4 years ago
Sandra McCann c4901aa08f
[docs][backport] 0407 weekly docs backports (#77490)
* INI: values with spaces can be single or double quoted (#77369)

(cherry picked from commit ac56647f4a)

* community_steering_committee.rst: add chairperson (#77454)

(cherry picked from commit 82c622a26a)

* Document how to release a collection  (#77391)

Co-authored-by: Divine Odazie <dodazie@gmail.com>
(cherry picked from commit 26631de88c)

* docs: Update porting guide for ansible 5.6.0 (#77466)

(cherry picked from commit 36371500b7)

* Trivial (#77467)

Co-authored-by: Iheanacho Amarachi Sharon  <58210919+Iheanacho-ai@users.noreply.github.com>
(cherry picked from commit e8dbc84afe)

* Update installing_collections_file.rst (#77439)

(cherry picked from commit 6da4186f6e)

* template module: document jinja2_native behavior (#77445)

(cherry picked from commit a85261342a)

* avoid recursion in example (#77436)

(cherry picked from commit d7d2afd203)

* Clarifying how handlers are handled (#77372)

(cherry picked from commit 7126bfc61c)

Co-authored-by: Dr. András Korn <korn-github.com@elan.rulez.org>
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Travis Michette <tmichett@redhat.com>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
Co-authored-by: Brian Coca <bcoca@users.noreply.github.com>
4 years ago
Sandra McCann 6b6b324618
[docs][backport][2.13] Backportapalooza 3-31 (#77438)
* add links.yml to collection structure docs (#77415)

* add links.yml to collection structure docs
* fix link
* Update docs/docsite/rst/dev_guide/developing_collections_structure.rst

(cherry picked from commit 8caa6efaab)

* Example is a single play, not a playbook

(cherry picked from commit bf8e186c68)

* Fix list formatting (#77354)

(cherry picked from commit e918cfa588)

* Most Matrix channels are ansible.com and not .im (#77352)

(cherry picked from commit 6557a60d08)

* Docs cheatsheet - skeleton and ansible-playbook (#76655)

(cherry picked from commit 21addac5da)

Co-authored-by: rwhector <richard@walnut.gen.nz>
Co-authored-by: Christian Adamini <christian.adamini@invision.de>
Co-authored-by: bluikko <14869000+bluikko@users.noreply.github.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Sandra McCann f03624e295
clarify how to customize ansible cli output (#77357) 4 years ago
bluikko 27aa2612d9
Add what to look for in PyYAML documentation (#77323)
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
4 years ago
Stef B 8a86fa602d
Simplify documentation for search paths (#73818) 4 years ago
Tommaso Macchioni 14098d9b04
typo variable reference (#77327) 4 years ago
ee-github c555ce1bd9
Update intro_patterns.rst (#77300)
Describe difference between targeting a single host using -i vs. --limit.  In particular, pointing out the behavior difference that -i will not rad inventory variables.
4 years ago
Sandra McCann dfda04894f
stub out ipaddr page and point to new home (#77281) 4 years ago
Jasmine Hegman b60a5eefb2
Include links to the modern homes of the windows modules (#77220) 4 years ago
Sandra McCann 7d234a40ee
Point to AH docs (#77200) 4 years ago
Martin Nečas 0d4219f265
Fix IPs for ipaddr filter in user_guide (#77151)
* Fix IPs for ipaddr filter in user_guide

* Apply suggestions from code review

Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Sloane Hertel c3999d89f4
Clarify docs for using tests as filters (#77155) 4 years ago
Sandra McCann 22ba18d7b0
add links to remote_user docs (#77140)
* add links to remote_user docs
* shorten link name
4 years ago
Matt Clay 3f0d5bc351 Fix LooseVersion and StrictVersion refs in docs. 4 years ago
Brian Coca 84b85a5b5a
more explicit moustache docs (#77051) 4 years ago
fbourqui 1480503326
Update complex_data_manipulation example uptime in days/h/m/s (#77019) 4 years ago
Preston Carman f82b1ba67c
Update indentation for example in playbooks_handlers.rst (#75348) 4 years ago
Sandra McCann 32f7490a2c
Add note to serial docs (#77006)
* add note to serial docs
* add keyword directly
Fixes #76820
(cherry picked from commit de20f1bae8)
4 years ago
zasca 8939f4d2f7
add tasks (#75489) 4 years ago
Sloane Hertel 43e55db208
ansible-galaxy - add signature verification of the MANIFEST.json (#76681)
* ansible-galaxy collection install|verify:

  - Support verifying the origin of the MANIFEST.json when the Galaxy server has provided signatures.
  - Allow supplemental signatures to use during verification on the CLI/requirements file.

* ansible-galaxy collection install:

  - Support disabling signature verification. This silences the warning provided by ansible-galaxy if the Galaxy server provided signatures it cannot use because no keyring is configured.
  - Store Galaxy server metadata alongside installed collections for provenance. This is used by 'ansible-galaxy collection verify --offline'.

* Add unit tests for method that gets signatures from a Galaxy server

* Add integration tests for user-provided signature sources

- Test CLI option combinations
- Test installing collections with valid/invalid signature sources
- Test disabling GPG verification when installing collections
- Test verifying collections with valid/invalid signature sources

* Make signature verification advisory-by-default if signatures are provided by the Galaxy server

- Make the default keyring None
- Warn if the keyring is None but the Galaxy server provided signatures
- Error if the keyring is None but the user supplied signatures
- Error if the keyring is not None but is invalid

* changelog

* add ansible-galaxy user documentation for new options

Co-authored-by: Matt Martz <matt@sivel.net>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Andy Mott <amott@redhat.com>
Co-authored-by: John R Barker <john@johnrbarker.com>
4 years ago
IronTooch 65987e86a9
Added package reference for Debian to resolve error (#76876) 4 years ago
Vladimir Botka 5448661aec
Update 'Ansible and BSD' section 'Setting the Python interpreter'. (#76825) 4 years ago
ChunPanYung 0ca19a5b73
Update windows_winrm.rst (#76835)
Co-authored-by: Jordan Borean <jborean93@gmail.com>
4 years ago
Stephen Lawrence 2bd074b486
doc: fix Jinja2 doc link templating playbook (#76889)
Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
4 years ago
Sandra McCann a5283d67ee
add quoted examples (#76858) 4 years ago
Syed Ali Haider 6bca0a5dc2
docs: add fqcn to module examples (#73546)
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
darran-c fdf12542b2
Fix typo in task name (#76642) 4 years ago
Alicia Cozine 67e5649a26
Adds documentation about when/why to use roles (#76560)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
4 years ago
Jordan Borean 7dd22b8b4b
Update Windows host requirements (#76582) 4 years ago
Simon Monai 5db1d11c19
Replace "Encrypt" with "Hash" for prompt documentation (#76584)
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
4 years ago
Jon "The Nice Guy" Spriggs 47e2a26959
Update playbook_tests with type testing (#72732) 4 years ago
Jacob McGill ee777567bc
Update intro_inventory.rst (#76340) 4 years ago
Benoît Geeraerts 8a562ea14a
Resolves #76449 Misplaced added version info (#76539)
`.. versionadded::` are coming right after the section tittle, and was misplaced here
4 years ago
Sloane Hertel 5b2334983c
Fix more 'playbook'/'play' conflation (#76387) 4 years ago
azrdev fd4460c1e4
docs/best_practices: all contained vault passwords required when using inventory (#75976) 4 years ago
Aine Riordan 90de24da7b
Docs: Link to valid data types for role parameters (#76276) 4 years ago
Daniel Goldman be2bd2f1af
Documentation for other types in collection `requirements.yml` (#75872) 4 years ago
Vicente Jimenez Aguilar a1236a582c
Stop using "checksumming" instead of "encrypting" in the docs (#76168)
* Hashing is not encrypting

All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition

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

Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Paul e84d660140
Update playbooks_tests.rst (#76047) 4 years ago
Brian Coca ff792d252e
Docs: dash - character invalid in playbook names in collections(#75891)
* collection playbooks, note no -
fixes #75890
4 years ago
fermin 9eeaf1c5b5
Docs - add code-block:: wrapping for playbooks filter doc (#75953)
* Add code-block
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Chris Hepner 67c12fc4eb
Docs - Fix "kubernetes.core" typos in code snippets (#75930)
Replace "kuberernetes.core" with "kubernetes.core" in filter examples.
4 years ago
Abhijeet Kasurde 1ea74f4dd6
Misc typo fix (#76008)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Miroslav Brabenec fa4a92f221
Docs: Add code-block:: to examples in ipaddr filters doc(#75951)
* Add code-block elements to playbooks_filters_ipaddr
* Add punctuation to lead-in sentences for code blocks
4 years ago
marie 2a3aa66fbd
docs - wrap examples in code-block:: in sample setup (#75964)
* docs: Use code-block to format code in sample setup
Fixes #75905
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Tim Pogue 4444692436
Docs: add code-block:: to playbook variables doc in user guide(#75985)
* update code-block formatting changes.
4 years ago
Midhun R Nair 6bf65f6246
Docs - Added code-block:: wrappers in playbook tests doc (#75952) 4 years ago
Matěj G 6319a0f415
docs - Wrap examples in code-block:: in loops guide (#75916)
* docs - Use code-block to format examples in loops guide
Resolves #75900
4 years ago
Matěj G d6dbc1a26f
docs - Change :: to code-block:: in error handling guide (#75978)
Fixes #75908
4 years ago