Commit graph

129 commits

Author SHA1 Message Date
Toshio Kuratomi
cef08640a4 [stable-2.7] Add an example to serial usage ()
(cherry picked from commit b759862daa)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2018-11-14 17:13:20 -08:00
Sandra McCann
093ab2170d fix toc issue () 2018-11-13 13:57:29 -06:00
Abhijeet Kasurde
709845436e Update plugin filter documentation ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 6d36849f72)
2018-11-12 19:25:01 -08:00
Alicia Cozine
dfdc7ec90c Updates variables docs: facts examples, headers, links, etc. ()
* refreshes ansible facts output and updates some references/headers

(cherry picked from commit 7db63851e0)
2018-11-05 15:10:52 -08:00
Andrea Perotti
af18d3c451 Updates intro to dynamic inventory page ()
* Added Foreman to the list of inventory scripts
(cherry picked from commit 8bc4a18500)
2018-11-05 15:10:52 -08:00
Deric Crago
58cd460952 moved 'strftime' filter into 'Other Useful Filters' section ()
(cherry picked from commit 065b7ac300)
2018-11-05 15:10:52 -08:00
Sandra McCann
3438429e22 WIP: fix build errors due to missing certified_supported label ()
* fix build errors due to missing certified_supported label

* fixed references and toc

(cherry picked from commit db3d920cfd)
2018-11-05 15:09:42 -08:00
zharalim
3a02228b00 Clean playbook filters doc by adding whitespaces
(cherry picked from commit 1e23c79d18)
2018-10-15 09:58:33 -07:00
Sandra McCann
6e86b317a9 Clean up Vault docs in User Guide. () ()
- Fix spelling of 'separate' and '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.

(cherry picked from commit ab96bbdef9)
2018-09-28 10:42:46 -05:00
Sandra McCann
ceb474bb9e [WIP] Backport/2.7/batch port ()
Batch of docs backports:

* docs: Clarify include_task v import_tasks with conditionals ()
(cherry picked from commit 6be42a2a0e)

* Add single quotes around package name ()
(cherry picked from commit 0d81386144)

* prefer ansible_facts namespace and dict notation ()
(cherry picked from commit 44510448b0)

* fix cherrypick conflict - scenario_guides

* Update implicit_localhost.rst ()
(cherry picked from commit f68cd1acc6)

* updated fbsd install instructions ()
(cherry picked from commit e9c2695ce7)

* Change "Defaulting Undefined Variables" ()
(cherry picked from commit e35c4be1c1)

* adds license details to dev guide pages ()
(cherry picked from commit 6e68d77f6d)

* FAQ: fix a typo, add link to 'vars' lookup ()
(cherry picked from commit 95649dc793)

* Fix link and toctree ()
(cherry picked from commit 6999bf318f)

* Improve the local toctree (and title) ()
(cherry picked from commit afea00fa9f)

* Add undocumented configuration parameter and explain in porting guide ()
(cherry picked from commit a892a6ef03)

* Simplify PPA installation for Ubuntu ()
(cherry picked from commit 78e9f452a5)

* adding git+ssh uri scheme ()
(cherry picked from commit 84a4257774)

* Add workaround for non-standard kerberos environments ()
(cherry picked from commit 4e532e0ad9)

* Restore license agreement ()
(cherry picked from commit f430f60541)

* partial cherry-pick - lenovo doc update PR 45483
2018-09-19 22:02:01 -05:00
Sandra McCann
0a7d5ebd73 fixed formatting () ()
(cherry picked from commit 58ca82fa1c)
(cherry picked from commit fe119c18ef)
2018-09-04 11:41:17 -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
Sandra McCann
cccf5e6e77 fixed grammar and spelling issues ()
* fixed grammar and spelling issues

* fixed autocorrect mistake and sanity test errors
2018-08-31 08:44:31 -05:00
Brian Coca
3f657ca28f clarify priority setting ()
* clarify priority setting

* updated as per fb
2018-08-31 09:20:26 -04:00
Ritesh Puj
ff654ccfe8 replaced 'ansible_os_platform' to 'ansible_os_family' ()
replaced 'ansible_os_platform' to 'ansible_os_family' as 'ansible_os_platform' variable is no longer available.
2018-08-30 15:02:39 -05:00
pierremahot
d11e078366 adding an option for the filter ipsubnet and testing ()
* adding an option for the filter ipsubnet
2018-08-30 13:21:22 +01:00
Greg Chavez
a5b02d6c7c "encountered" is an adj. here, need vb. "are" ()
<!--- Your description here -->

