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

Limiting plugin types 2 #150

Merged
merged 5 commits into from Jan 27, 2021
Merged

Limiting plugin types 2 #150

merged 5 commits into from Jan 27, 2021

Conversation

abadger
Copy link
Contributor

@abadger abadger commented Jan 22, 2021

SUMMARY

Polished policy for limiting plugin types.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@abadger
Copy link
Contributor Author

abadger commented Jan 22, 2021

To be added to the agenda once the purpose of the other alternate plugin directories are added.

@gundalow gundalow added this to Proposals and Discussions in Ansible Community project plan Jan 22, 2021
abadger and others added 2 commits January 27, 2021 12:27
Co-authored-by: Felix Fontein <felix@fontein.de>
* The following collections have a temporary exception to use the ``plugin_utils``, ``cli_parsers``, ``fact_diff``, and ``validate`` directories for additional plugins during the 2.10 and 3 release cycles. We will figure out a final policy which these collections will need to comply with before ansible-4:
:Those recognized by ansible-core: ``doc_fragments``, ``modules``, ``module_utils``, ``terminal``, and those listed on https://docs.ansible.com/ansible/devel/plugins/plugins.html This list can be verified by looking at the last element of the package argument of each ``*_loader`` in https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/loader.py#L1126
:plugin_utils: For shared code which is only used controller-side, not in modules.
:sub_plugins: For other plugins which are managed by plugins inside of collections instead of ansible-core. We use a subfolder so there aren't conflicts when ansible-core adds new plugin types.
Copy link
Contributor

Choose a reason for hiding this comment

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

If we think of modules as a kind of plugin, this wording suggested by @mattclay is better:

Suggested change
:sub_plugins: For other plugins which are managed by plugins inside of collections instead of ansible-core. We use a subfolder so there aren't conflicts when ansible-core adds new plugin types.
:sub_plugins: For other plugins which are managed by non-module plugins inside of collections instead of ansible-core. We use a subfolder so there aren't conflicts when ansible-core adds new plugin types.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We'll do this as a separate PR.

@abadger
Copy link
Contributor Author

abadger commented Jan 27, 2021

This was approved at today's meeting.

@abadger abadger merged commit 6c609ae into main Jan 27, 2021
Ansible Community project plan automation moved this from Proposals and Discussions to Done Jan 27, 2021
@abadger abadger deleted the limiting-plugin-types2 branch January 27, 2021 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants