Skip to content

Commit c6890c5

Browse files
committed
feat: add collection project files
0 parents  commit c6890c5

24 files changed

+1799
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Ansible Collection - stackhpc.kayobe_automation_workflows
2+
3+
Documentation for the collection.

galaxy.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
### REQUIRED
2+
# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
3+
# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
4+
# underscores or numbers and cannot contain consecutive underscores
5+
namespace: stackhpc
6+
7+
# The name of the collection. Has the same character restrictions as 'namespace'
8+
name: kayobe_automation_workflows
9+
10+
# The version of the collection. Must be compatible with semantic versioning
11+
version: 0.1.0
12+
13+
# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
14+
readme: README.md
15+
16+
# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
17+
# @nicks:irc/im.site#channel'
18+
authors:
19+
- Jack Hodgkiss <jack@stackhpc.com>
20+
21+
22+
### OPTIONAL but strongly recommended
23+
# A short summary description of the collection
24+
description: Ansible collection for templating the creation of kayobe workflows.
25+
26+
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
27+
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
28+
license:
29+
- Apache-2.0
30+
31+
# The path to the license file for the collection. This path is relative to the root of the collection. This key is
32+
# mutually exclusive with 'license'
33+
# license_file: ''
34+
35+
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
36+
# requirements as 'namespace' and 'name'
37+
tags:
38+
- OpenStack
39+
- Kayobe
40+
- Continuous Integration
41+
- Continuous Deployment
42+
43+
# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
44+
# collection label 'namespace.name'. The value is a version range
45+
# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
46+
# range specifiers can be set and are separated by ','
47+
dependencies: {}
48+
49+
# The URL of the originating SCM repository
50+
repository: https://github.com/jackhodgkiss/kayobe-automation-workflows
51+
52+
# The URL to any online docs
53+
# documentation: http://docs.example.com
54+
55+
# The URL to the homepage of the collection/project
56+
# homepage: http://example.com
57+
58+
# The URL to the collection issue tracker
59+
# issues: http://example.com/issue/tracker
60+
61+
# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
62+
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
63+
# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
64+
# and '.git' are always filtered. Mutually exclusive with 'manifest'
65+
build_ignore: []
66+
67+
# A dict controlling use of manifest directives used in building the collection artifact. The key 'directives' is a
68+
# list of MANIFEST.in style
69+
# L(directives,https://packaging.python.org/en/latest/guides/using-manifest-in/#manifest-in-commands). The key
70+
# 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive
71+
# with 'build_ignore'
72+
# manifest: null
73+

meta/runtime.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
# Collections must specify a minimum required ansible version to upload
3+
# to galaxy
4+
requires_ansible: '>=2.9.10'
5+
6+
# Content that Ansible needs to load from another location or that has
7+
# been deprecated/removed
8+
# plugin_routing:
9+
# action:
10+
# redirected_plugin_name:
11+
# redirect: ns.col.new_location
12+
# deprecated_plugin_name:
13+
# deprecation:
14+
# removal_version: "4.0.0"
15+
# warning_text: |
16+
# See the porting guide on how to update your playbook to
17+
# use ns.col.another_plugin instead.
18+
# removed_plugin_name:
19+
# tombstone:
20+
# removal_version: "2.0.0"
21+
# warning_text: |
22+
# See the porting guide on how to update your playbook to
23+
# use ns.col.another_plugin instead.
24+
# become:
25+
# cache:
26+
# callback:
27+
# cliconf:
28+
# connection:
29+
# doc_fragments:
30+
# filter:
31+
# httpapi:
32+
# inventory:
33+
# lookup:
34+
# module_utils:
35+
# modules:
36+
# netconf:
37+
# shell:
38+
# strategy:
39+
# terminal:
40+
# test:
41+
# vars:
42+
43+
# Python import statements that Ansible needs to load from another location
44+
# import_redirection:
45+
# ansible_collections.ns.col.plugins.module_utils.old_location:
46+
# redirect: ansible_collections.ns.col.plugins.module_utils.new_location
47+
48+
# Groups of actions/modules that take a common set of options
49+
# action_groups:
50+
# group_name:
51+
# - module1
52+
# - module2

plugins/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Collections Plugins Directory
2+
3+
This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
4+
is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
5+
would contain module utils and modules respectively.
6+
7+
Here is an example directory of the majority of plugins currently supported by Ansible:
8+
9+
```
10+
└── plugins
11+
├── action
12+
├── become
13+
├── cache
14+
├── callback
15+
├── cliconf
16+
├── connection
17+
├── filter
18+
├── httpapi
19+
├── inventory
20+
├── lookup
21+
├── module_utils
22+
├── modules
23+
├── netconf
24+
├── shell
25+
├── strategy
26+
├── terminal
27+
├── test
28+
└── vars
29+
```
30+
31+
A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.14/plugins/plugins.html).

0 commit comments

Comments
 (0)