From 25bfd1275d05b514d231a5625c706db74ebb64a7 Mon Sep 17 00:00:00 2001
From: Thomas Schneider <thomas@fsmpi.rwth-aachen.de>
Date: Thu, 30 Jan 2025 16:09:21 +0100
Subject: [PATCH] Migrate to ansible-galaxy structure and add required metadata
---
README.md | 3 +
galaxy.yml | 72 +++++++++++++++++++
meta/runtime.yml | 52 ++++++++++++++
.../request-tracker}/defaults/main.yml | 0
.../request-tracker}/handlers/main.yml | 0
.../request-tracker}/tasks/main.yml | 0
.../request-tracker}/tasks/postgres.yml | 0
.../RT_SiteConfig.d/40-timezone.pm.j2 | 0
.../RT_SiteConfig.d/50-debconf.pm.j2 | 0
.../RT_SiteConfig.d/60-logging.pm.j2 | 0
.../templates/RT_SiteConfig.d/70-ldap.pm.j2 | 0
.../RT_SiteConfig.d/80-externalstorage.pm.j2 | 0
.../templates/RT_SiteConfig.pm.j2 | 0
.../templates/dbconfig.conf.j2 | 0
.../request-tracker}/templates/fcgi-env.j2 | 0
roles/request-tracker5/README.md | 38 ++++++++++
.../request-tracker5}/defaults/main.yml | 0
.../request-tracker5}/files/crontab | 0
.../request-tracker5}/handlers/main.yml | 0
roles/request-tracker5/meta/main.yml | 19 +++++
.../request-tracker5}/tasks/main.yml | 0
.../request-tracker5}/templates/50-debconf.pm | 0
.../request-tracker5}/templates/90-ansible.pm | 0
.../templates/request-tracker5.service | 0
roles/request-tracker5/tests/inventory | 2 +
roles/request-tracker5/tests/test.yml | 5 ++
26 files changed, 191 insertions(+)
create mode 100644 README.md
create mode 100644 galaxy.yml
create mode 100644 meta/runtime.yml
rename {request-tracker => roles/request-tracker}/defaults/main.yml (100%)
rename {request-tracker => roles/request-tracker}/handlers/main.yml (100%)
rename {request-tracker => roles/request-tracker}/tasks/main.yml (100%)
rename {request-tracker => roles/request-tracker}/tasks/postgres.yml (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.d/40-timezone.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.d/50-debconf.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.d/60-logging.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.d/70-ldap.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.d/80-externalstorage.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/RT_SiteConfig.pm.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/dbconfig.conf.j2 (100%)
rename {request-tracker => roles/request-tracker}/templates/fcgi-env.j2 (100%)
create mode 100644 roles/request-tracker5/README.md
rename {request-tracker5 => roles/request-tracker5}/defaults/main.yml (100%)
rename {request-tracker5 => roles/request-tracker5}/files/crontab (100%)
rename {request-tracker5 => roles/request-tracker5}/handlers/main.yml (100%)
create mode 100644 roles/request-tracker5/meta/main.yml
rename {request-tracker5 => roles/request-tracker5}/tasks/main.yml (100%)
rename {request-tracker5 => roles/request-tracker5}/templates/50-debconf.pm (100%)
rename {request-tracker5 => roles/request-tracker5}/templates/90-ansible.pm (100%)
rename {request-tracker5 => roles/request-tracker5}/templates/request-tracker5.service (100%)
create mode 100644 roles/request-tracker5/tests/inventory
create mode 100644 roles/request-tracker5/tests/test.yml
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..768dfc5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+# Ansible Collection - fsmpi.rt
+
+Documentation for the collection.
diff --git a/galaxy.yml b/galaxy.yml
new file mode 100644
index 0000000..890c246
--- /dev/null
+++ b/galaxy.yml
@@ -0,0 +1,72 @@
+---
+### 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: fsmpi
+
+# The name of the collection. Has the same character restrictions as 'namespace'
+name: rt
+
+# 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:
+ - Amandus Rauin <amandus@fsmpi.rwth-aachen.de>
+ - Hinrikus Wolf <hinrikus@fsmpi.rwth-aachen.de>
+ - Lars Beckers <larsb@fsmpi.rwth-aachen.de>
+ - Robin Sonnabend <robin@fsmpi.rwth-aachen.de>
+ - Thomas Schneider <thomas@fsmpi.rwth-aachen.de>
+
+### OPTIONAL but strongly recommended
+# A short summary description of the collection
+description: Roles for Request Tracker
+
+# 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-3.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: https://git.fsmpi.rwth-aachen.de/infra/ansible-shared/ansible-rt
+
+# The URL to any online docs
+#documentation: http://docs.example.com
+
+# The URL to the homepage of the collection/project
+homepage: https://git.fsmpi.rwth-aachen.de/infra/ansible-shared
+
+# The URL to the collection issue tracker
+issues: https://git.fsmpi.rwth-aachen.de/infra/ansible-shared/ansible-rt/-/issues
+
+# 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
diff --git a/meta/runtime.yml b/meta/runtime.yml
new file mode 100644
index 0000000..e0fc0bc
--- /dev/null
+++ b/meta/runtime.yml
@@ -0,0 +1,52 @@
+---
+# Collections must specify a minimum required ansible version to upload
+# to galaxy
+requires_ansible: '>=2.16'
+
+# 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
diff --git a/request-tracker/defaults/main.yml b/roles/request-tracker/defaults/main.yml
similarity index 100%
rename from request-tracker/defaults/main.yml
rename to roles/request-tracker/defaults/main.yml
diff --git a/request-tracker/handlers/main.yml b/roles/request-tracker/handlers/main.yml
similarity index 100%
rename from request-tracker/handlers/main.yml
rename to roles/request-tracker/handlers/main.yml
diff --git a/request-tracker/tasks/main.yml b/roles/request-tracker/tasks/main.yml
similarity index 100%
rename from request-tracker/tasks/main.yml
rename to roles/request-tracker/tasks/main.yml
diff --git a/request-tracker/tasks/postgres.yml b/roles/request-tracker/tasks/postgres.yml
similarity index 100%
rename from request-tracker/tasks/postgres.yml
rename to roles/request-tracker/tasks/postgres.yml
diff --git a/request-tracker/templates/RT_SiteConfig.d/40-timezone.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.d/40-timezone.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.d/40-timezone.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.d/40-timezone.pm.j2
diff --git a/request-tracker/templates/RT_SiteConfig.d/50-debconf.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.d/50-debconf.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.d/50-debconf.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.d/50-debconf.pm.j2
diff --git a/request-tracker/templates/RT_SiteConfig.d/60-logging.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.d/60-logging.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.d/60-logging.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.d/60-logging.pm.j2
diff --git a/request-tracker/templates/RT_SiteConfig.d/70-ldap.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.d/70-ldap.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.d/70-ldap.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.d/70-ldap.pm.j2
diff --git a/request-tracker/templates/RT_SiteConfig.d/80-externalstorage.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.d/80-externalstorage.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.d/80-externalstorage.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.d/80-externalstorage.pm.j2
diff --git a/request-tracker/templates/RT_SiteConfig.pm.j2 b/roles/request-tracker/templates/RT_SiteConfig.pm.j2
similarity index 100%
rename from request-tracker/templates/RT_SiteConfig.pm.j2
rename to roles/request-tracker/templates/RT_SiteConfig.pm.j2
diff --git a/request-tracker/templates/dbconfig.conf.j2 b/roles/request-tracker/templates/dbconfig.conf.j2
similarity index 100%
rename from request-tracker/templates/dbconfig.conf.j2
rename to roles/request-tracker/templates/dbconfig.conf.j2
diff --git a/request-tracker/templates/fcgi-env.j2 b/roles/request-tracker/templates/fcgi-env.j2
similarity index 100%
rename from request-tracker/templates/fcgi-env.j2
rename to roles/request-tracker/templates/fcgi-env.j2
diff --git a/roles/request-tracker5/README.md b/roles/request-tracker5/README.md
new file mode 100644
index 0000000..225dd44
--- /dev/null
+++ b/roles/request-tracker5/README.md
@@ -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).
diff --git a/request-tracker5/defaults/main.yml b/roles/request-tracker5/defaults/main.yml
similarity index 100%
rename from request-tracker5/defaults/main.yml
rename to roles/request-tracker5/defaults/main.yml
diff --git a/request-tracker5/files/crontab b/roles/request-tracker5/files/crontab
similarity index 100%
rename from request-tracker5/files/crontab
rename to roles/request-tracker5/files/crontab
diff --git a/request-tracker5/handlers/main.yml b/roles/request-tracker5/handlers/main.yml
similarity index 100%
rename from request-tracker5/handlers/main.yml
rename to roles/request-tracker5/handlers/main.yml
diff --git a/roles/request-tracker5/meta/main.yml b/roles/request-tracker5/meta/main.yml
new file mode 100644
index 0000000..e931cb3
--- /dev/null
+++ b/roles/request-tracker5/meta/main.yml
@@ -0,0 +1,19 @@
+---
+galaxy_info:
+ author: Thomas Schneider
+ description: Install Request Tracker 5
+ company: FSMPI RWTH
+ issue_tracker_url: https://git.fsmpi.rwth-aachen.de/infra/ansible-shared/ansible-rt/-/issues
+ license: GPL-3.0-or-later
+
+ min_ansible_version: "2.16"
+
+ platforms:
+ - name: Debian
+ versions:
+ - 12
+
+ galaxy_tags: []
+
+dependencies:
+ - fsmpi.webservices.caddy
diff --git a/request-tracker5/tasks/main.yml b/roles/request-tracker5/tasks/main.yml
similarity index 100%
rename from request-tracker5/tasks/main.yml
rename to roles/request-tracker5/tasks/main.yml
diff --git a/request-tracker5/templates/50-debconf.pm b/roles/request-tracker5/templates/50-debconf.pm
similarity index 100%
rename from request-tracker5/templates/50-debconf.pm
rename to roles/request-tracker5/templates/50-debconf.pm
diff --git a/request-tracker5/templates/90-ansible.pm b/roles/request-tracker5/templates/90-ansible.pm
similarity index 100%
rename from request-tracker5/templates/90-ansible.pm
rename to roles/request-tracker5/templates/90-ansible.pm
diff --git a/request-tracker5/templates/request-tracker5.service b/roles/request-tracker5/templates/request-tracker5.service
similarity index 100%
rename from request-tracker5/templates/request-tracker5.service
rename to roles/request-tracker5/templates/request-tracker5.service
diff --git a/roles/request-tracker5/tests/inventory b/roles/request-tracker5/tests/inventory
new file mode 100644
index 0000000..878877b
--- /dev/null
+++ b/roles/request-tracker5/tests/inventory
@@ -0,0 +1,2 @@
+localhost
+
diff --git a/roles/request-tracker5/tests/test.yml b/roles/request-tracker5/tests/test.yml
new file mode 100644
index 0000000..d152301
--- /dev/null
+++ b/roles/request-tracker5/tests/test.yml
@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+ remote_user: root
+ roles:
+ - request-tracker5
--
GitLab