Collection Ansible pour l'administration de Nextcloud

Ce dépôt héberge la collection Ansible nextcloud.admin (anciennement le rôle aalaesar.install_nextcloud).

La collection comprend divers contenus Ansible pour aider à automatiser la gestion de Nextcloud, ainsi que le déploiement et l'entretien des instances de Nextcloud.

Compatibilité des versions d'Ansible

Cette collection a été testée avec les versions d'Ansible suivantes : >=2.14.0.

Les plugins et modules d'une collection peuvent être testés uniquement avec des versions spécifiques d'Ansible.

Support Python

• Collection testée sur 3.11+

Versions de Nextcloud prises en charge

Cette collection prend en charge les versions de Nextcloud : 25, 26, 27 (dernière)

Contenu inclus

Modules

Rôles

Installation et utilisation

Dépendances

Bibliothèque Python netaddr

Le contenu de cette collection nécessite la bibliothèque de manipulation d'adresses réseau pour manipuler les adresses réseau. Vous pouvez l'installer avec :

    pip3 install netaddr

Rôles autonomes requis

Par défaut, certains rôles de cette collection dépendent de rôles autonomes d'autres espaces de noms (ceci peut être désactivé).

En raison de certaines limitations, ansible-galaxy ne les installe pas automatiquement, ils doivent être installés ensuite.

Une fois la collection installée, exécutez la commande ansible-galaxy role install -r <ce_dossier_de_collection>/requirements.yml.

Alternativement, vous pouvez également ajouter le contenu de ce fichier dans votre propre fichier requirements.yml avant d'installer la collection.

Installation de la collection depuis Ansible Galaxy

Avant d'utiliser la collection Nextcloud, vous devez l'installer avec la CLI Ansible Galaxy :

ansible-galaxy collection install nextcloud.admin

Vous pouvez également l'inclure dans un fichier requirements.yml et l'installer via ansible-galaxy collection install -r requirements.yml, en utilisant le format :

---
collections:
  - name: nextcloud.admin
    version: 2.0.0

Utilisation des modules de la collection Nextcloud dans vos playbooks

Il est préférable d'utiliser le contenu de cette collection en utilisant leur Nom de Namespace de Collection Qualifié (FQCN), par exemple nextcloud.admin.run_occ :

---
- hosts: nextcloud_host
  gather_facts: false
  become: true
  tasks:
    - name: lister les applications installées
      nextcloud.admin.run_occ:
        nextcloud_path: /var/www/nextcloud
        command: app:list

Si vous mettez à jour d'anciens playbooks de <2.0.0, vous pouvez minimiser vos changements en définissant collections dans votre play et en faisant référence à ce rôle de collection comme install_nextcloud, au lieu de nextcloud.admin.install_nextcloud, comme dans cet exemple :

---
- hosts: localhost
  gather_facts: false
  connection: local

  collections:
    - nextcloud.admin

  tasks:
    - name: déployer nextcloud et dépendances
      include_role:
        name: install_nextcloud
        # auparavant :
        # name: aalaesar.install_nextcloud

Pour la documentation sur la façon de l'utiliser :

• modules individuels : veuillez utiliser la commande ansible-doc après avoir installé cette collection.
• rôles inclus : selon la norme ansible, les rôles ansible sont documentés dans leur propre fichier README.

Tests et développement

Si vous souhaitez développer du nouveau contenu pour cette collection ou améliorer ce qui est déjà là, le moyen le plus simple de travailler sur la collection est de la cloner dans l'un des COLLECTIONS_PATHS configurés et d’y travailler là.

Test avec molecule

Le répertoire tests contient des playbooks pour exécuter des tests d'intégration sur divers scénarios. Il y a également des tests d'intégration dans le répertoire molecule.

Publication de nouvelles versions

Les versions sont automatiquement construites et envoyées à Ansible Galaxy pour tout nouveau tag.

Licence

BSD

Voir le document LICENCE pour lire le texte complet.