dany/ansible-practice
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add examples on collection

Browse Source
This commit is contained in:
Dany LE
2025-04-11 08:51:42 +00:00
parent 5fd628a7d8
commit 453233a25b
28 changed files with 675 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
projet00/collections/ansible_collections/coll/test/FILES.json Normal file
View File

@ -0,0 +1,180 @@
{
"files": [
{
"name": ".",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "README.md",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "640672357ec8ca5ba4e67f8de236c87108f81ddb3858984c390063d5cd3e2bf4",
"format": 1
},
{
"name": "docs",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "meta",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "meta/runtime.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "7b1d88aa041500f5b4a36c20a58adf116fbb48af9b5aa3be93949bd12cdae9dd",
"format": 1
},
{
"name": "plugins",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "plugins/README.md",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "c8e91383ed2e19a696e2c055fbbd1cf526bc54d4fe590619ee0896b21bf0183e",
"format": 1
},
{
"name": "roles",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/README.md",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "cc751d75266f757a38189f15d54e548dc87706f14a39756995c27b49eaca8a07",
"format": 1
},
{
"name": "roles/rtest/defaults",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/defaults/main.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "8f1b5dce81acc854a65e685ff7c6a1b920b16bcd84bc9c9376cefeae0cd1137c",
"format": 1
},
{
"name": "roles/rtest/files",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/handlers",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/handlers/main.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "d270c5e267dd5351356c7584b313b3a1a1b0a9b2ccbb2922c023f3e109ed8318",
"format": 1
},
{
"name": "roles/rtest/meta",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/meta/main.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "e82c60136cb1895d61432dd52c83d4c6e8ad4c654a697ac2d5b5e4a288866d87",
"format": 1
},
{
"name": "roles/rtest/tasks",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/tasks/main.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "51412a4a5172fd9f77ea1085df686bbc36a7df3c4e29e1f8f2fa695d75d3e791",
"format": 1
},
{
"name": "roles/rtest/templates",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/tests",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/tests/inventory",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "e02233819b1a09844410549191813f7cc7ba360f21298578f4ba1727a27d87fc",
"format": 1
},
{
"name": "roles/rtest/tests/test.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "991098aa83b74e8d42001d607b86635c8016c8b61765d51c6c37de06236cff07",
"format": 1
},
{
"name": "roles/rtest/vars",
"ftype": "dir",
"chksum_type": null,
"chksum_sha256": null,
"format": 1
},
{
"name": "roles/rtest/vars/main.yml",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "49f6326c8dc231c54c7ecd2cf756ed0e65601d1bfe41dd2efc4e2cb8ffb5fa98",
"format": 1
}
],
"format": 1
}

30
projet00/collections/ansible_collections/coll/test/MANIFEST.json Normal file
View File

@ -0,0 +1,30 @@
{
"collection_info": {
"namespace": "coll",
"name": "test",
"version": "1.0.0",
"authors": [
"your name <example@domain.com>"
],
"readme": "README.md",
"tags": [],
"description": "your collection description",
"license": [
"GPL-2.0-or-later"
],
"license_file": null,
"dependencies": {},
"repository": "http://example.com/repository",
"documentation": "http://docs.example.com",
"homepage": "http://example.com",
"issues": "http://example.com/issue/tracker"
},
"file_manifest_file": {
"name": "FILES.json",
"ftype": "file",
"chksum_type": "sha256",
"chksum_sha256": "e740d05896265d200bcf1f8aed0ab5b627c66ae84825f905bc151d9ae761592e",
"format": 1
},
"format": 1
}

3
projet00/collections/ansible_collections/coll/test/README.md Normal file
View File

@ -0,0 +1,3 @@
# Ansible Collection - coll.test
Documentation for the collection.

52
projet00/collections/ansible_collections/coll/test/meta/runtime.yml Normal file
View File

@ -0,0 +1,52 @@
---
# 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

31
projet00/collections/ansible_collections/coll/test/plugins/README.md Normal file
View File

@ -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-core/2.15/plugins/plugins.html).

38
projet00/collections/ansible_collections/coll/test/roles/rtest/README.md Normal file
View File

@ -0,0 +1,38 @@
Role Name
=========
A brief description of the role goes here.
Requirements
------------
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
Role Variables
--------------
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
Dependencies
------------
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
Example Playbook
----------------
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
License
-------
BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).

2
projet00/collections/ansible_collections/coll/test/roles/rtest/defaults/main.yml Normal file
View File

@ -0,0 +1,2 @@
---
# defaults file for rtest

2
projet00/collections/ansible_collections/coll/test/roles/rtest/handlers/main.yml Normal file
View File

@ -0,0 +1,2 @@
---
# handlers file for rtest

52
projet00/collections/ansible_collections/coll/test/roles/rtest/meta/main.yml Normal file
View File

@ -0,0 +1,52 @@
galaxy_info:
author: your name
description: your role description
company: your company (optional)
# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
# issue_tracker_url: http://example.com/issue/tracker
# Choose a valid license ID from https://spdx.org - some suggested licenses:
# - BSD-3-Clause (default)
# - MIT
# - GPL-2.0-or-later
# - GPL-3.0-only
# - Apache-2.0
# - CC-BY-4.0
license: license (GPL-2.0-or-later, MIT, etc)
min_ansible_version: 2.1
# If this a Container Enabled role, provide the minimum Ansible Container version.
# min_ansible_container_version:
#
# Provide a list of supported platforms, and for each platform a list of versions.
# If you don't wish to enumerate all versions for a particular platform, use 'all'.
# To view available platforms and versions (or releases), visit:
# https://galaxy.ansible.com/api/v1/platforms/
#
# platforms:
# - name: Fedora
# versions:
# - all
# - 25
# - name: SomePlatform
# versions:
# - all
# - 1.0
# - 7
# - 99.99
galaxy_tags: []
# List tags for your role here, one per line. A tag is a keyword that describes
# and categorizes the role. Users find roles by searching for tags. Be sure to
# remove the '[]' above, if you add tags to this list.
#
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.

5
projet00/collections/ansible_collections/coll/test/roles/rtest/tasks/main.yml Normal file
View File

@ -0,0 +1,5 @@
---
# tasks file for rtest
- name: Debug test
ansible.builtin.debug:
msg: "Un role test !!!"

2
projet00/collections/ansible_collections/coll/test/roles/rtest/tests/inventory Normal file
View File

@ -0,0 +1,2 @@
localhost

5
projet00/collections/ansible_collections/coll/test/roles/rtest/tests/test.yml Normal file
View File

@ -0,0 +1,5 @@
---
- hosts: localhost
remote_user: root
roles:
- rtest

2
projet00/collections/ansible_collections/coll/test/roles/rtest/vars/main.yml Normal file
View File

@ -0,0 +1,2 @@
---
# vars file for rtest

7
projet00/site.yml Normal file
View File

@ -0,0 +1,7 @@
---
- name: test collection import
hosts: localhost
gather_facts: false
tasks:
- ansible.builtin.import_role:
name: coll.test.rtest