Commit graph

29 commits

Author SHA1 Message Date
azrdev
6487a239c0
developing_inventory sample code: fix undefined var "results" if get_option(cache)=False ()
if user_cache_setting == False, then the previous code didn't parse the inventory source
2020-12-16 10:51:58 -05:00
Sayee
ecd3b52ad7
Writing style updates to Developing dynamic inventory topic ()
* modified the writing style

* incorporated peer feedback
2020-08-17 14:16:19 -05:00
Rick Elrod
7f62a9d7b5
Make cache adjudicator's flush call plugin flush ()
Change:
- Previously CachePluginAdjudicator#flush only removed entries from the
  cache backend that it knew about by using them earlier. Now it calls
  the underlying plugin's flush() method.

Test Plan:
- New unit tests

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 17:16:15 -05:00
Stef B
fb3db170cc
Make Sources, Plugins sections easier to read ()
Re-wrote the Inventory Sources section and also the next section to have shorter, clearer sentences with a more active voice.
2020-07-20 13:30:06 -05:00
Glandos
7a26aff357 Fix cache example () 2019-11-08 16:16:45 -05:00
Sloane Hertel
d41050b28b Add some documentation about plugins in collections ()
* Add some documentation about using plugins in collections

- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
2019-09-26 12:00:26 -04:00
Jiri Tyr
31d6d7ada5 Updating developing_inventory.rst () 2019-08-15 14:41:37 -05:00
Alicia Cozine
3fc0694ffc removes last :doc: links in the dev guide () 2019-06-26 14:59:33 -04:00
ximon18
7474e39c37 Rewrote one awkward sentence. ()
Rewrote awkward sentence in the developing inventory guide.

+label: docsite_pr
2019-04-05 14:25:50 -05:00
Sloane Hertel
9687879840
Fix inventory cache interface ()
* Replace InventoryFileCacheModule with a better developer-interface

Use new interface for inventory plugins with backwards compatibility

Auto-update the backing cache-plugin if the cache has changed after parsing the inventory plugin

* Update CacheModules to use the config system and add a deprecation warning if they are being imported directly rather than using cache_loader

* Fix foreman inventory caching

* Add tests

* Add integration test to check that fact caching works normally with cache plugins using ansible.constants and inventory caching provides a helpful error for non-compatible cache plugins

* Add some developer documentation for inventory and cache plugins

* Add user documentation for inventory caching

* Add deprecation docs

* Apply suggestions from docs review

* Add changelog
2019-03-06 12:12:35 -06:00
Chris Gavin
43042682e8 Fix an incorrect function call in a documentation example. () 2019-03-04 07:27:24 -06:00
Divided by Zer0
1f06b3ca7d ungrouped as a list ()
* update the developing_inventory docs to show ungrouped as a dict with a "children" key; avoid 
[WARNING]: Found both group and host with same name: ungrouped
2019-02-22 14:57:35 -06:00
Richard Diphoorn
ad549e375a Changed 'Control Machine' to 'Control Node' ()
* Changed 'Control Machine' to 'Control Node' in the documentation. Changing the term 'Control Machine' to 'Control Node', to be in line with the basic concepts here: https://docs.ansible.com/ansible/latest/network/getting_started/basic_concepts.html

Also for both entities; Control/Managed using the same common denominator 'Node' brings consistency.

* Updated reference links to new term.
2019-02-08 13:40:09 -06:00
branen
88029a73d6 Correct docsite typos: it's -> its () 2019-01-11 15:49:54 -05:00
Karolis Kalantojus
b5162c7a47 Documentation fix for developing own plugin ()
Seems like `self` is not necessary in the call args

+label: docsite_pr
2019-01-08 16:38:29 -05:00
Phuurl
29c96d20fb Corrects minor typos in the documentation ()
Signed-off-by: Phuurl <chubble.10@icloud.com>
2018-12-07 16:54:32 -06:00
Sloane Hertel
f3d5ebb355 add more consistent extension matching for inventory plugins ()
* Add consistent extension matching for inventory plugins that support YAML configuration files

* Document extension matching expectations
2018-10-11 11:06:52 -05:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 ()
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects () 2018-08-13 14:54:14 -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
475abc0af7
inventory plugin docs ()
* inventory plugin docs
* added set options
* minor wording and formatting fixes
* changed headers to std as per , also added to main readme
* unified inventory plugin devel, referenced from generic plugin dev
* fixed typos and update as per feedback
2018-07-05 17:30:46 -04:00
Rémy Léone
d639d5dc96 Fix typo ()
Typo
+label: docsite_pr
2018-04-13 14:15:26 -04: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
Joshua Smith
0c012703c1 Update developing inventory script docs. ()
* Update developing inventory script docs.

* Copy edit.
2018-02-02 02:03:17 -08:00
Matt Martz
89c3151167 Give example of empty _meta in dyanmic inventory () 2017-06-15 09:51:34 -05:00
Adam Johnson
f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" ()
Thanks @adamchainz!
2017-04-20 09:36:16 -07:00
Robin Schneider
3700bcb6dd Use HTTPS instead of legacy HTTP for ansible.com ()
Mechanical edit done by this "one-liner":

```Shell
git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#http://(www\.|galaxy\.|)ansible\.com#https://\1ansible.com#g;'
```

Related to: https://github.com/ansible/ansible/issues/16869
2017-02-15 16:09:33 -08:00
John R Barker
7df31aaca1 Fix all RST errors for docs/docsite/rst ()
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
2017-01-07 11:38:52 -08:00
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00
Renamed from docsite/rst/dev_guide/developing_inventory.rst (Browse further)