Ansible-Sammlung für Nextcloud-Verwaltung

Dieses Repository enthält die nextcloud.admin Ansible-Sammlung (ehemals die Rolle aalaesar.install_nextcloud).

Die Sammlung umfasst eine Vielzahl von Ansible-Inhalten, um die Verwaltung von Nextcloud zu automatisieren sowie die Bereitstellung und Wartung von Nextcloud-Instanzen zu unterstützen.

Ansible-Version-Kompatibilität

Diese Sammlung wurde mit folgenden Ansible-Versionen getestet: >=2.14.0.

Plugins und Module innerhalb einer Sammlung können nur mit bestimmten Ansible-Versionen getestet werden.

Python-Unterstützung

• Sammlung getestet mit 3.11+

Unterstützte Nextcloud-Versionen

Diese Sammlung unterstützt Nextcloud-Versionen: 25, 26, 27 (neueste)

Enthaltene Inhalte

Module

Rollen

Installation und Verwendung

Abhängigkeiten

netaddr Python-Bibliothek

Inhalte in dieser Sammlung benötigen die Netzwerkadressmanipulationsbibliothek zur Manipulation von Netzwerkadressen. Sie können sie mit folgendem Befehl installieren:

    pip3 install netaddr

erforderliche eigenständige Rollen

Standardmäßig sind einige Rollen in dieser Sammlung von eigenständigen Rollen aus anderen Namensräumen abhängig (dies kann deaktiviert werden).

Aufgrund einiger Einschränkungen installiert ansible-galaxy diese nicht automatisch, sie müssen danach installiert werden.

Sobald die Sammlung installiert ist, führen Sie den Befehl ansible-galaxy role install -r <dieser_sammlungsordner>/requirements.yml aus.

Alternativ können Sie auch den Inhalt dieser Datei (requirements.yml) in Ihre eigene requirements.yml-Datei einfügen, bevor Sie die Sammlung installieren.

Installation der Sammlung von Ansible Galaxy

Bevor Sie die Nextcloud-Sammlung verwenden, müssen Sie sie mit dem Ansible Galaxy-CLI installieren:

ansible-galaxy collection install nextcloud.admin

Sie können sie auch in eine requirements.yml-Datei einfügen und über ansible-galaxy collection install -r requirements.yml installieren, im folgenden Format:

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

Verwendung von Modulen aus der Nextcloud-Sammlung in Ihren Playbooks

Es ist empfehlenswert, Inhalte in dieser Sammlung unter Verwendung ihres vollqualifizierten Sammlungsnamens (FQCN) zu verwenden, beispielsweise nextcloud.admin.run_occ:

---
- hosts: nextcloud_host
  gather_facts: false
  become: true
  tasks:
    - name: installierte Apps auflisten
      nextcloud.admin.run_occ:
        nextcloud_path: /var/www/nextcloud
        command: app:list

Wenn Sie ältere Playbooks von <2.0.0 aktualisieren, können Sie Ihre Änderungen minimieren, indem Sie collections in Ihrem Play definieren und auf die Rolle dieser Sammlung als install_nextcloud verweisen, anstatt nextcloud.admin.install_nextcloud, wie in diesem Beispiel:

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

  collections:
    - nextcloud.admin

  tasks:
    - name: nextcloud und Abhängigkeiten bereitstellen
      include_role:
        name: install_nextcloud
        # zuvor:
        # name: aalaesar.install_nextcloud

Für Dokumentation zur Verwendung:

• einzelner Module: Bitte verwenden Sie den ansible-doc-Befehl nach der Installation dieser Sammlung.
• eingeschlossene Rollen: Nach den Ansible-Standards sind die Ansible-Rollen in ihrer eigenen README-Datei dokumentiert.

Testen und Entwicklung

Wenn Sie neue Inhalte für diese Sammlung entwickeln oder das bereits Vorhandene verbessern möchten, ist es am einfachsten, die Sammlung in einen der konfigurierten COLLECTIONS_PATHS zu klonen und dort daran zu arbeiten.

Testen mit molecule

Das Verzeichnis tests enthält Playbooks zum Ausführen von Integrationstests in verschiedenen Szenarien. Es gibt auch Integrationstests im Verzeichnis molecule.

Veröffentlichung neuer Versionen

Release werden automatisch erstellt und an Ansible Galaxy gepusht, wenn ein neuer Tag festgelegt wird.

Lizenz

BSD

Siehe LICENCE für den vollständigen Text.