From b4d96f4720d2d87f329e1370affbd2e6469c2aa1 Mon Sep 17 00:00:00 2001 From: Yanick Champoux Date: Wed, 30 Mar 2022 15:28:46 -0400 Subject: [PATCH] create collection --- yanick/misc/README.md | 3 ++ yanick/misc/galaxy.yml | 57 +++++++++++++++++++++++++++++++++++ yanick/misc/plugins/README.md | 31 +++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 100644 yanick/misc/README.md create mode 100644 yanick/misc/galaxy.yml create mode 100644 yanick/misc/plugins/README.md diff --git a/yanick/misc/README.md b/yanick/misc/README.md new file mode 100644 index 0000000..a38cf9a --- /dev/null +++ b/yanick/misc/README.md @@ -0,0 +1,3 @@ +# Ansible Collection - yanick.misc + +Documentation for the collection. \ No newline at end of file diff --git a/yanick/misc/galaxy.yml b/yanick/misc/galaxy.yml new file mode 100644 index 0000000..1f52225 --- /dev/null +++ b/yanick/misc/galaxy.yml @@ -0,0 +1,57 @@ +### REQUIRED + +# The namespace of the collection. This can be a company/brand/organization or product namespace under which all +# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with +# underscores or numbers and cannot contain consecutive underscores +namespace: yanick + +# The name of the collection. Has the same character restrictions as 'namespace' +name: misc + +# The version of the collection. Must be compatible with semantic versioning +version: 1.0.0 + +# The path to the Markdown (.md) readme file. This path is relative to the root of the collection +readme: README.md + +# A list of the collection's content authors. Can be just the name or in the format 'Full Name (url) +# @nicks:irc/im.site#channel' +authors: +- your name + + +### OPTIONAL but strongly recommended + +# A short summary description of the collection +description: your collection description + +# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only +# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' +license: +- GPL-2.0-or-later + +# The path to the license file for the collection. This path is relative to the root of the collection. This key is +# mutually exclusive with 'license' +license_file: '' + +# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character +# requirements as 'namespace' and 'name' +tags: [] + +# Collections that this collection requires to be installed for it to be usable. The key of the dict is the +# collection label 'namespace.name'. The value is a version range +# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version +# range specifiers can be set and are separated by ',' +dependencies: {} + +# The URL of the originating SCM repository +repository: http://example.com/repository + +# The URL to any online docs +documentation: http://docs.example.com + +# The URL to the homepage of the collection/project +homepage: http://example.com + +# The URL to the collection issue tracker +issues: http://example.com/issue/tracker diff --git a/yanick/misc/plugins/README.md b/yanick/misc/plugins/README.md new file mode 100644 index 0000000..6541cf7 --- /dev/null +++ b/yanick/misc/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.9/plugins/plugins.html). \ No newline at end of file