Commit graph

47 commits

Author SHA1 Message Date
sgpinkus
2abb2d3f17
Update playbooks_variables.rst. To say you can define variables within a playbook is somewhat misleading. Variables are defined within plays and are only visible within the play they are defined in *not* the entire playbook. There is no way to define vars to have strictly playbook scope. ()
+label: docsite_pr
2021-03-25 16:05:50 -04:00
Ronald Eddy Jr
d18901dd4a
Update HTTP -> HTTPS ()
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
2020-10-19 15:57:20 -04:00
Jorge Vallecillo
94522b7c10
Fix typos () 2020-09-28 14:33:24 -04:00
Andrew Klychkov
c19af92be6
Docsite: improve user_guide/playbooks_variables ()
* Docsite: improve user_guide/playbooks_variables
2020-09-25 09:48:33 -05:00
Sandra McCann
bcfead8e0f change duplicated label 2020-09-21 12:32:11 -07:00
Andrew Klychkov
7bfeed3e24
Docsite: replace Latin phrases to English ()
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
2020-09-03 14:47:57 -05:00
Alicia Cozine
02ea80f6d7
tidies up vars page () 2020-08-18 14:01:03 -04:00
Sayee
4d68efbe24
Writing style updates to Using Variables topic ()
* updated topic title, underline length for headings, and incorporated peer feedback
2020-08-18 11:25:33 -05:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 () 2020-07-14 17:00:44 -04:00
Alicia Cozine
851e8e18b2
clarifies that vars can begin with _, with a warning ()
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>
2020-06-11 14:16:41 -04:00
Pilou
59f2174c8b
Doc: playbook keywords are reserved names too () 2020-05-28 10:32:28 -05:00
Alicia Cozine
6fffb0607b WIP: Docs: User guide overhaul, part 4 ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-05-15 16:18:07 -04:00
Lukas Pirl
34db57a47f
introduce fact "ansible_processor_nproc": number of usable vcpus ()
This fact reflects the number of usable vcpus (which might be different
from ansible_processor_vcpus, e.g., in containers with limits). See
also .

* Add fixture data and update unit tests

Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-05-15 09:38:56 -04:00
Kenyon Ralph
a681810b2f
doc: variable precedence: "override", not "overwrite" () 2020-04-09 11:55:53 -04:00
Alex Humphreys
01a6e1c2c9
Mention role defaults file ()
Add info on where role defaults are set; matches the entry for role variables.
2020-02-11 11:50:16 -06:00
Mossroy
c3c1708dea Fix variable name in an example ()
Makes the variable name consistent between the example code (`myname`) and the text below (mentioning a variable called `name`) in the docs.
2019-12-12 16:51:47 -06:00
林博仁(Buo-ren Lin)
8ebc57c186 Mention that Python keywords are invalid Ansible variable names ()
* Mention that Python keywords are invalid Ansible variable names
Using a Python keyword as a variable name triggers the error `Invalid variable name in 'register' specified: 'return'`.
2019-12-02 09:42:40 -06:00
Marek Czernek
18f4f0549f Correct a typo () 2019-10-28 15:01:10 -05:00
Andreas Olsson
c8315bfd60 Prefer https:// links in the docs site ()
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
2019-09-30 15:11:19 -04:00
Brian Coca
c2469648e4 Docs on general precedence ()
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-07-09 12:14:40 -05:00
Gavin Kyte
a722021207 Change un-ordered list to ordered ()
Makes sense to make implied order explicit with an ordered list
2019-02-13 09:21:08 -06:00
James Cassell
953058d025 standardize connection variable names ()
* standardize user/password connection vars

* docs: use ansible_user and ansible_password

* docs: var precedence for connection vars

* docs: ansible_become_pass -> ansible_become_password etc
2019-02-11 10:43:10 -05:00
Brian Coca
119b65f919
Clarify clear facts ()
* Revert "avoid x2 setting of set_fact when 'cacheable' ()"

This reverts commit 207848f354.

* clarify clear_facts with set_fact cacheable

 revert previous 'fix' as it will break playbooks by changing precedence
 opted to leave current behaviour but document it on both plugins to mitigate confusion

 fixes 

 also fix grammer, add comment, remove unused e
2019-01-15 15:20:33 -05:00
Brian Coca
207848f354 avoid x2 setting of set_fact when 'cacheable' ()
* avoid x2 setting of set_fact when 'cacheable'

  fixes 

