Skip to content
Snippets Groups Projects
Commit bfd13f96 authored by Simone Spinelli's avatar Simone Spinelli
Browse files

Move to a collection structure

parent bc724a29
No related branches found
No related tags found
1 merge request!12Converting to collection
Pipeline #84142 failed
Showing
with 158 additions and 12 deletions
# geant-gap-ansible
Here we store ansible roles and playbooks to be used with Forkflow Orchestrator.
The intention is to transform this in a proper Ansible Collection.
File deleted
[defaults]
host_key_checking=false
display_skipped_hosts = false
#stdout_callback = actionable
# Ansible Collection - geant.gap_ansible
Documentation for the collection.
### 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: geant
# The name of the collection. Has the same character restrictions as 'namespace'
name: gap_ansible
# 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 <email> (url)
# @nicks:irc/im.site#channel'
authors:
- GEANT GOAT Team <goat@geant.org>
### OPTIONAL but strongly recommended
# A short summary description of the collection
description: A collection of Ansible roles and playbooks to configure Juniper and Nokia routers
# 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: [networking]
# 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: https://gitlab.software.geant.org/goat/gap/geant-gap-ansible
# The URL to any online docs
documentation: https://docs.gap.geant.org
# The URL to the homepage of the collection/project
homepage: https://gitlab.software.geant.org/goat/gap/geant-gap-ansible
# The URL to the collection issue tracker
issues: https://gitlab.software.geant.org/goat/gap/geant-gap-ansible
# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
# and '.git' are always filtered. Mutually exclusive with 'manifest'
build_ignore: []
# A dict controlling use of manifest directives used in building the collection artifact. The key 'directives' is a
# list of MANIFEST.in style
# L(directives,https://packaging.python.org/en/latest/guides/using-manifest-in/#manifest-in-commands). The key
# 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive
# with 'build_ignore'
# manifest: null
---
# Collections must specify a minimum required ansible version to upload
# to galaxy
requires_ansible: '>=2.9.10'
# Content that Ansible needs to load from another location or that has
# been deprecated/removed
# plugin_routing:
# action:
# redirected_plugin_name:
# redirect: ns.col.new_location
# deprecated_plugin_name:
# deprecation:
# removal_version: "4.0.0"
# warning_text: |
# See the porting guide on how to update your playbook to
# use ns.col.another_plugin instead.
# removed_plugin_name:
# tombstone:
# removal_version: "2.0.0"
# warning_text: |
# See the porting guide on how to update your playbook to
# use ns.col.another_plugin instead.
# become:
# cache:
# callback:
# cliconf:
# connection:
# doc_fragments:
# filter:
# httpapi:
# inventory:
# lookup:
# module_utils:
# modules:
# netconf:
# shell:
# strategy:
# terminal:
# test:
# vars:
# Python import statements that Ansible needs to load from another location
# import_redirection:
# ansible_collections.ns.col.plugins.module_utils.old_location:
# redirect: ansible_collections.ns.col.plugins.module_utils.new_location
# Groups of actions/modules that take a common set of options
# action_groups:
# group_name:
# - module1
# - module2
...@@ -4,4 +4,4 @@ ...@@ -4,4 +4,4 @@
remote_user: admin remote_user: admin
roles: roles:
- Juniper.junos - Juniper.junos
- roles/base_config - ../roles/base_config
...@@ -4,4 +4,4 @@ ...@@ -4,4 +4,4 @@
gather_facts: false gather_facts: false
roles: roles:
- Juniper.junos - Juniper.junos
- roles/iptrunk - ../roles/iptrunk
...@@ -4,4 +4,4 @@ ...@@ -4,4 +4,4 @@
gather_facts: false gather_facts: false
roles: roles:
- Juniper.junos - Juniper.junos
- roles/iptrunk_checks - ../roles/iptrunk_checks
...@@ -4,4 +4,4 @@ ...@@ -4,4 +4,4 @@
gather_facts: false gather_facts: false
roles: roles:
- Juniper.junos - Juniper.junos
- roles/iptrunk_migration - ../roles/iptrunk_migration
# 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-core/2.15/plugins/plugins.html).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment