15 Commits (1895b7ab5e909e86a172eb64835fc6b754e68287)

Author	SHA1	Message	Date
Sandra McCann	8d2b25d490	Docs backportapalooza 4 (#70875) ... * Pipe lookup plugin usage example documentation fix (#70679) (cherry picked from commit 58d24584c0) * 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> (cherry picked from commit 633c2d0522) * Fix incorrect statement to set a variable for a playbook (#70712) Fixes #70638 (cherry picked from commit 59513ae673) * Make Sources, Plugins sections easier to read (#70652) Re-wrote the Inventory Sources section and also the next section to have shorter, clearer sentences with a more active voice. (cherry picked from commit fb3db170cc) * fix rstcheck problem and gitignore collections dir (#70764) (cherry picked from commit 24e5d3a51c) * add note for write permission on rst files (#70766) * add note for write permission on rst files * Update docs/docsite/rst/community/documentation_contributions.rst Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> (cherry picked from commit 2a7df5e07b) * Modification of 'Adding modules and plugins locally' topic (#70659) * Remediated the topic to comply with IBM style guide and minimalism practices Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit 1733253297) * WIP: add collections as an intersphinx link (#70826) * adds collections as a ref for intersphinx * no need for intersphinx Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit b28d59124b) * 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> (cherry picked from commit 7a42d27462) * Few fixes for reference_appendices/faq.html (#70719) * Format using `` instead of `, add line breaks for long lines, rephrase or remove useless text. Move some text. * Add clearer version of OpenSSh is affected by SCP bug * Review some pages using ansible doc writing guide. (cherry picked from commit 92e16c2838) Co-authored-by: Roman Gorshunov <34521622+gorshunovr@users.noreply.github.com> Co-authored-by: David Rieger <david@isan.engineer> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Stef B <regendo@users.noreply.github.com> Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Fixmetal <fixmetal@gmail.com>	4 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>	4 years ago
Sayed Anisul Hoque	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
CsilLAB	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
tacatac	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
Matt Martz	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
Andrew Greenwood	48c7501768	Add vault version 1.2 details (#50958) ... Adding some details on the version 1.2 vault format assists in understanding how labelled vault-id works. +label: docsite_pr	6 years ago
Derrick Johnson	62d3ed0e2f	ACI Private_Key String to Allow for Vaulting (#54251) ... * Allows the use of Private_Keys to be entered as a string instead of just a file. Making it possible to use VAULT to encrypt the key * Fixed Issues auto check found * Provide helpful information while avoiding credential exposure * Restore original variable name :-) * Fix a few other things * Influence the default certificate_name in both cases * Update documentation * Add contributed docs * Fix CI issue	6 years ago
Richlv	4c1476932e	add warnings for the stding usage examples (#51859) ... * Add a warning about vault leaving secrets in the shell history. * Add a warning about accidental newlines in vault encrypted strings. +label: docsite_pr	6 years ago
Ed Costello	0e467be0f1	Update vault docs for client scripts, multiple keys and misc (#43993) ... * Fix and update vault docs, add and clarify examples and options, introduce the concept of labeling a vault for clarity even if only a single password is in use for a given run, rework multi-password section to align to these concepts. * Document -client scripts for ansible vault. Co-Authored-By: orthanc <orthanc@users.noreply.github.com>	6 years ago
Keith Maxwell	7fbacf920d	Remove misleading statement passwords must be same (#49798) ... * Remove misleading statement passwords must be same Since 2.4 Ansible has supported multiple vault passwords: <https://docs.ansible.com/ansible/latest/user_guide/vault.html#multiple-vault-passwords> Meaning lines like the following are misleading: > The password used with vault currently must be the same for all files you wish > to use together at the same time. -- `docs/docsite/rst/user_guide/vault.rst` To demonstrate this with Ansible 2.7, save the following as `example.yaml`: ``` - name: Display output from two vaults with different passwords hosts: localhost connection: local vars_files: [one.yaml, two.yaml] tasks: - name: View secret from one.yaml vault debug: { var: one } - name: View secret from two.yaml vault debug: { var: two } ``` Then run the three following commands choosing two different passwords: ``` $ echo 'one: 1' | ansible-vault encrypt --vault-id id1@prompt --output=one.yaml $ echo 'two: 2' | ansible-vault encrypt --vault-id id2@prompt --output=two.yaml $ ansible-playbook --vault-id id1@prompt --vault-id id2@prompt example.yaml ``` `ansible-vault` stores an ID in plain text in the vault file. * Remove note about default in Ansible 2.1 As requested by gundalow in https://github.com/ansible/ansible/pull/49798	6 years ago
Brendan Jurd	ab96bbdef9	Clean up Vault docs in User Guide. (#46188) ... * Fix spelling of 'separate' throughout. * Various cleanups in the User Guide for Vault. - Fix spelling of 'algorithm' - Fix indentation of nested list in payload format - Fix mysterious refernce to 'b_pkey1'. - Fix reference to newline as '\n': the backslash is lost when rendered to the docs website. Specify the hex value for newline instead of the backslash escape. * Fix formatting * Update vault.rst	6 years ago
Toshio Kuratomi	9faf7b949e	Fix places in docs that refer to modules without namespace ... We've namespaced all plugin docs. Change the docs to reflect that	7 years ago
Matt Lee	75ab070c63	Update vault.rst (#36328) ... hunter2 not hunter42. http://bash.org/?244321	7 years ago
scottb	373b1dcf59	Core Docs Refactor and Redesign (#36067) ... * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable	7 years ago