Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some documentation about plugins in collections #62465

Merged
merged 4 commits into from
Sep 26, 2019

Conversation

s-hertel
Copy link
Contributor

@s-hertel s-hertel commented Sep 17, 2019

SUMMARY

Fixes #62231

Add some documentation about things that require FQCN, limitations on inventory caching, and code sharing.

Vars plugin documentation is in #61078. Vars plugins in collections are ignored prior to #61078.

ISSUE TYPE
  • Docs Pull Request

@ansibot
Copy link
Contributor

ansibot commented Sep 17, 2019

@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. has_issue needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Sep 17, 2019
@@ -43,7 +50,7 @@ A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directo
Enabling Inventory Cache Plugins
--------------------------------

Inventory may be cached using a file-based cache plugin (like jsonfile). Check the specific inventory plugin to see if it supports caching.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have a ticket to enable using cache plugins from collections?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there is this #56469.

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Sep 18, 2019
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
@s-hertel s-hertel force-pushed the document_plugins_in_collections branch 2 times, most recently from ac86b23 to f5cf083 Compare September 20, 2019 14:07
s-hertel and others added 2 commits September 24, 2019 16:26
Co-Authored-By: Sandra McCann <samccann@redhat.com>
@s-hertel s-hertel force-pushed the document_plugins_in_collections branch from d8e534d to ae4a384 Compare September 24, 2019 20:35
@samccann samccann merged commit d41050b into ansible:devel Sep 26, 2019
acozine pushed a commit to acozine/ansible that referenced this pull request Oct 8, 2019
* Add some documentation about using plugins in collections

- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching

(cherry picked from commit d41050b)
@acozine acozine mentioned this pull request Oct 8, 2019
acozine added a commit that referenced this pull request Oct 9, 2019
* add more anchors to collections docs (#62827)

(cherry picked from commit 7e01de9)

* add anchors to support galaxy links (#62808)

(cherry picked from commit 1b3bf33)

* doc: fix typos (#62852)

(cherry picked from commit b33ae14)

* Add some documentation about using plugins in collections (#62465)
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching

(cherry picked from commit d41050b)

* Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words

(cherry picked from commit e7436e2)

* ovirt: Fixing typo in ovirt_disk examples (#62962)

(cherry picked from commit 50dc41c)

* vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)

Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a.

(cherry picked from commit 7ecfa4a)

* Prefer https:// links in the docs site (#62939)

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://.

(cherry picked from commit c8315bf)

* fix minor typos (#62950)

(cherry picked from commit ad580a7)

* Modernize Vagrant documentation (#62923)
* By requiring a slightly newer Vagrant version (from 2015) we get the
  same generated Ansible inventory format is still used by today's
  version of Vagrant. That extended inventory format also has the
  benefit of allowing for simpler Ansible examples.
* Switching to a current and supported Ubuntu LTS version.

(cherry picked from commit 0d79013)

* add ios/iosxr deprecated modules (#62908)

(cherry picked from commit 6bbd9c9)
@ansible ansible locked and limited conversation to collaborators Oct 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. has_issue support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclear how to use inventory plugins in collections
4 participants