* ammend docs to new behaviour

* added period
2019-01-08 10:12:49 -05:00
Jeffrey Reeves
1e647db8dc Redacted IP addresses under SSH_CLIENT & SSH_CONNECTION () 2018-12-17 09:01:53 -06:00
Matt Martz
67ce743cc9 Remove erroneous extra-vars example, and a few really old versionadded indicators. Fixes () 2018-12-14 17:09:25 -06:00
Brian Coca
8461321a6a clarify registered vs facts ()
* clarify registered vs facts

fixes 

* wordsmithing
2018-11-29 15:00:36 -05:00
Alicia Cozine
7db63851e0 Updates variables docs: facts examples, headers, links, etc. ()
* refreshes ansible facts output and updates some references/headers
2018-10-30 11:37:34 -04:00
Brian Coca
44510448b0 prefer ansible_facts namespace and dict notation ()
* prefer ansible_facts namespace and dict notation

* fixed mistranslation
2018-09-06 10:26:58 -05:00
Sandra McCann
fe119c18ef fixed formatting ()
(cherry picked from commit 58ca82fa1c)
2018-09-04 09:33:01 -05:00
James Polley
7988266bb7 Improve clarity of precedence when command-line parameters are used. ()
* Improve clarity of precedence when command-line parameters are used.

* Add command-line values into the precedence list.
* Several sample config snippets were included without any explanation
  of how those snippets would be processed. Added descriptions so that
  the reader can understand what each snippet will (or won't) accomplish.

* Don't focus on inventory as much

Expand on the fact that it's the fact that a variable is set that
matters, not the source of the variable.
2018-08-31 09:56:58 -04:00
Brian Coca
3f657ca28f clarify priority setting ()
* clarify priority setting

* updated as per fb
2018-08-31 09:20:26 -04:00
Brian Coca
93f5c10714 vars list ()
* vars list

(cherry picked from commit 463b85cf0bcf7a557b857d1ebd3e8bf1b693fa4c)

* updated as per fb
2018-08-27 14:57:32 -05:00
Pilou
af786cb9d7 Fix a typo in docs: s/patent/parent/ () 2018-08-22 23:05:42 +02:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Brian Coca
18aa87803f remove dupe entries 2018-07-19 12:16:33 -04:00
Jacob Floyd
4fa2fb9c89 Docs fix: ansible_group_priority defaults to 1
The docs committed in  were inconsistent.
This clarifies that the default `ansible_group_priority` is `1`.[1][2]

[1] https://github.com/ansible/ansible/blob/153c9bd/lib/ansible/inventory/group.py#L40
[2] https://github.com/ansible/ansible/blob/153c9bd/lib/ansible/cli/inventory.py#L236
2018-06-05 20:31:10 -04:00
Martin Kimmerle
294c3a0a7c [docs][minor] Variables user guide: fix grammar () 2018-05-24 23:38:22 -04:00
Sam Doran
59e541e31a
Change behavior to behaviour in docs and tests ()
* Change behavior to behaviour

- use existing fact to get hash setting rather than shell task
- fix code highlighting syntax in playbooks_variables.rst

* Re-wrote intro section; this entire topic needs a clean-up/rewrite.
2018-05-17 14:07:12 -04:00
Cameron
854be6ef16 docs: fix 'ipmi' typo () 2018-05-08 09:15:56 +02:00
Anna Liao
c812396793 Update playbooks_variables.rst ()
<!--- Your description here -->

+label: docsite_pr
2018-05-01 23:02:32 -07:00
Martin Krizek
5297eac46d
playbooks_variables.rst: fix facts code-block () 2018-04-11 20:46:27 +02:00
Brian Coca
c62551c1b0 Update role doc examples ()
* fix role examples

- also fixed issue with overload of 'name', fixes 
- attempted to clarify tag inheritance/application

* Typo fix
2018-04-05 11:41:25 -07:00
Brian Coca
5ad13d66aa documented actual precedence ()
fixes 
2018-04-05 11:09:11 -07:00
Brian Coca
40a55e9f55 update vars info ()
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
2018-03-22 00:02:45 -07:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza ()
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
scottb
373b1dcf59
Core Docs Refactor and Redesign ()
* 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
2018-02-13 07:23:55 -08:00
Renamed from docs/docsite/rst/playbooks_variables.rst (Browse further)