+label: docsite_pr
2018-08-29 09:14:09 -05:00
Brian Coca
86037bc840
improved block docs ()
* improved block docs

 - broke down examples per keyword
 - clarified which errors are handled
 - clarified forcing error in rescue
2018-08-28 13:40:12 -04:00
Yuma Inaura (稲浦悠馬)
2655fd2cbd Update playbooks_conditionals.rst ()
+label: docsite_pr
2018-08-27 18:33:49 -05: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
Matthias Fuchs
7871027c9d Share the implementation of hashing for both vars_prompt and password_hash ()
* Share the implementation of hashing for both vars_prompt and password_hash.
* vars_prompt with encrypt does not require passlib for the algorithms
  supported by crypt.
* Additional checks ensure that there is always a result.
  This works around issues in the crypt.crypt python function that returns
  None for algorithms it does not know.
  Some modules (like user module) interprets None as no password at all,
  which is misleading.
* The password_hash filter supports all parameters of passlib.
  This allows users to provide a rounds parameter, fixing .
* password_hash is not restricted to the subset provided by crypt.crypt,
  fixing one half of .
* Updated documentation fixes other half of .
* password_hash does not hard-code the salt-length, which fixes bcrypt
  in connection with passlib.
  bcrypt requires a salt with length 22, which fixes 
* Salts are only generated by ansible when using crypt.crypt.
  Otherwise passlib generates them.
* Avoids deprecated functionality of passlib with newer library versions.
* When no rounds are specified for sha256/sha256_crypt and sha512/sha512_crypt
  always uses the default values used by crypt, i.e. 5000 rounds.
  Before when installed passlibs' defaults were used.
  passlib changes its defaults with newer library versions, leading to non
  idempotent behavior.

  NOTE: This will lead to the recalculation of existing hashes generated
        with passlib and without a rounds parameter.
        Yet henceforth the hashes will remain the same.
        No matter the installed passlib version.
        Making these hashes idempotent.

Fixes 
Fixes 
Fixes  except bcrypt still uses 2a, instead of the suggested 2b.

* random_salt is solely handled by encrypt.py.
  There is no _random_salt function there anymore.
  Also the test moved to test_encrypt.py.
* Uses pytest.skip when passlib is not available, instead of a silent return.
* More checks are executed when passlib is not available.

* Moves tests that require passlib into their own test-function.

* Uses the six library to reraise the exception.

* Fixes integration test.

When no rounds are provided the defaults of crypt are used.
In that case the rounds are not part of the resulting MCF output.
2018-08-27 08:40:41 -07:00
skylerbunny
d4e15d40e8 Update tags documentation to explain newer tags behavior () 2018-08-23 09:46:54 -04:00
Ryan Brown
4c8808ec9d
Extend module_defaults by adding default groups for cloud modules ()
Extends `module_defaults` by adding a prefix to defaults `group/` which denotes a builtin list of modules. Initial groups are: `group/aws`, `group/azure`, and `group/gcp`
2018-08-22 21:33:27 -04:00
Pilou
af786cb9d7 Fix a typo in docs: s/patent/parent/ () 2018-08-22 23:05:42 +02:00
♫ Christian Krause ♫
d779eb1f15 doc: fixes the the repetitions ()
Wow, this does not seem to be an uncommon misspelling. Might be there
are some left that span over two lines. I noticed the one in the git
module and then used `grep -rw 'the the'` to find some more.
2018-08-22 21:53:30 +02:00
pcahyna
8dc31a88e8 Describe subset and superset as "set theory tests" ()
subset and superset do not belong to group theory but to set theory.

+label: docsite_pr
2018-08-22 15:22:10 -04:00
flawaetz
1682ce5263 Update playbooks_blocks.rst ()
Blocks currently don't support loops such as with_items or sequence.  It would be helpful to make this clear in the docs otherwise it's a bit of a gotcha.

+label: docsite_pr
2018-08-22 14:07:24 -05:00
muxator
a34d8a5e47 doc: minor language corrections to loop docs ()
"described more" -> "better described"
"more simple" -> "simpler"

