aboutsummaryrefslogtreecommitdiff
path: root/plugins/README.md
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2021-09-01 04:11:37 +0200
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2021-09-01 04:11:37 +0200
commita024ad57e94976f7541bdd352e2d0a364c2aa5fb (patch)
treeb04a92bdb939f6ecba135c0feb5d82fd148838e8 /plugins/README.md
downloadansible_collection-a024ad57e94976f7541bdd352e2d0a364c2aa5fb.tar.gz
initial
Diffstat (limited to 'plugins/README.md')
-rw-r--r--plugins/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/plugins/README.md b/plugins/README.md
new file mode 100644
index 0000000..67044d2
--- /dev/null
+++ b/plugins/README.md
@@ -0,0 +1,31 @@
+# Collections Plugins Directory
+
+This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
+is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
+would contain module utils and modules respectively.
+
+Here is an example directory of the majority of plugins currently supported by Ansible:
+
+```
+└── plugins
+ ├── action
+ ├── become
+ ├── cache
+ ├── callback
+ ├── cliconf
+ ├── connection
+ ├── filter
+ ├── httpapi
+ ├── inventory
+ ├── lookup
+ ├── module_utils
+ ├── modules
+ ├── netconf
+ ├── shell
+ ├── strategy
+ ├── terminal
+ ├── test
+ └── vars
+```
+
+A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible/2.11/plugins/plugins.html).