+label: docsite_pr
2018-08-22 15:00:25 -04:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects () 2018-08-13 14:54:14 -05:00
Toshio Kuratomi
c4951cce0b Exorcise Python-2.6 2018-08-13 07:38:38 -07:00
Matt Martz
c1c229c6d4
Remove use of simplejson throughout code base ()
* Remove use of simplejson throughout code base. Fixes 

* Address failing tests

* Remove simplejson from contrib and other outlying files

* Add changelog fragment for simplejson removal
2018-08-10 11:13:29 -05: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
c809500c79 document rescue vars () 2018-07-30 13:05:16 -05:00
Fabian von Feilitzsch
d27de6acd9 Add from_yaml_all to support multi document yaml strings ()
* Support multi-doc yaml in the from_yaml filter

* Most automatic method of handling multidoc

* Only use safe_load_all

* Implement separate filter

* Update plugin docs and changelog
2018-07-25 16:12:22 -04:00
Chris Smolen
1e2b332001 Update the regex_findall example ()
<!--- Your description here -->
The example has:
`{{ 'Some DNS servers are 8.8.8.8 and 8.8.4.4' | regex_findall('\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b') }}`

It needs be double backslashes to escape the backslashes:
`{{ 'Some DNS servers are 8.8.8.8 and 8.8.4.4' | regex_findall('\\b(?:[0-9]{1,3}\\.){3}[0-9]{1,3}\\b') }}`
+label: docsite_pr
2018-07-19 19:02:49 -04:00
Brian Coca
18aa87803f remove dupe entries 2018-07-19 12:16:33 -04:00
Sergiu Marsavela
8d194fa5f7 Update Openstack dynamic inventory reference ()
* Update Openstack dynamic inventory link

* Add note for change of script name

* Change name of script to prevent Python module import errors.

Fixes 
2018-07-18 21:34:11 +05:30
Taranjeet Singh
58d6044251 Docs: Update sentence structure in user guide ()
This commit fixes the information about become keyword in
Introduction to Playbook part under User Guide.
2018-07-17 21:16:03 +05:30
Fran Fitzpatrick
5928ec04ca Adds an ipmath filter () 2018-07-11 10:52:31 -07:00
saidmu
52fe9aaf04 Update intro_inventory.rst
<!--- I think a colon is missing-->

+label: docsite_pr
2018-07-10 12:08:21 -04:00
Sam Doran
7b0dea45e9 Update JSON Query filter examples ()
* Update JSON Query filter examples

Correct syntax on one example
Add more examples of escaping
Change example to show joining list to string
2018-07-09 15:09:52 -04:00
Eugene Korekin
07adeff665 Fix typo ()
+label: docsite_pr
2018-07-07 15:04:05 -04:00
Alexandre Vicenzi
df2e0c7c00 Fix broken links. () 2018-07-04 18:54:49 -07:00
Alexandre Vicenzi
1dafd92c8e Fix Ansible Galaxy documentation link. ()
More info: https://github.com/ansible/galaxy/issues/830
2018-07-04 09:52:47 -07:00
Matt Martz
aea396f04b
Add items2dict filter that is the reverse of dict2items ()
* Add items2dict filter that is the reverse of dict2items

* Address feedback about type checking, and add docs for zip/zip_longest
2018-06-29 10:47:07 -05:00
Matt Martz
11ce954226
Fix docs for all test. Fixes () 2018-06-26 14:53:58 -05:00
Troy Murray
15ce7c5bab change OS X to macOS ()
* change OS X to macOS

<!--- Your description here -->

+label: docsite_pr

* Update all Mac OS X references to be macOS

* Drop extra Mac
2018-06-26 14:09:23 -04:00
Jordan Borean
2af36412f9
runas + async - get working on older hosts ()
* runas + async - get working on older hosts

* fixed up sanity issues

* Moved first task to end of test for CI race issues

* Minor change to async test to be more stable, change to runas become to not touch the disk

* moved async test back to normal spot
2018-06-26 14:40:49 +10:00
Jordan Borean
0b2ec9b11c
windows dsc docs: fix missing colon in example () 2018-06-25 11:38:08 +10:00
Olivier Bourdon
06b73ff8f1 Add random_mac string filter ()
Add new filter to generate random MAC addresses from
string prefix. See docs/docsite/rst/user_guide/playbooks_filters.rst
for more detailed infos.
2018-06-21 15:56:54 -05:00